Class TfishCollection
Collection content object class.
Represents a collection of content objects. For example, issues of a magazine produced at regular intervals (download content objects) can be bound to a collection object via the 'parent' property. Collections can contain mixed sets of content, for example images, videos, audio files etc.
Collections can be nested by assigning another collection as a parent object. In this way, collections can effectively serve as categories and you can construct independent category trees. For example, if you wanted to create a "publications" category or section of your website you would just create a collection object called "Publications" and assign it as the parent of your publications content. Collections are also content objects in their own right, so provide them with a nice description and image/screenshot!
- TfishAncestralObject
-
TfishContentObject
-
TfishCollection
Copyright: Simon Wilkinson 2013-2017 (https://tuskfish.biz)
License: GNU General Public License (GPL) V2
Author: Simon Wilkinson simon@isengard.biz
Version: Release: 1.0
Since: 1.0
Properties: int $id Auto-increment, set by database.
Properties: string $type Content object type eg. TfishArticle etc. [ALPHA]
Properties: string $title The name of this content.
Properties: string $teaser A short (one paragraph) summary or abstract for this content. [HTML]
Properties: string $description The full article or description of the content. [HTML]
Properties: string $media An associated download/audio/video file. [FILEPATH OR URL]
Properties: string $format Mimetype
Properties: string $file_size Specify in bytes.
Properties: string $creator Author.
Properties: string image An associated image file, eg. a screenshot a good way to handle it. [FILEPATH OR URL]
Properties: string $caption Caption of the image file.
Properties: string $date Date of publication expressed as a string.
Properties: int $parent A source work or collection of which this content is part.
Properties: string $language Future proofing.
Properties: int $rights Intellectual property rights scheme or license under which the work is distributed.
Properties: string $publisher The entity responsible for distributing this work.
Properties: array $tags Tag IDs associated with this object; not persistent (stored as taglinks in taglinks table).
Properties: int $online Toggle object on or offline.
Properties: int $submission_time Timestamp representing submission time.
Properties: int $counter Number of times this content was viewed or downloaded.
Properties: string $meta_title Set a custom page title for this content.
Properties: string $meta_description Set a custom page meta description for this content.
Properties: string $seo SEO-friendly string; it will be appended to the URL for this content.
Properties: string $handler Handler for this object (not persistent).
Properties: string $template The template that should be used to display this object (not persistent).
Properties: string $module The module that handles this content type (not persistent).
Properties: string $icon The Font Awesome icon representing this content type (not persistent).
Located at trust_path/libraries/tuskfish/class/TfishCollection.php
Methods summary
public
|
|
public
|
|
protected
string
|
#
makeHumanReadable( string $clean_property )
Converts properties to human readable form in preparation for output. |
public
array
|
#
zeroedProperties( )
Returns an array of base object properties that are not used by this subclass. |
Methods inherited from TfishContentObject
escape(),
getCachedImage(),
getURL(),
loadProperties(),
validMedia()
Methods inherited from TfishAncestralObject
__get(),
__isset(),
__unset(),
getPropertyWhitelist(),
toArray()