Docs For Class Creators

Class Creators_Archon

Description

abstract:

Located in /packages/creators/lib/core/archon.inc.php (line 2)

Method Summary

integer|Array countCreators ([ $Alphabetical = false], boolean $Alphabetical[optional])

string createStringFromCreatorArray (Creator[] $arrCreators, [ $Delimiter = ', '], [ $MakeIntoLink = LINK_NONE], [ $ConcatinateParentBody = false], string $Delimiter[optional], integer $MakeIntoLink[optional], boolean $ConcatinateParentBody[optional])

Creator[] getAllCreators ([$MakeIntoIndex[optional] $MakeIntoIndex = false])

CreatorType[] getAllCreatorTypes ()

integer getCreatorIDFromString (string $String)

Creator[] getCreatorsForChar (string $Char)

integer getCreatorTypeIDFromString (string $String)

Creator[] searchCreators (string $SearchQuery, [ $Limit = CONFIG_CORE_SEARCH_RESULTS_LIMIT], integer $Limit[optional])

Methods

countCreators (line 15)

Returns the number of Creators in the database

If $Alphabetical is set to true, an array will be returned with keys of a-z, #, and * each holding the count for Creator Names starting with that character. # represents all collections starting with a number, and * holds the total count of all collections.

access: public

integer|Array countCreators ([ $Alphabetical = false], boolean $Alphabetical[optional])

boolean $Alphabetical[optional]
$Alphabetical

createStringFromCreatorArray (line 67)

Creates a formatted string from an array of Creator objects

access: public

Creator[] $arrCreators
string $Delimiter[optional]
integer $MakeIntoLink[optional]
boolean $ConcatinateParentBody[optional]
$Delimiter
$MakeIntoLink
$ConcatinateParentBody

getAllCreators (line 110)

Retrieves all Creators from the database

If $MakeIntoIndex is false, the returned array of Creator objects is sorted by Creator and has IDs as keys.

If $MakeIntoIndex is true, the returned array is a two dimensional array, with the first dimension indexed with

(representing numeric characters) and the lowercase characters a-z.

Each of those arrays will contain a sorted set of Creator objects, with the Creator's IDs as keys.

access: public

Creator[] getAllCreators ([$MakeIntoIndex[optional] $MakeIntoIndex = false])

$MakeIntoIndex[optional] $MakeIntoIndex

getAllCreatorTypes (line 155)

Retrieves all Creator Types from the database

The returned array of CreatorType objects is sorted by CreatorType and has IDs as keys.

access: public

CreatorType[] getAllCreatorTypes ()

getCreatorIDFromString (line 172)

Returns CreatorID value when passed the string value for a container type.

access: public

integer getCreatorIDFromString (string $String)

string $String

getCreatorsForChar (line 196)

Retrieves an array of Creator objects that begin with the character specified by $Char

access: public

Creator[] getCreatorsForChar (string $Char)

string $Char

getCreatorTypeIDFromString (line 239)

Returns CreatorTypeID value when passed the string value for a container type.

access: public

integer getCreatorTypeIDFromString (string $String)

string $String

searchCreators (line 264)

Searches the Creator database

access: public

Creator[] searchCreators (string $SearchQuery, [ $Limit = CONFIG_CORE_SEARCH_RESULTS_LIMIT], integer $Limit[optional])

string $SearchQuery
integer $Limit[optional]
$Limit

Documentation generated on Wed, 05 Mar 2008 16:45:23 -0600 by phpDocumentor 1.3.1