/sources/catalogues2.php

Description
Description | Functions
Functions
Description | Functions
actual_add_catalogue (line 147)

Add a catalogue using all the specified values.

  • return: The ID of the first new catalogues root category (NULL: no root, as it's not a tree catalogue)
?AUTO_LINK actual_add_catalogue (ID_TEXT $name, mixed $title, mixed $description, SHORT_INTEGER $display_type, BINARY $is_tree, LONG_TEXT $notes, integer $submit_points, [BINARY $ecommerce = 0], [ID_TEXT $send_view_reports = 'never'])
  • ID_TEXT $name: The codename of the catalogue
  • mixed $title: The title of the catalogue (either language code or string)
  • mixed $description: A description (either language code or string)
  • SHORT_INTEGER $display_type: The display type
  • BINARY $is_tree: Whether the catalogue uses a tree system (as opposed to mere categories in an index)
  • LONG_TEXT $notes: Hidden notes pertaining to this catalogue
  • integer $submit_points: How many points a member gets by submitting to this catalogue
  • BINARY $ecommerce: Whether the catalogue is an eCommerce catalogue
  • ID_TEXT $send_view_reports: How to send view reports
actual_add_catalogue_category (line 468)

Add a catalogue category

  • return: The ID of the new category
AUTO_LINK actual_add_catalogue_category (ID_TEXT $catalogue_name, mixed $title, mixed $description, LONG_TEXT $notes, ?AUTO_LINK $parent_id, [URLPATH $rep_image = ''], [integer $move_days_lower = 30], [integer $move_days_higher = 60], [?AUTO_LINK $move_target = NULL], [?TIME $add_date = NULL], [?AUTO_LINK $id = NULL])
  • ID_TEXT $catalogue_name: The codename of the catalogue the category is in
  • mixed $title: The title of this category (either language code or string)
  • mixed $description: A description (either language code or string)
  • LONG_TEXT $notes: Hidden notes pertaining to this category
  • ?AUTO_LINK $parent_id: The ID of this categories parent (NULL: a root category, or not a tree catalogue)
  • URLPATH $rep_image: The representative image for the category (blank: none)
  • integer $move_days_lower: The number of days before expiry (lower limit)
  • integer $move_days_higher: The number of days before expiry (higher limit)
  • ?AUTO_LINK $move_target: The expiry category (NULL: do not expire)
  • ?TIME $add_date: The add time (NULL: now)
  • ?AUTO_LINK $id: Force an ID (NULL: don't force an ID)
actual_add_catalogue_entry (line 631)

Adds an entry to the specified catalogue.

  • return: The ID of the newly added entry
AUTO_LINK actual_add_catalogue_entry (AUTO_LINK $category_id, BINARY $validated, LONG_TEXT $notes, BINARY $allow_rating, SHORT_INTEGER $allow_comments, BINARY $allow_trackbacks, array $map, [?TIME $time = NULL], [?MEMBER $submitter = NULL], [?TIME $edit_date = NULL], [integer $views = 0], [?AUTO_LINK $id = NULL])
  • AUTO_LINK $category_id: The ID of the category that the entry is in
  • BINARY $validated: Whether the entry has been validated
  • LONG_TEXT $notes: Hidden notes pertaining to the entry
  • BINARY $allow_rating: Whether the entry may be rated
  • SHORT_INTEGER $allow_comments: Whether comments are allowed (0=no, 1=yes, 2=review style)
  • BINARY $allow_trackbacks: Whether the entry may be trackbacked
  • array $map: A map of field IDs, to values, that defines the entries settings
  • ?TIME $time: The time the entry was added (NULL: now)
  • ?MEMBER $submitter: The entries submitter (NULL: current user)
  • ?TIME $edit_date: The edit time (NULL: never)
  • integer $views: The number of views
  • ?AUTO_LINK $id: Force an ID (NULL: don't force an ID)
actual_add_catalogue_field (line 189)

Add a field to the specified catalogue, without disturbing any other data in that catalogue.

void actual_add_catalogue_field (ID_TEXT $c_name, mixed $name, mixed $description, ID_TEXT $type, integer $order, BINARY $defines_order, BINARY $visible, BINARY $searchable, LONG_TEXT $default, BINARY $required, [BINARY $put_in_category = 1], [BINARY $put_in_search = 1])
  • ID_TEXT $c_name: The codename of the catalogue the field is for
  • mixed $name: The name of the field (either language code or string)
  • mixed $description: A description (either language code or string)
  • ID_TEXT $type: The type of the field
  • integer $order: The field order (the field order determines what order the fields are displayed within an entry)
  • BINARY $defines_order: Whether this field defines the catalogue order
  • BINARY $visible: Whether this is a visible field
  • BINARY $searchable: Whether the field is usable as a search key
  • LONG_TEXT $default: The default value for the field
  • BINARY $required: Whether this field is required
  • BINARY $put_in_category: Whether the field is to be shown in category views (not applicable for the list display type)
  • BINARY $put_in_search: Whether the field is to be shown in search views (not applicable for the list display type)
actual_delete_catalogue (line 349)

Delete a catalogue.

void actual_delete_catalogue (ID_TEXT $name)
  • ID_TEXT $name: The name of the catalogue
actual_delete_catalogue_category (line 544)

Delete a catalogue category.

void actual_delete_catalogue_category (AUTO_LINK $id, [boolean $deleting_all = false])
  • AUTO_LINK $id: The ID of the category
  • boolean $deleting_all: Whether we're deleting everything under the category; if FALSE we will actively reassign child categories to be directly under the root
actual_delete_catalogue_entry (line 776)

Delete a catalogue entry.

void actual_delete_catalogue_entry (AUTO_LINK $id)
  • AUTO_LINK $id: The ID of the entry to delete
actual_delete_catalogue_field (line 438)

Delete a catalogue field.

void actual_delete_catalogue_field (AUTO_LINK $id)
  • AUTO_LINK $id: The ID of the field
actual_edit_catalogue (line 303)

Edit a catalogue.

void actual_edit_catalogue (ID_TEXT $old_name, ID_TEXT $name, SHORT_TEXT $title, LONG_TEXT $description, SHORT_INTEGER $display_type, LONG_TEXT $notes, integer $submit_points, BINARY $ecommerce, ID_TEXT $send_view_reports)
  • ID_TEXT $old_name: The current name of the catalogue
  • ID_TEXT $name: The new name of the catalogue
  • SHORT_TEXT $title: The human readable name/title of the catalogue
  • LONG_TEXT $description: The description
  • SHORT_INTEGER $display_type: The display type
  • LONG_TEXT $notes: Admin notes
  • integer $submit_points: How many points are given to a member that submits to the catalogue
  • BINARY $ecommerce: Whether the catalogue is an eCommerce catalogue
  • ID_TEXT $send_view_reports: How to send view reports
actual_edit_catalogue_category (line 500)

Edit a catalogue category.

void actual_edit_catalogue_category (AUTO_LINK $id, SHORT_TEXT $title, LONG_TEXT $description, LONG_TEXT $notes, ?AUTO_LINK $parent_id, SHORT_TEXT $meta_keywords, LONG_TEXT $meta_description, URLPATH $rep_image, integer $move_days_lower, integer $move_days_higher, ?AUTO_LINK $move_target)
  • AUTO_LINK $id: The ID of the category
  • SHORT_TEXT $title: The title of the category
  • LONG_TEXT $description: Description for the category
  • LONG_TEXT $notes: Admin notes
  • ?AUTO_LINK $parent_id: The ID of the parent category (NULL: no parent)
  • SHORT_TEXT $meta_keywords: Meta keywords for the category
  • LONG_TEXT $meta_description: Meta description for the category
  • URLPATH $rep_image: The representative image for the category (blank: none)
  • integer $move_days_lower: The number of days before expiry (lower limit)
  • integer $move_days_higher: The number of days before expiry (higher limit)
  • ?AUTO_LINK $move_target: The expiry category (NULL: do not expire)
actual_edit_catalogue_entry (line 705)

Edit the specified catalogue entry

void actual_edit_catalogue_entry (AUTO_LINK $id, AUTO_LINK $category_id, BINARY $validated, LONG_TEXT $notes, BINARY $allow_rating, SHORT_INTEGER $allow_comments, BINARY $allow_trackbacks, array $map, ?SHORT_TEXT $meta_keywords, ?LONG_TEXT $meta_description)
  • AUTO_LINK $id: The ID of the entry being edited
  • AUTO_LINK $category_id: The ID of the category that the entry is in
  • BINARY $validated: Whether the entry has been validated
  • LONG_TEXT $notes: Hidden notes pertaining to the entry
  • BINARY $allow_rating: Whether the entry may be rated
  • SHORT_INTEGER $allow_comments: Whether comments are allowed (0=no, 1=yes, 2=review style)
  • BINARY $allow_trackbacks: Whether the entry may be trackbacked
  • array $map: A map of field IDs, to values, that defines the entries settings
  • ?SHORT_TEXT $meta_keywords: Meta keywords for this resource (NULL: do not edit)
  • ?LONG_TEXT $meta_description: Meta description for this resource (NULL: do not edit)
actual_edit_catalogue_field (line 416)

Edit a catalogue field.

void actual_edit_catalogue_field (AUTO_LINK $id, ID_TEXT $c_name, SHORT_TEXT $name, LONG_TEXT $description, integer $order, BINARY $defines_order, BINARY $visible, BINARY $searchable, LONG_TEXT $default, BINARY $required, [BINARY $put_in_category = 1], [BINARY $put_in_search = 1], [?ID_TEXT $type = NULL])
  • AUTO_LINK $id: The ID of the field
  • ID_TEXT $c_name: The name of the catalogue
  • SHORT_TEXT $name: The name of the field
  • LONG_TEXT $description: Description for the field
  • integer $order: The field order (the field order determines what order the fields are displayed within an entry)
  • BINARY $defines_order: Whether the field defines entry ordering
  • BINARY $visible: Whether the field is visible when an entry is viewed
  • BINARY $searchable: Whether the field is usable as a search key
  • LONG_TEXT $default: The default value for the field
  • BINARY $required: Whether the field is required
  • BINARY $put_in_category: Whether the field is to be shown in category views (not applicable for the list display type)
  • BINARY $put_in_search: Whether the field is to be shown in search views (not applicable for the list display type)
  • ?ID_TEXT $type: The field type (NULL: do not change)
catalogue_file_script (line 47)

Farm out the files for catalogue entry fields.

void catalogue_file_script ()
catalogue_from_tree (line 38)

Converts a non-tree catalogue from a tree catalogue.

void catalogue_from_tree (ID_TEXT $catalogue_name)
  • ID_TEXT $catalogue_name: Catalogue name
catalogue_to_tree (line 26)

Converts a non-tree catalogue to a tree catalogue.

void catalogue_to_tree (ID_TEXT $catalogue_name)
  • ID_TEXT $catalogue_name: Catalogue name
get_field_auto_increment (line 239)

Get a fresh value for an auto_increment valued field.

  • return: The value
string get_field_auto_increment (AUTO_LINK $field_id, [string $default = ''])
  • AUTO_LINK $field_id: The field ID
  • string $default: The field default
get_field_random (line 267)

Get a fresh value for a random valued field.

  • return: The value
string get_field_random (AUTO_LINK $field_id, [string $default = ''])
  • AUTO_LINK $field_id: The field ID
  • string $default: The field default

Documentation generated on Sun, 02 Jan 2011 23:10:18 +0000 by phpDocumentor 1.4.3