Class Module_cms_galleries

Description
Description | Vars (details) | Methods (details)

Module page class.

  • copyright: ocProducts Ltd

Located in /cms/pages/modules/cms_galleries.php (line 26) 

standard_aed_module
   |
   --Module_cms_galleries
Variable Summary
Description | Vars (details) | Methods (details)
mixed $award_type
mixed $donext_type
mixed $javascript
mixed $lang_type
mixed $menu_label
mixed $permissions_cat_name
mixed $permissions_cat_require
mixed $permissions_require
mixed $select_name
mixed $seo_type
mixed $upload
mixed $user_facing
Method Summary
Description | Vars (details) | Methods (details)
ID_TEXT add_actualisation ()
?integer check_images_allowed (ID_TEXT $cat, [boolean $tolerate_non_exist = false])
void delete_actualisation (ID_TEXT $_id)
tempcode do_next_manager (tempcode $title, tempcode $description, ?AUTO_LINK $id)
void edit_actualisation (ID_TEXT $_id)
array fill_in_edit_form (ID_TEXT $_id)
mixed get_cat (AUTO_LINK $id)
?array get_entry_points ()
array get_form_fields ([ID_TEXT $cat = ''], [LONG_TEXT $comments = ''], [URLPATH $url = ''], [URLPATH $thumb_url = ''], [BINARY $validated = 1], [BINARY $allow_rating = 1], [SHORT_INTEGER $allow_comments = 1], [BINARY $allow_trackbacks = 1], [LONG_TEXT $notes = ''], [boolean $adding = true])
array get_sp_overrides ()
array get_submitter (AUTO_LINK $id)
tempcode gimp ()
void handle_resizing_and_watermarking ()
boolean has_at_least_one_watermark ([?ID_TEXT $cat = NULL])
tempcode misc ()
tempcode nice_get_ajax_tree ()
tempcode run_start (ID_TEXT $type)
tempcode sa ()
tempcode sd ()
void simple_add (URLPATH $url, URLPATH $thumb_url, string $file, ID_TEXT $cat)
string simple_find_comments (URLPATH $url, string $file)
tempcode ss ()
void store_from_archive (string $file, string &$in, ID_TEXT $cat)
tempcode _gimp ()
tempcode __gimp ()
Variables
Description | Vars (details) | Methods (details)
mixed $award_type = 'image' (line 36)
Redefinition of:
standard_aed_module::$award_type
mixed $donext_type = NULL (line 40)
mixed $javascript = 'standardAlternateFields(\'file\',\'url\'); standardAlternateFields(\'file2\',\'thumb_url\');' (line 37)
Redefinition of:
standard_aed_module::$javascript
mixed $lang_type = 'IMAGE' (line 28)
mixed $menu_label = 'GALLERIES' (line 38)
Redefinition of:
standard_aed_module::$menu_label
mixed $permissions_cat_name = 'cat' (line 32)
Redefinition of:
standard_aed_module::$permissions_cat_name
mixed $permissions_cat_require = 'galleries' (line 31)
Redefinition of:
standard_aed_module::$permissions_cat_require
mixed $permissions_require = 'mid' (line 30)
Redefinition of:
standard_aed_module::$permissions_require
mixed $select_name = 'IMAGE' (line 29)
mixed $seo_type = 'image' (line 34)
Redefinition of:
standard_aed_module::$seo_type
mixed $upload = 'image' (line 35)
Redefinition of:
standard_aed_module::$upload
mixed $user_facing = true (line 33)
Redefinition of:
standard_aed_module::$user_facing

Inherited Variables

Inherited from standard_aed_module

standard_aed_module::$add_one_cat_label
 standard_aed_module::$add_one_label
 standard_aed_module::$add_submit_name
 standard_aed_module::$add_text
 standard_aed_module::$alt_aed_module
 standard_aed_module::$appended_actions_already
 standard_aed_module::$archive_entry_point
 standard_aed_module::$archive_label
 standard_aed_module::$array_key
 standard_aed_module::$author
 standard_aed_module::$care_please
 standard_aed_module::$catalogue
 standard_aed_module::$cat_aed_module
 standard_aed_module::$check_validation
 standard_aed_module::$code_require
 standard_aed_module::$default_type
 standard_aed_module::$do_next_description
 standard_aed_module::$do_next_editing_categories
 standard_aed_module::$do_preview
 standard_aed_module::$edit_one_cat_label
 standard_aed_module::$edit_one_label
 standard_aed_module::$edit_submit_name
 standard_aed_module::$edit_text
 standard_aed_module::$edit_this_cat_label
 standard_aed_module::$edit_this_label
 standard_aed_module::$extra_donext_categories
 standard_aed_module::$extra_donext_entries
 standard_aed_module::$extra_donext_whatever
 standard_aed_module::$extra_donext_whatever_title
 standard_aed_module::$javascript_require
 standard_aed_module::$module_type
 standard_aed_module::$new_id
 standard_aed_module::$non_integer_id
 standard_aed_module::$no_blank_ids
 standard_aed_module::$orderer
 standard_aed_module::$organisation
 standard_aed_module::$output_of_action_is_confirmation
 standard_aed_module::$permissions_cat_name_b
 standard_aed_module::$permissions_cat_require_b
 standard_aed_module::$permission_module
 standard_aed_module::$permission_page
 standard_aed_module::$possibly_some_kind_of_upload
 standard_aed_module::$posting_form_text
 standard_aed_module::$posting_form_text_parsed
 standard_aed_module::$posting_form_title
 standard_aed_module::$protect_first
 standard_aed_module::$redirect_type
 standard_aed_module::$second_stage_preview
 standard_aed_module::$select_name_description
 standard_aed_module::$send_validation_request
 standard_aed_module::$skip_validation
 standard_aed_module::$special_edit_frontend
 standard_aed_module::$table
 standard_aed_module::$table_prefix
 standard_aed_module::$title_is_multi_lang
 standard_aed_module::$type_code
 standard_aed_module::$view_entry_point
Methods
Description | Vars (details) Methods (details)
add_actualisation (line 932)

Standard aed_module add actualiser.

  • return: The ID of the entry added
ID_TEXT add_actualisation ()
check_images_allowed (line 764)

Kills ocPortal if someone is trying to add an image to a gallery that does not support images.

  • return: Number allowed remaining (NULL: no limit)
?integer check_images_allowed (ID_TEXT $cat, [boolean $tolerate_non_exist = false])
  • ID_TEXT $cat: The gallery
  • boolean $tolerate_non_exist: Whether to tolerate the non-existance of the gallery
delete_actualisation (line 1023)

Standard aed_module delete actualiser.

void delete_actualisation (ID_TEXT $_id)
  • ID_TEXT $_id: The entry being deleted
do_next_manager (line 1042)

The do-next manager for after content management.

  • return: The UI
tempcode do_next_manager (tempcode $title, tempcode $description, ?AUTO_LINK $id)
  • tempcode $title: The title (output of get_page_title)
  • tempcode $description: Some description to show, saying what happened
  • ?AUTO_LINK $id: The ID of whatever was just handled (NULL: N/A)
Redefinition of:
standard_aed_module::do_next_manager()
The do-next manager for after content management.
edit_actualisation (line 975)

Standard aed_module edit actualiser.

void edit_actualisation (ID_TEXT $_id)
  • ID_TEXT $_id: The entry being edited
fill_in_edit_form (line 900)

Standard aed_module edit form filler.

  • return: A tuple of lots of info
array fill_in_edit_form (ID_TEXT $_id)
  • ID_TEXT $_id: The entry being edited
get_cat (line 887)

Standard aed_module cat getter.

  • return: The cat
mixed get_cat (AUTO_LINK $id)
  • AUTO_LINK $id: The entry for which the cat is sought
get_entry_points (line 47)

Standard modular entry-point finder function.

  • return: A map of entry points (type-code=>language-code) (NULL: disabled).
?array get_entry_points ()
Redefinition of:
standard_aed_module::get_entry_points()
Standard modular entry-point finder function.
get_form_fields (line 823)

Get tempcode for an image adding/editing form.

  • return: A pair: the tempcode for the visible fields, and the tempcode for the hidden fields
array get_form_fields ([ID_TEXT $cat = ''], [LONG_TEXT $comments = ''], [URLPATH $url = ''], [URLPATH $thumb_url = ''], [BINARY $validated = 1], [BINARY $allow_rating = 1], [SHORT_INTEGER $allow_comments = 1], [BINARY $allow_trackbacks = 1], [LONG_TEXT $notes = ''], [boolean $adding = true])
  • ID_TEXT $cat: The gallery
  • LONG_TEXT $comments: The image description
  • URLPATH $url: URL to the image
  • URLPATH $thumb_url: URL to the image thumbnail
  • BINARY $validated: Image validation status
  • BINARY $allow_rating: Whether rating is allowed
  • SHORT_INTEGER $allow_comments: Whether comments are allowed (0=no, 1=yes, 2=review style)
  • BINARY $allow_trackbacks: Whether trackbacks are allowed
  • LONG_TEXT $notes: Notes for the image
  • boolean $adding: Whether this form will be used for adding a new image
get_sp_overrides (line 57)

Standard modular specific-permission-overide finder function.

  • return: A map of specific-permissions that are overridable; sp to 0 or 1. 0 means "not category overridable". 1 means "category overridable".
array get_sp_overrides ()
get_submitter (line 874)

Standard aed_module submitter getter.

  • return: The submitter, and the time of submission (null submission time implies no known submission time)
array get_submitter (AUTO_LINK $id)
  • AUTO_LINK $id: The entry for which the submitter is sought
gimp (line 153)

The UI to choose a gallery to import into.

  • return: The UI
tempcode gimp ()
handle_resizing_and_watermarking (line 742)

Filter any uploaded image such that it is watermarked.

void handle_resizing_and_watermarking ()
has_at_least_one_watermark (line 594)

See if a gallery has any watermarks to use, or all galleries.

  • return: Whether watermarks are available
boolean has_at_least_one_watermark ([?ID_TEXT $cat = NULL])
  • ?ID_TEXT $cat: The gallery (NULL: all the current user has access to)
misc (line 127)

The do-next manager for before content management.

  • return: The UI
tempcode misc ()
nice_get_ajax_tree (line 802)

Standard aed_module list function.

  • return: The tree field
tempcode nice_get_ajax_tree ()
run_start (line 69)

Standard aed_module run_start.

  • return: The output of the run
tempcode run_start (ID_TEXT $type)
  • ID_TEXT $type: The type of module execution
sa (line 550)

The actualiser to simple add an orphan file to a gallery.

  • return: The UI
tempcode sa ()
sd (line 714)

The actualiser to simple delete an orphan file.

  • return: The UI
tempcode sd ()
simple_add (line 621)

Take a file in the gallery uploads directory, and add it to a gallery.

void simple_add (URLPATH $url, URLPATH $thumb_url, string $file, ID_TEXT $cat)
  • URLPATH $url: The URL to the file
  • URLPATH $thumb_url: The thumb URL to the file
  • string $file: The filename
  • ID_TEXT $cat: The gallery to add to
simple_find_comments (line 670)

Look for comments for a media file been quickly imported.

  • return: Comments (or blank)
string simple_find_comments (URLPATH $url, string $file)
  • URLPATH $url: The URL to the file
  • string $file: The filename
ss (line 442)

The actualiser to simple add/delete orphaned files in a gallery.

  • return: The UI
tempcode ss ()
store_from_archive (line 506)

Take some data and write it to be a file in the gallery uploads directory, and add it to a gallery.

void store_from_archive (string $file, string &$in, ID_TEXT $cat)
  • string $file: The filename
  • string &$in: The data
  • ID_TEXT $cat: The gallery to add to
_gimp (line 188)

The UI to import into a gallery.

  • return: The UI
tempcode _gimp ()
__gimp (line 305)

The actualiser to import a zip/tar into a gallery.

  • return: The UI
tempcode __gimp ()

Inherited Methods

Inherited From standard_aed_module

standard_aed_module::ad()
standard_aed_module::choose_catalogue()
standard_aed_module::do_next_manager()
standard_aed_module::ed()
standard_aed_module::get_entry_points()
standard_aed_module::get_permission_fields()
standard_aed_module::handle_confirmations()
standard_aed_module::info()
standard_aed_module::nice_get_entries()
standard_aed_module::preview_intercept()
standard_aed_module::run()
standard_aed_module::set_permissions()
standard_aed_module::_ad()
standard_aed_module::_ed()
standard_aed_module::__ed()

Documentation generated on Sun, 02 Jan 2011 23:11:19 +0000 by phpDocumentor 1.4.3