Class DigitalLibrary_Archon

Description
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[optional] $MakeIntoIndex = false])
Files[] getAllFiles ()
FileTypes[] getAllFileTypes ()
MediaTypes[] getAllMediaTypes ()
DigitalContent[] getDigitalContentForChar (string $Char)
FileType getFileTypeForExtension (string $Extension)
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], integer $SearchFlags[optional], integer $CollectionID[optional], integer $CollectionContentID[optional], integer $SubjectID[optional], integer $CreatorID[optional], integer $FileTypeID[optional], integer $MediaTypeID[optional], integer $Limit[optional])
FileType[] searchFileTypes (string $SearchQuery, [ $Limit = CONFIG_CORE_SEARCH_RESULTS_LIMIT], integer $Limit[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 131)

Creates a formatted string from an array of DigitalContent objects

  • access: public
string createStringFromDigitalContentArray (DigitalContent[] $arrDigitalContent, [ $Delimiter = ', '], [ $MakeIntoLink = LINK_NONE], [ $DirectlyLinkToContentURL = false], string $Delimiter[optional], integer $MakeIntoLink[optional], boolean $DirectlyLinkToContentURL[optional])
  • DigitalContent[] $arrDigitalContent
  • string $Delimiter[optional]
  • integer $MakeIntoLink[optional]
  • boolean $DirectlyLinkToContentURL[optional]
  • $Delimiter
  • $MakeIntoLink
  • $DirectlyLinkToContentURL
getAllDigitalContent (line 173)

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

  1. (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[optional] $MakeIntoIndex = false])
  • $MakeIntoIndex[optional] $MakeIntoIndex
getAllFiles (line 218)

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 ()
getAllFileTypes (line 235)

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 252)

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 267)

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

  • access: public
DigitalContent[] getDigitalContentForChar (string $Char)
  • string $Char
getFileTypeForExtension (line 308)

Returns the appropriate FileType for a specified extension.

  • access: public
FileType getFileTypeForExtension (string $Extension)
  • string $Extension
searchDigitalLibrary (line 351)

Searches the Digital Library database

  • access: public
DigitalContent[] searchDigitalLibrary (string $SearchQuery, [ $SearchFlags = SEARCH_DIGITALCONTENT],  $CollectionID,  $CollectionContentID,  $SubjectID,  $CreatorID,  $FileTypeID,  $MediaTypeID, [ $Limit = CONFIG_CORE_SEARCH_RESULTS_LIMIT], integer $SearchFlags[optional], integer $CollectionID[optional], integer $CollectionContentID[optional], integer $SubjectID[optional], integer $CreatorID[optional], integer $FileTypeID[optional], integer $MediaTypeID[optional], integer $Limit[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]
  • $SearchFlags
  • $CollectionID
  • $CollectionContentID
  • $SubjectID
  • $CreatorID
  • $FileTypeID
  • $MediaTypeID
  • $Limit
searchFileTypes (line 487)

Searches the FileType database

  • access: public
FileType[] searchFileTypes (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:12 -0600 by phpDocumentor 1.3.1