Docs For Class DigitalLibrary

Class DigitalLibrary_Archon

Description

abstract:

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

Method Summary

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

void createImageThumbnail (string $Image, string $ImageType, [ $Width = NULL], [ $Height = NULL], integer $Width[optional], integer $Height[optional])

string createStringFromDigitalContentArray (DigitalContent[] $arrDigitalContent, [ $Delimiter = ', '], [ $MakeIntoLink = LINK_NONE], [ $DirectlyLinkToContentURL = false], string $Delimiter[optional], integer $MakeIntoLink[optional], boolean $DirectlyLinkToContentURL[optional])

DigitalContent[] getAllDigitalContent ([ $MakeIntoIndex = false], [ $ExcludeDisabledContent = false], boolean $MakeIntoIndex[optional], boolean $ExcludeDisabledContent[optional])

Files[] getAllFiles ([ $ExcludeDisabledFiles = false], boolean $ExcludeDisabledFiles[optional])

FileTypes[] getAllFileTypes ()

MediaTypes[] getAllMediaTypes ()

DigitalContent[] getDigitalContentForChar (string $Char)

FileType getFileTypeForExtension (string $Extension)

integer getMediaTypeIDFromString (string $String)

DigitalContent[] searchDigitalLibrary (string $SearchQuery, [ $SearchFlags = SEARCH_DIGITALCONTENT], [ $CollectionID = 0], [ $CollectionContentID = 0], [ $SubjectID = 0], [ $CreatorID = 0], [ $FileTypeID = 0], [ $MediaTypeID = 0], [ $Limit = CONFIG_CORE_SEARCH_RESULTS_LIMIT], [ $Offset = 0], integer $SearchFlags[optional], integer $CollectionID[optional], integer $CollectionContentID[optional], integer $SubjectID[optional], integer $CreatorID[optional], integer $FileTypeID[optional], integer $MediaTypeID[optional], integer $Limit[optional], integer $Offset[optional])

FileType[] searchFileTypes (string $SearchQuery, [ $Limit = CONFIG_CORE_SEARCH_RESULTS_LIMIT], [ $Offset = 0], integer $Limit[optional], integer $Offset[optional])

Methods

countDigitalContent (line 15)

Returns the number of Digital Content 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 Digital Content Titles starting with that character. # represents all collections starting with a number, and * holds the total count of all collections.

access: public

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

boolean $Alphabetical[optional]
$Alphabetical

createImageThumbnail (line 70)

Creates a thumbnail of an image.

Image should contain the raw image data. Image type should contain the image format such that the function image$ImageType can be called to create the thumbnail. If only width or height is specified, the other will be calculated based upon the proportions of the original image.

access: public

void createImageThumbnail (string $Image, string $ImageType, [ $Width = NULL], [ $Height = NULL], integer $Width[optional], integer $Height[optional])

string $Image
string $ImageType
integer $Width[optional]
integer $Height[optional]
$Width
$Height

createStringFromDigitalContentArray (line 136)

Creates a formatted string from an array of DigitalContent objects

access: public

DigitalContent[] $arrDigitalContent
string $Delimiter[optional]
integer $MakeIntoLink[optional]
boolean $DirectlyLinkToContentURL[optional]
$Delimiter
$MakeIntoLink
$DirectlyLinkToContentURL

getAllDigitalContent (line 179)

Retrieves all Digital Content from the database

If $MakeIntoIndex is false, the returned array of DigitalContent objects is sorted by DigitalContent 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 DigitalContent objects, with the DigitalContent's IDs as keys.

access: public

DigitalContent[] getAllDigitalContent ([ $MakeIntoIndex = false], [ $ExcludeDisabledContent = false], boolean $MakeIntoIndex[optional], boolean $ExcludeDisabledContent[optional])

boolean $MakeIntoIndex[optional]
boolean $ExcludeDisabledContent[optional]
$MakeIntoIndex
$ExcludeDisabledContent

getAllFiles (line 231)

Retrieves all Files from the database

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

access: public

Files[] getAllFiles ([ $ExcludeDisabledFiles = false], boolean $ExcludeDisabledFiles[optional])

boolean $ExcludeDisabledFiles[optional]
$ExcludeDisabledFiles

getAllFileTypes (line 253)

Retrieves all File Types from the database

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

access: public

FileTypes[] getAllFileTypes ()

getAllMediaTypes (line 270)

Retrieves all Media Types from the database

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

access: public

MediaTypes[] getAllMediaTypes ()

getDigitalContentForChar (line 285)

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

access: public

DigitalContent[] getDigitalContentForChar (string $Char)

string $Char

getFileTypeForExtension (line 326)

Returns the appropriate FileType for a specified extension.

access: public

FileType getFileTypeForExtension (string $Extension)

string $Extension

getMediaTypeIDFromString (line 361)

Returns MediaTypeID value for a media type passed as a string.

access: public

integer getMediaTypeIDFromString (string $String)

string $String

searchDigitalLibrary (line 398)

Searches the Digital Library database

Note that $SubjectID and $CreatorID will not affect the search if their respective packages are not installed and enabled

access: public

DigitalContent[] searchDigitalLibrary (string $SearchQuery, [ $SearchFlags = SEARCH_DIGITALCONTENT], $CollectionID, $CollectionContentID, $SubjectID, $CreatorID, $FileTypeID, $MediaTypeID, [ $Limit = CONFIG_CORE_SEARCH_RESULTS_LIMIT], $Offset, integer $SearchFlags[optional], integer $CollectionID[optional], integer $CollectionContentID[optional], integer $SubjectID[optional], integer $CreatorID[optional], integer $FileTypeID[optional], integer $MediaTypeID[optional], integer $Limit[optional], integer $Offset[optional])

string $SearchQuery
integer $SearchFlags[optional]
integer $CollectionID[optional]
integer $CollectionContentID[optional]
integer $SubjectID[optional]
integer $CreatorID[optional]
integer $FileTypeID[optional]
integer $MediaTypeID[optional]
integer $Limit[optional]
integer $Offset[optional]
$SearchFlags
$CollectionID
$CollectionContentID
$SubjectID
$CreatorID
$FileTypeID
$MediaTypeID
$Limit
$Offset

searchFileTypes (line 560)

Searches the FileType database

access: public

FileType[] searchFileTypes (string $SearchQuery, [ $Limit = CONFIG_CORE_SEARCH_RESULTS_LIMIT], $Offset, integer $Limit[optional], integer $Offset[optional])

string $SearchQuery
integer $Limit[optional]
integer $Offset[optional]
$Limit
$Offset

Documentation generated on Thu, 14 Aug 2008 20:21:14 -0500 by phpDocumentor 1.3.1