add_gallery
add_image
add_video
can_submit_to_gallery
constrain_gallery_image_to_max_size
create_selection_list_gallery_content_tree
create_selection_list_gallery_tree
create_video_thumb
delete_gallery
delete_image
delete_video
download_gallery_script
edit_gallery
edit_image
edit_video
gallery_breadcrumbs
gallery_has_content
get_default_gallery_max
get_gallery_content_tree
get_gallery_tree
get_member_id_from_gallery_name
get_potential_gallery_title
get_recursive_gallery_details
get_video_details
make_member_gallery_if_needed
only_conventional_galleries
only_download_galleries
only_galleries_accepting_media
only_member_galleries_of_id
read_intel_endian_int
read_network_endian_int
render_gallery_box
render_image_box
render_video_box
show_gallery_video_media
show_video_details
store_transcoding_failure
store_transcoding_success
transcode_video
watermark_gallery_image
zencoder_receive_script
GETID3_HELPERAPPSDIR
add_gallery(\ID_TEXT $name, \SHORT_TEXT $fullname, \LONG_TEXT $description, \LONG_TEXT $notes, \ID_TEXT $parent_id, \BINARY $accept_images= 1
, \BINARY $accept_videos= 1
, \BINARY $is_member_synched= 0
, \BINARY $flow_mode_interface= 0
, \URLPATH $rep_image= ''
, \URLPATH $watermark_top_left= ''
, \URLPATH $watermark_top_right= ''
, \URLPATH $watermark_bottom_left= ''
, \URLPATH $watermark_bottom_right= ''
, \BINARY $allow_rating= 1
, \BINARY $allow_comments= 1
, boolean $skip_exists_check= false
, \?TIME $add_date= null
, \?MEMBER $g_owner= null
, \?SHORT_TEXT $meta_keywords= ''
, \?LONG_TEXT $meta_description= ''
, boolean $uniqify= false
) : \ID_TEXT
package | galleries |
---|
\ID_TEXT
The gallery codename
\SHORT_TEXT
The full human-readeable name of the gallery
\LONG_TEXT
The description of the gallery
\LONG_TEXT
Hidden notes associated with the gallery
\ID_TEXT
The parent gallery (blank: no parent)
\BINARY
Whether images may be put in this gallery
\BINARY
Whether videos may be put in this gallery
\BINARY
Whether the gallery serves as a container for automatically created member galleries
\BINARY
Whether the gallery uses the flow mode interface
\URLPATH
The representative image of the gallery (blank: none)
\URLPATH
Watermark (blank: none)
\URLPATH
Watermark (blank: none)
\URLPATH
Watermark (blank: none)
\URLPATH
Watermark (blank: none)
\BINARY
Whether rating are allowed
\BINARY
Whether comments are allowed
boolean
Whether to skip the check for whether the gallery exists (useful for importers)
\?TIME
The add time (null: now)
\?MEMBER
The gallery owner (null: nobody)
\?SHORT_TEXT
Meta keywords for this resource (null: do not edit) (blank: implicit)
\?LONG_TEXT
Meta description for this resource (null: do not edit) (blank: implicit)
boolean
Whether to force the name as unique, if there's a conflict
\ID_TEXT
The nameadd_image(\SHORT_TEXT $title, \ID_TEXT $cat, \LONG_TEXT $description, \URLPATH $url, \URLPATH $thumb_url, \BINARY $validated, \BINARY $allow_rating, \BINARY $allow_comments, \BINARY $allow_trackbacks, \LONG_TEXT $notes, \?MEMBER $submitter= null
, \?TIME $add_date= null
, \?TIME $edit_date= null
, integer $views= 0
, \?AUTO_LINK $id= null
, \?SHORT_TEXT $meta_keywords= ''
, \?LONG_TEXT $meta_description= ''
) : \AUTO_LINK
package | galleries |
---|
\SHORT_TEXT
Image title
\ID_TEXT
The gallery name
\LONG_TEXT
The image description
\URLPATH
The URL to the actual image
\URLPATH
The URL to the thumbnail of the actual image
\BINARY
Whether the image has been validated for display on the site
\BINARY
Whether the image may be rated
\BINARY
Whether the image may be commented upon
\BINARY
Whether the image may be trackbacked
\LONG_TEXT
Hidden notes associated with the image
\?MEMBER
The submitter (null: current member)
\?TIME
The time of adding (null: now)
\?TIME
The time of editing (null: never)
integer
The number of views
\?AUTO_LINK
Force an ID (null: don't force an ID)
\?SHORT_TEXT
Meta keywords for this resource (null: do not edit) (blank: implicit)
\?LONG_TEXT
Meta description for this resource (null: do not edit) (blank: implicit)
\AUTO_LINK
The ID of the new entryadd_video(\SHORT_TEXT $title, \ID_TEXT $cat, \LONG_TEXT $description, \URLPATH $url, \URLPATH $thumb_url, \BINARY $validated, \BINARY $allow_rating, \BINARY $allow_comments, \BINARY $allow_trackbacks, \LONG_TEXT $notes, integer $video_length, integer $video_width, integer $video_height, \?MEMBER $submitter= null
, \?TIME $add_date= null
, \?TIME $edit_date= null
, integer $views= 0
, \?AUTO_LINK $id= null
, \?SHORT_TEXT $meta_keywords= ''
, \?LONG_TEXT $meta_description= ''
) : \AUTO_LINK
package | galleries |
---|
\SHORT_TEXT
Video title
\ID_TEXT
The gallery name
\LONG_TEXT
The video description
\URLPATH
The URL to the actual video
\URLPATH
The URL to the thumbnail of the actual video
\BINARY
Whether the video has been validated for display on the site
\BINARY
Whether the video may be rated
\BINARY
Whether the video may be commented upon
\BINARY
Whether the video may be trackbacked
\LONG_TEXT
Hidden notes associated with the video
integer
The length of the video
integer
The width of the video
integer
The height of the video
\?MEMBER
The submitter (null: current member)
\?TIME
The time of adding (null: now)
\?TIME
The time of editing (null: never)
integer
The number of views
\?AUTO_LINK
Force an ID (null: don't force an ID)
\?SHORT_TEXT
Meta keywords for this resource (null: do not edit) (blank: implicit)
\?LONG_TEXT
Meta description for this resource (null: do not edit) (blank: implicit)
\AUTO_LINK
The ID of the new entrycan_submit_to_gallery(\ID_TEXT $name) : \~integer
package | galleries |
---|
\ID_TEXT
The gallery name
\~integer
The owner of the gallery (false: we aren't allowed to submit to it) (-2: not a member gallery)constrain_gallery_image_to_max_size(\PATH $file_path, string $filename, integer $box_width)
package | galleries |
---|
\PATH
The path to the image file
string
The original filename of the image
integer
The box width
create_selection_list_gallery_content_tree(\ID_TEXT $table, \?ID_TEXT $it= null
, \?AUTO_LINK $submitter= null
, boolean $use_compound_list= false
, boolean $editable_filter= false
) : \Tempcode
package | galleries |
---|---|
set | images videos |
\ID_TEXT
The table we are working with
\?ID_TEXT
The currently selected entry (null: none selected)
\?AUTO_LINK
Only show images/videos submitted by this member (null: no filter)
boolean
Whether to get a list of child galleries (not just direct ones, recursively), instead of just IDs
boolean
Whether to only show for what may be edited by the current member
\Tempcode
The list of entriescreate_selection_list_gallery_tree(\?ID_TEXT $it= null
, \?string $filter= null
, boolean $must_accept_images= false
, boolean $must_accept_videos= false
, boolean $purity= false
, boolean $use_compound_list= false
, \?MEMBER $member_id= null
, boolean $addable_filter= false
, boolean $editable_filter= false
, \?TIME $updated_since= null
) : \Tempcode
..)galleries.
package | galleries |
---|
\?ID_TEXT
The gallery to select by default (null: no specific default)
\?string
A function name to filter galleries with (null: no filter)
boolean
Whether displayed galleries must support images
boolean
Whether displayed galleries must support videos
boolean
Whether to NOT show member galleries that do not exist yet
boolean
Whether to get a list of child galleries (not just direct ones, recursively), instead of just IDs
\?MEMBER
Member we are filtering for (null: not needed)
boolean
Whether to only show for what may be added to by the current member
boolean
Whether to only show for what may be edited by the current member
\?TIME
Time from which content must be updated (null: no limit).
\Tempcode
The tree listcreate_video_thumb(\URLPATH $src_url, \?PATH $expected_output_path = null
) : \URLPATH
package | galleries |
---|
\URLPATH
Video to get thumbail from (must be local)
\?PATH
Where to save to (null: decide for ourselves)
\URLPATH
Thumbnail, only valid if expected_output_path was passed as NULL (blank: could not generate)delete_gallery(\ID_TEXT $name)
delete_image(\AUTO_LINK $id, boolean $delete_full = true
)
package | galleries |
---|
\AUTO_LINK
The ID of the image
boolean
Whether to delete the actual file also
delete_video(\AUTO_LINK $id, boolean $delete_full = true
)
package | galleries |
---|
\AUTO_LINK
The ID of the entry to delete
boolean
Whether to delete the actual video file from disk as well as the entry
download_gallery_script()
package | galleries |
---|
edit_gallery(\ID_TEXT $old_name, \ID_TEXT $name, \SHORT_TEXT $fullname, \LONG_TEXT $description, \LONG_TEXT $notes, \?ID_TEXT $parent_id= null
, \BINARY $accept_images= 1
, \BINARY $accept_videos= 1
, \BINARY $is_member_synched= 0
, \BINARY $flow_mode_interface= 0
, \URLPATH $rep_image= ''
, \URLPATH $watermark_top_left= ''
, \URLPATH $watermark_top_right= ''
, \URLPATH $watermark_bottom_left= ''
, \URLPATH $watermark_bottom_right= ''
, \?SHORT_TEXT $meta_keywords= null
, \?LONG_TEXT $meta_description= null
, \BINARY $allow_rating= 1
, \BINARY $allow_comments= 1
, \?MEMBER $g_owner= null
, \?TIME $add_time= null
, boolean $null_is_literal= false
, boolean $uniqify= false
) : \ID_TEXT
package | galleries |
---|
\ID_TEXT
The old gallery codename (in case we are renaming)
\ID_TEXT
The gallery codename (maybe the same as the old one)
\SHORT_TEXT
The full human-readeable name of the gallery
\LONG_TEXT
The description of the gallery
\LONG_TEXT
Hidden notes associated with the gallery
\?ID_TEXT
The parent gallery (null: no parent)
\BINARY
Whether images may be put in this gallery
\BINARY
Whether videos may be put in this gallery
\BINARY
Whether the gallery serves as a container for automatically created member galleries
\BINARY
Whether the gallery uses the flow mode interface
\URLPATH
The representative image of the gallery (blank: none)
\URLPATH
Watermark (blank: none)
\URLPATH
Watermark (blank: none)
\URLPATH
Watermark (blank: none)
\URLPATH
Watermark (blank: none)
\?SHORT_TEXT
Meta keywords for this resource (null: do not edit)
\?LONG_TEXT
Meta description for this resource (null: do not edit)
\BINARY
Whether rating are allowed
\BINARY
Whether comments are allowed
\?MEMBER
The gallery owner (null: nobody)
\?TIME
The add time (null: now)
boolean
Determines whether some NULLs passed mean 'use a default' or literally mean 'set to NULL'
boolean
Whether to force the name as unique, if there's a conflict
\ID_TEXT
The nameedit_image(\AUTO_LINK $id, \SHORT_TEXT $title, \ID_TEXT $cat, \LONG_TEXT $description, \URLPATH $url, \URLPATH $thumb_url, \BINARY $validated, \BINARY $allow_rating, \BINARY $allow_comments, \BINARY $allow_trackbacks, \LONG_TEXT $notes, \SHORT_TEXT $meta_keywords, \LONG_TEXT $meta_description, \?TIME $edit_time= null
, \?TIME $add_time= null
, \?integer $views= null
, \?MEMBER $submitter= null
, boolean $null_is_literal= false
)
package | galleries |
---|
\AUTO_LINK
The ID of the image to edit
\SHORT_TEXT
Image title
\ID_TEXT
The gallery name
\LONG_TEXT
The image description
\URLPATH
The URL to the actual image
\URLPATH
The URL to the thumbnail of the actual image
\BINARY
Whether the image has been validated for display on the site
\BINARY
Whether the image may be rated
\BINARY
Whether the image may be commented upon
\BINARY
Whether the image may be trackbacked
\LONG_TEXT
Hidden notes associated with the image
\SHORT_TEXT
Meta keywords
\LONG_TEXT
Meta description
\?TIME
Edit time (null: either means current time, or if $null_is_literal, means reset to to NULL)
\?TIME
Add time (null: do not change)
\?integer
Number of views (null: do not change)
\?MEMBER
Submitter (null: do not change)
boolean
Determines whether some NULLs passed mean 'use a default' or literally mean 'set to NULL'
edit_video(\AUTO_LINK $id, \SHORT_TEXT $title, \ID_TEXT $cat, \LONG_TEXT $description, \URLPATH $url, \URLPATH $thumb_url, \BINARY $validated, \BINARY $allow_rating, \BINARY $allow_comments, \BINARY $allow_trackbacks, \LONG_TEXT $notes, integer $video_length, integer $video_width, integer $video_height, \SHORT_TEXT $meta_keywords, \LONG_TEXT $meta_description, \?TIME $edit_time= null
, \?TIME $add_time= null
, \?integer $views= null
, \?MEMBER $submitter= null
, boolean $null_is_literal= false
)
package | galleries |
---|
\AUTO_LINK
The ID of the entry to edit
\SHORT_TEXT
Video title
\ID_TEXT
The gallery name
\LONG_TEXT
The video description
\URLPATH
The URL to the actual video
\URLPATH
The URL to the thumbnail of the actual video
\BINARY
Whether the video has been validated for display on the site
\BINARY
Whether the video may be rated
\BINARY
Whether the video may be commented upon
\BINARY
Whether the video may be trackbacked
\LONG_TEXT
Hidden notes associated with the video
integer
The length of the video
integer
The width of the video
integer
The height of the video
\SHORT_TEXT
Meta keywords
\LONG_TEXT
Meta description
\?TIME
Edit time (null: either means current time, or if $null_is_literal, means reset to to NULL)
\?TIME
Add time (null: do not change)
\?integer
Number of views (null: do not change)
\?MEMBER
Submitter (null: do not change)
boolean
Determines whether some NULLs passed mean 'use a default' or literally mean 'set to NULL'
gallery_has_content(\ID_TEXT $name) : boolean
get_default_gallery_max() : integer
get_gallery_content_tree(\ID_TEXT $table, \?AUTO_LINK $submitter= null
, \?ID_TEXT $gallery= null
, \?string $breadcrumbs= null
, \?ID_TEXT $title= null
, \?integer $levels= null
, boolean $use_compound_list= false
, boolean $editable_filter= false
) : array
package | galleries |
---|---|
set | images videos |
\ID_TEXT
The table we are working with
\?AUTO_LINK
Only show images/videos submitted by this member (null: no filter)
\?ID_TEXT
The gallery being at the root of our recursion (null: true root)
\?string
The breadcrumbs up to this point in the recursion (null: blank, as we are starting the recursion)
\?ID_TEXT
The name of the $gallery we are currently going through (null: look it up). This is here for efficiency reasons, as finding children IDs to recurse to also reveals the childs title
\?integer
The number of recursive levels to search (null: all)
boolean
Whether to get a list of child galleries (not just direct ones, recursively), instead of just IDs
boolean
Whether to only show for what may be edited by the current member
array
A list of maps for all galleries. Each map entry containins the fields 'id' (gallery ID) and 'breadcrumbs' (path to the category, including the categories own title), and more. Or if $use_compound_list, the tree structure built with pairs containing the compound list in addition to the child branchesget_gallery_tree(\?ID_TEXT $gallery= 'root'
, string $breadcrumbs= ''
, \?array $gallery_info= null
, boolean $do_stats= false
, \?string $filter= null
, boolean $must_accept_images= false
, boolean $must_accept_videos= false
, boolean $purity= false
, boolean $use_compound_list= false
, \?integer $levels= null
, \?MEMBER $member_id= null
, boolean $addable_filter= false
, boolean $editable_filter= false
) : array
..)galleries.
package | galleries |
---|
\?ID_TEXT
The gallery we are getting the tree starting from (null: root)
string
The parent breadcrumbs at this point of the recursion
\?array
The database row for the $gallery gallery (null: get it from the DB)
boolean
Whether to include video/image statistics in the returned tree
\?string
A function name to filter galleries with (null: no filter)
boolean
Whether displayed galleries must support images
boolean
Whether displayed galleries must support videos
boolean
Whether to NOT show member galleries that do not exist yet
boolean
Whether to get a list of child galleries (not just direct ones, recursively), instead of just IDs
\?integer
The number of recursive levels to search (null: all)
\?MEMBER
Member we are filtering for (null: not needed)
boolean
Whether to only show for what may be added to by the current member
boolean
Whether to only show for what may be edited by the current member
array
The tree structure, or if $use_compound_list, the tree structure built with pairs containing the compound list in addition to the child branchesget_member_id_from_gallery_name(\ID_TEXT $gallery_name, \?array $row= null
, boolean $only_if_personal_gallery= false
) : \?MEMBER
package | galleries |
---|
\ID_TEXT
The name of the gallery
\?array
Gallery row (null: look it up)
boolean
Only non-NULL if it is a personal gallery
\?MEMBER
The owner of the gallery (null: not a member owned gallery)get_potential_gallery_title(\ID_TEXT $cat) : \?SHORT_TEXT
package | galleries |
---|
\ID_TEXT
The gallery codename
\?SHORT_TEXT
The gallery title (null: does not exist and won't be auto-created)get_recursive_gallery_details(\ID_TEXT $name, boolean $test_videos= true
, boolean $test_images= true
) : array
package | galleries |
---|
\ID_TEXT
The name of the gallery
boolean
Whether to test for videos when making counts (ignore this parameter - used internally)
boolean
Whether to test for images when making counts (ignore this parameter - used internally)
array
A triplet: (num children, num images, num videos)get_video_details(\PATH $file_path, string $filename, boolean $delay_errors = false
) : \~array
package | galleries |
---|
\PATH
The path to the video file
string
The original filename of the video file (so we can find the file type from the file extension)
boolean
Whether to skip over errored files instead of dying. We don't currently make use of this as our readers aren't sophisticard enough to properly spot erroneous situations.
\~array
The triplet of width/height/length (possibly containing NULL's for when we can't detect properties) (false: error)make_member_gallery_if_needed(\ID_TEXT $cat)
only_conventional_galleries(\ID_TEXT $cat) : boolean
package | galleries |
---|
\ID_TEXT
The gallery name
boolean
Whether the gallery is NOT a download galleryonly_download_galleries(\ID_TEXT $cat) : boolean
package | galleries |
---|
\ID_TEXT
The gallery name
boolean
Whether the gallery is a download galleryonly_galleries_accepting_media(\ID_TEXT $cat) : boolean
package | galleries |
---|
\ID_TEXT
The gallery name
boolean
Whether the gallery accepts some mediaonly_member_galleries_of_id(\ID_TEXT $cat, \?MEMBER $member_id, integer $child_count) : boolean
package | galleries |
---|
\ID_TEXT
The gallery name
\?MEMBER
Member we are filtering for (null: not needed)
integer
The number of children for this gallery
boolean
The answerread_intel_endian_int(string $buffer) : integer
read_network_endian_int(string $buffer) : integer
render_gallery_box(array $myrow, \ID_TEXT $root= 'root'
, boolean $show_member_stats_if_appropriate= false
, \ID_TEXT $zone= '_SEARCH'
, boolean $quit_if_empty= true
, boolean $preview= false
, boolean $give_context= true
, boolean $include_breadcrumbs= true
, boolean $attach_to_url_filter= false
, \ID_TEXT $guid= ''
) : \Tempcode
package | galleries |
---|
array
The database row of the gallery
\ID_TEXT
The virtual root of the gallery
boolean
Whether to show member stats if it is a member owned gallery
\ID_TEXT
The zone that the gallery module we are linking to is in
boolean
Whether to not show anything if the gallery is empty
boolean
Whether only to show 'preview' details
boolean
Whether to include context (i.e. say WHAT this is, not just show the actual content)
boolean
Whether to include breadcrumbs (if there are any)
boolean
Whether to copy through any filter parameters in the URL, under the basis that they are associated with what this box is browsing
\ID_TEXT
Overridden GUID to send to templates (blank: none)
\Tempcode
The previewrender_image_box(array $row, \ID_TEXT $zone= '_SEARCH'
, boolean $give_context= true
, boolean $include_breadcrumbs= true
, \?ID_TEXT $root= null
, \ID_TEXT $guid= ''
) : \Tempcode
package | galleries |
---|
array
The image row
\ID_TEXT
The zone the galleries module is in
boolean
Whether to include context (i.e. say WHAT this is, not just show the actual content)
boolean
Whether to include breadcrumbs (if there are any)
\?ID_TEXT
Virtual root to use (null: none)
\ID_TEXT
Overridden GUID to send to templates (blank: none)
\Tempcode
The rendered boxrender_video_box(array $row, \ID_TEXT $zone= '_SEARCH'
, boolean $give_context= true
, boolean $include_breadcrumbs= true
, \?ID_TEXT $root= null
, \ID_TEXT $guid= ''
) : \Tempcode
package | galleries |
---|
array
The video row
\ID_TEXT
The zone the galleries module is in
boolean
Whether to include context (i.e. say WHAT this is, not just show the actual content)
boolean
Whether to include breadcrumbs (if there are any)
\?ID_TEXT
Virtual root to use (null: none)
\ID_TEXT
Overridden GUID to send to templates (blank: none)
\Tempcode
The rendered boxshow_gallery_video_media(\URLPATH $url, \URLPATH $thumb_url, integer $width, integer $height, integer $length, \MEMBER $submitter) : \Tempcode
package | galleries |
---|
\URLPATH
URL to media
\URLPATH
URL to thumbnail
integer
Width
integer
Height
integer
Length
\MEMBER
The entry submitter
\Tempcode
Displayed mediashow_video_details(array $myrow) : \Tempcode
store_transcoding_failure(\ID_TEXT $transcoder_id)
store_transcoding_success(\ID_TEXT $transcoder_id, \?URLPATH $new_url = null
)
package | galleries |
---|
\ID_TEXT
Transcoding ID
\?URLPATH
Transcoded URL (null: Discerned using t_output_filename field, which we assume is where transcoder has copied file to)
transcode_video(\URLPATH $url, \?ID_TEXT $table, \?AUTO_LINK $local_id, \?ID_TEXT $local_id_field, \?ID_TEXT $url_field, \?ID_TEXT $orig_filename_field, \?ID_TEXT $width_field, \?ID_TEXT $height_field) : \URLPATH
package | galleries |
---|
\URLPATH
URL of the video to be transcoded
\?ID_TEXT
The table we are saving into (null: don't save into DB)
\?AUTO_LINK
The ID of the video being transcoded (null: don't save into DB)
\?ID_TEXT
Name of the ID field in the table (null: don't save into DB)
\?ID_TEXT
Name of the URL field in the table (null: don't save into DB)
\?ID_TEXT
Name of the original filename field in the table (null: built into URL field)
\?ID_TEXT
Name of the width field in the table (null: none)
\?ID_TEXT
Name of the height field in the table (null: none)
\URLPATH
Transcoded file (or original URL if no change was made)watermark_gallery_image(\ID_TEXT $gallery, \PATH $file_path, string $filename)
package | galleries |
---|
\ID_TEXT
The name of the gallery for the image
\PATH
The path to the image file
string
The original file name of the image
zencoder_receive_script()
package | galleries |
---|
GETID3_HELPERAPPSDIR = get_file_base() . '/sources_custom/getid3/helperapps'
package | galleries |
---|