Tuskfish API
  • Package
  • Class

Packages

  • content
  • core
  • database
  • installation
  • security
  • user
  • utilities

Classes

  • TfishArticle
  • TfishArticleHandler
  • TfishAudio
  • TfishAudioHandler
  • TfishBlock
  • TfishBlockHandler
  • TfishCollection
  • TfishCollectionHandler
  • TfishContentHandler
  • TfishContentObject
  • TfishDownload
  • TfishDownloadHandler
  • TfishImage
  • TfishImageHandler
  • TfishMetadata
  • TfishRss
  • TfishStatic
  • TfishStaticHandler
  • TfishTag
  • TfishTagHandler
  • TfishTaglink
  • TfishTaglinkHandler
  • TfishTemplate
  • TfishVideo
  • TfishVideoHandler

Class TfishCollectionHandler

Handler class for collection content objects.

TfishContentHandler
Extended by TfishCollectionHandler
Package: content
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
Located at trust_path/libraries/tuskfish/class/TfishCollectionHandler.php

Methods summary

public static integer
# getCount( TfishCriteria $criteria = null )

Count TfishCollection objects, optionally matching conditions specified with a TfishCriteria\ object.

Count TfishCollection objects, optionally matching conditions specified with a TfishCriteria\ object.

Parameters

$criteria
TfishCriteria object used to build conditional database query.

Returns

integer
$count Number of collection objects matching the criteria.

Overrides

TfishContentHandler::getCount
public static array
# getObjects( TfishCriteria $criteria = null )

Get TfishCollection objects, optionally matching conditions specified with a TfishCriteria object.

Get TfishCollection objects, optionally matching conditions specified with a TfishCriteria object.

Note that the object type is automatically set, so it is unnecessary to set it when calling TfishCollectionHandler::getObjects($criteria). However, if you want to use the generic handler TfishContentHandler::getObjects($criteria) then you do need to specify the object type, otherwise you will get all types of content returned. It is acceptable to use either handler, although good practice to use the type-specific one when you know you want a specific kind of object.

Parameters

$criteria
TfishCriteria object used to build conditional database query.

Returns

array
$objects TfishCollection objects.

Overrides

TfishContentHandler::getObjects
public static string
# getParentSelectBox( integer $selected = 0 )

Get a select box listing a tree of parent (TfishCollection) objects.

Get a select box listing a tree of parent (TfishCollection) objects.

Parameters

$selected
Currently selected option.

Returns

string
HTML select box.

Methods inherited from TfishContentHandler

delete(), deleteParentalReferences(), getActiveTagList(), getLanguages(), getList(), getObject(), getOnlineSelectBox(), getRights(), getTagList(), getTags(), getTypeIndex(), getTypeSelectBox(), getTypes(), insert(), isSanctionedType(), makeTagLinks(), searchContent(), toObject(), toggleOnlineStatus(), update(), updateCounter()

Tuskfish API API documentation generated by ApiGen