Docs For Class Archon

Description

Located in File: /lib/archon.inc.php

Archon Object Defintion

Class Variables

Summary:

string $ArchonURL

ArchonConfiguration[] $Configuration

string $Copyright

string $Delimiter

boolean $Disabled

string $Error

string $ProductName

string $ReleaseDate

ArchonSecurity $Security

array $TemplateSet

string $Version

$ArchonURL = 'http://www.archon.org/' (line 4320)

Data type : string

Contains the URL to The Archon Project website.

access: - public

$Configuration = NULL (line 4329)

Data type : ArchonConfiguration[]

Contains and array of ArchonConfiguration objects, each of which represents a configuration directive in the Configuration table.

access: - public

$Copyright = 'Copyright ©2006 <a href="http://www.uiuc.edu/">The University of Illinois at Urbana-Champaign</a>' (line 4334)

Data type : string

access: - public

$Delimiter = '/' (line 4339)

Data type : string

access: - public

$Disabled = false (line 4349)

Data type : boolean

When this variable is set to true, Archon is disabled to the public.

Typically there is no reason to modify this variable directly, as there is a configuration directive that will disable Archon as well.

access: - public

$Error = NULL (line 4357)

Data type : string

If an error occurs within the API, this value will be set to a text description of the error.

access: - public

$ProductName = 'Archon' (line 4367)

Data type : string

access: - public

$ReleaseDate = '2007.01.04' (line 4372)

Data type : string

access: - public

$Security = NULL (line 4377)

Data type : ArchonSecurity

access: - public

$TemplateSet = NULL (line 4382)

Data type : array

access: - public

$Version = '1.10' (line 4389)

Data type : string

Contains the version of the Archon codebase.

access: - public

Class Constants

Summary:

Method Detail

Summary:

Archon Archon ()

boolean clearCacheEntry (string $Table)

mixed createConsensusVariable (mixed $var1, mixed $var2)

string createFormattedPhrase (string[] $arrArguments, string $PhraseName, int $PhraseTypeID, [ $LanguageID = DEFAULT_LANGUAGE], int $LanguageID[optional])

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

integer[] createNumericArrayFromString (string $String)

string[] createSearchWordArray (string $String)

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

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

string createStringFromLanguageArray (Language[] $arrLanguages, [ $Delimiter = ', '], [ $MakeIntoLink = LINK_NONE], string $Delimiter[optional], integer $MakeIntoLink[optional])

string createStringFromLocationEntryArray (LocationEntry[] $arrLocationEntries, [ $Delimiter = ', '], [ $MakeIntoLink = LINK_NONE], [ $ConcatinateFieldNames = true], [ $SubDelimiter = ", "], string $Delimiter[optional], integer $MakeIntoLink[optional], boolean $ConcatinateFieldNames[optional], string $SubDelimiter[optional])

string createStringFromSubjectArray (Subject[] $arrSubjects, [ $Delimiter = ', '], [ $MakeIntoLink = LINK_NONE], [ $SubDelimiter = ' - '], string $Delimiter[optional], integer $MakeIntoLink[optional], string $SubDelimiter[optional])

string createStringFromUserFieldArray (UserField[] $arrUserFields, [ $Delimiter = ', '], [ $MakeIntoLink = LINK_NONE], [ $ConcatinateTitles = true], string $Delimiter[optional], integer $MakeIntoLink[optional], string $ConcatinateTitles[optional])

string[] getAllAdminStyles ()

Classification[] getAllClassifications ()

Collection[] getAllCollections ([ $MakeIntoIndex = false], [ $ExcludeDisabledCollections = false], [ $RepositoryID = 0], boolean $MakeIntoIndex[optional], boolean $ExcludeDisabledCollections[optional], integer $RepositoryID[optional])

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

CreatorType[] getAllCreatorTypes ()

DescRules[] getAllDescRules ()

DigitalContent[] getAllDigitalContent ([$MakeIntoIndex[optional] $MakeIntoIndex = false])

EADElement[] getAllEADElements ()

ExtentUnits[] getAllExtentUnits ()

Files[] getAllFiles ()

FileTypes[] getAllFileTypes ()

string[] getAllIncomingFiles ()

Language[] getAllLanguages ()

LevelContainer[] getAllLevelContainers ()

Location[] getAllLocations ()

MaterialType[] getAllMaterialTypes ()

MediaTypes[] getAllMediaTypes ()

ModuleCategory[] getAllModuleCategories ()

Module[] getAllModules ()

Phrase[] getAllPhrases ()

PhraseType[] getAllPhraseTypes ()

Repository[] getAllRepositories ()

Repository[] getAllSessions ()

string[] getAllStyles ()

Subject[] getAllSubjects ([ $MakeIntoIndex = false], boolean $MakeIntoIndex[optional])

Subject[] getAllSubjectsForSubjectTypeID ( $SubjectTypeID)

SubjectSource[] getAllSubjectSources ()

SubjectType[] getAllSubjectTypes ()

string[] getAllTemplates ()

Usergroup[] getAllUsergroups ()

User[] getAllUsers ()

Classification[] getChildClassifications ([ $ID = 0], integer $ID[optional])

CollectionContent[] getChildCollectionContent (integer $ContentID, [ $CollectionID = 0], integer $CollectionID[optional])

Subject[] getChildSubjects (integer $ID)

Classification[] getClassificationArrayFromIDArray (integer[] $arrIDs)

CollectionContent[] getCollectionContentArrayFromIDArray (integer[] $arrIDs)

integer getCollectionContentIDForData (integer $CollectionID, integer $LevelContainerID, integer $LevelContainerNumber, [ $ParentID = 0], integer $ParentID[optional])

Collection[] getCollectionsForClassification (integer $ID, [ $ExcludeDisabledCollections = false], boolean $ExcludeDisabledCollections[optional])

integer getCreatorIDFromString (string $String)

integer getCreatorTypeIDFromString (string $String)

array getExtentForLocation (int $LocationID)

integer getExtentUnitsIDFromString (string $String)

FileType getFileTypeForExtension (string $Extension)

integer getLanguageIDFromString (string $String)

string getLatestArchonVersion ()

integer getLevelContainerIDFromString (string $String)

integer getMaterialTypeIDFromString (string $String)

integer getModuleIDFromScript (string $Script)

integer getNextLevelContainerNumber (integer $CollectionID, integer $LevelContainerID, [ $ParentID = 0], integer $ParentID[optional])

integer getPermissionsForUser (integer $UserID, integer $ModuleID)

integer getPermissionsForUsergroup (integer $UsergroupID, integer $ModuleID)

Phrase getPhrase (string $PhraseName, [ $PhraseTypeID = 0], [ $LanguageID = DEFAULT_LANGUAGE], integer $PhraseTypeID[optional], integer $LanguageID[optional])

integer getPhraseTypeIDFromString (string $String)

CollectionContent[] getSiblingCollectionContent (integer $ID)

Subject[] getSubjectArrayFromIDArray (integer[] $arrIDs)

integer getSubjectIDFromString (string $String)

integer getSubjectTypeIDFromString (string $String)

User[] getUserArrayFromIDArray (integer[] $arrIDs)

Usergroup[] getUsergroupArrayFromIDArray (integer[] $arrIDs)

integer getUserIDForLogin (string $Login)

void initialize ()

array loadTemplates (string $TemplateSet)

string processPhrase (string $Phrase)

Classification[] searchClassifications (string $SearchQuery, [ $ParentID = NULL], [ $Limit = SEARCH_RESULTS_LIMIT], integer $ParentID[optional], integer $Limit[optional])

Collection[] searchCollections (string $SearchQuery, [ $SearchFlags = SEARCH_COLLECTIONS], [ $SubjectID = 0], [ $CreatorID = 0], [ $LanguageID = 0], [ $RepositoryID = 0], [ $LocationID = 0], [ $Range = NULL], [ $Section = NULL], [ $Shelf = NULL], [ $Limit = SEARCH_RESULTS_LIMIT], integer $SearchFlags[optional], integer $SubjectID[optional], integer $CreatorID[optional], integer $LanguageID[optional], integer $RepositoryID[optional], integer $LocationID[optional], string $Range[optional], string $Section[optional], string $Shelf[optional], integer $Limit[optional])

void searchCollectionsByClassification (string $SearchQuery, [ $SearchFlags = SEARCH_COLLECTIONS], [ $SubjectID = 0], [ $CreatorID = 0], [ $LanguageID = 0], [ $RepositoryID = 0], [ $LocationID = 0], [ $Range = NULL], [ $Section = NULL], [ $Shelf = NULL], [ $Limit = SEARCH_RESULTS_LIMIT], integer $SearchFlags[optional], integer $SubjectID[optional], integer $CreatorID[optional], integer $LanguageID[optional], integer $RepositoryID[optional], integer $LocationID[optional], string $Range[optional], string $Section[optional], string $Shelf[optional], integer $Limit[optional])

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

DigitalContent[] searchDigitalLibrary (string $SearchQuery, [ $SearchFlags = SEARCH_DIGITALCONTENT], [ $CollectionID = 0], [ $CollectionContentID = 0], [ $SubjectID = 0], [ $CreatorID = 0], [ $FileTypeID = 0], [ $MediaTypeID = 0], [ $Limit = 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 = SEARCH_RESULTS_LIMIT], integer $Limit[optional])

Language[] searchLanguages (string $SearchQuery, [ $Limit = SEARCH_RESULTS_LIMIT], integer $Limit[optional])

LevelContainer[] searchLevelContainers (string $SearchQuery, [ $Limit = SEARCH_RESULTS_LIMIT], integer $Limit[optional])

Location[] searchLocations (string $SearchQuery, [ $Limit = SEARCH_RESULTS_LIMIT], integer $Limit[optional])

MaterialType[] searchMaterialTypes (string $SearchQuery, [ $Limit = SEARCH_RESULTS_LIMIT], integer $Limit[optional])

Phrase[] searchPhrases (string $SearchQuery, [ $PhraseTypeID = 0], [ $LanguageID = DEFAULT_LANGUAGE], [ $Limit = SEARCH_RESULTS_LIMIT], integer $PhraseTypeID[optional], integer $LanguageID[optional], integer $Limit[optional])

Repository[] searchRepositories (string $SearchQuery, [ $Limit = SEARCH_RESULTS_LIMIT], integer $Limit[optional])

Creator[] searchSubjects (string $SearchQuery, [ $ParentID = NULL], [ $SubjectTypeID = 0], [ $Limit = SEARCH_RESULTS_LIMIT], integer $ParentID[optional], integer $SubjectTypeID[optional], integer $Limit[optional])

void sendMessageAndRedirect (string $Message, [string $Location = NULL])

Classification[] traverseClassification (integer $ID)

CollectionContent[] traverseCollectionContent (integer $ID)

Subject[] traverseSubject (integer $ID)

Constructor Archon (line 48)

Archon Archon( )

Archon Constructor

Info

access - public

Method clearCacheEntry (line 74)

boolean clearCacheEntry( string $Table)

Clears Memory Cache of the entry denoted by $Table

Parameters

string $Table:

Info

access - public

Method createConsensusVariable (line 100)

mixed createConsensusVariable( mixed $var1, mixed $var2)

Fully traverses two variables and returns a "consensus" variable

If the argument variables are objects or arrays, the function will return a variable of the same type with any member variables that are not equal in both set to variables set to the value specified by MULTIPLE_VALUES.

Note that this function is unable to precisely compare objects that have private member variables, since it cannot access them.

Parameters

mixed $var1:
mixed $var2:

Info

access - public

Method createFormattedPhrase (line 324)

string createFormattedPhrase( string[] $arrArguments, string $PhraseName, int $PhraseTypeID, [ $LanguageID = DEFAULT_LANGUAGE], int $LanguageID[optional])

Creates a formatted phrase (depreciated)

Parameters

string[] $arrArguments:
string $PhraseName:
int $PhraseTypeID:
int $LanguageID[optional]:
$LanguageID:

Info

access - public

Method createImageThumbnail (line 219)

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

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.

Parameters

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

Info

access - public

Method createNumericArrayFromString (line 284)

integer[] createNumericArrayFromString( string $String)

Takes a string representing a range or list of numbers and creates and array containing all numbers the string represents.

Parameters

string $String:

Info

access - public

Method createSearchWordArray (line 357)

string[] createSearchWordArray( string $String)

Creates an array of words and phrases parsed from a query string

Note: The strings in the returned array all have their slashes stripped.

Parameters

string $String:

Info

access - public

Method createStringFromCreatorArray (line 423)

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

Creates a formatted string from an array of Creator objects

Parameters

Creator[] $arrCreators:
string $Delimiter[optional]:
integer $MakeIntoLink[optional]:
$Delimiter:
$MakeIntoLink:

Info

access - public

Method createStringFromDigitalContentArray (line 457)

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

Creates a formatted string from an array of DigitalContent objects

Parameters

DigitalContent[] $arrDigitalContent:
string $Delimiter[optional]:
integer $MakeIntoLink[optional]:
$Delimiter:
$MakeIntoLink:

Info

access - public

Method createStringFromLanguageArray (line 492)

string createStringFromLanguageArray( Language[] $arrLanguages, [ $Delimiter = ', '], [ $MakeIntoLink = LINK_NONE], string $Delimiter[optional], integer $MakeIntoLink[optional])

Creates an formatted string from an array of Language objects

Parameters

Language[] $arrLanguages:
string $Delimiter[optional]:
integer $MakeIntoLink[optional]:
$Delimiter:
$MakeIntoLink:

Info

access - public

Method createStringFromLocationEntryArray (line 529)

string createStringFromLocationEntryArray( LocationEntry[] $arrLocationEntries, [ $Delimiter = ', '], [ $MakeIntoLink = LINK_NONE], [ $ConcatinateFieldNames = true], [ $SubDelimiter = ", "], string $Delimiter[optional], integer $MakeIntoLink[optional], boolean $ConcatinateFieldNames[optional], string $SubDelimiter[optional])

Creates an formatted string from an array of LocationEntry objects

Parameters

LocationEntry[] $arrLocationEntries:
string $Delimiter[optional]:
integer $MakeIntoLink[optional]:
boolean $ConcatinateFieldNames[optional]:
string $SubDelimiter[optional]:
$Delimiter:
$MakeIntoLink:
$ConcatinateFieldNames:
$SubDelimiter:

Info

access - public

Method createStringFromSubjectArray (line 565)

string createStringFromSubjectArray( Subject[] $arrSubjects, [ $Delimiter = ', '], [ $MakeIntoLink = LINK_NONE], [ $SubDelimiter = ' - '], string $Delimiter[optional], integer $MakeIntoLink[optional], string $SubDelimiter[optional])

Creates an formatted string from an array of Subject objects

Parameters

Subject[] $arrSubjects:
string $Delimiter[optional]:
integer $MakeIntoLink[optional]:
string $SubDelimiter[optional]:
$Delimiter:
$MakeIntoLink:
$SubDelimiter:

Info

access - public

Method createStringFromUserFieldArray (line 601)

string createStringFromUserFieldArray( UserField[] $arrUserFields, [ $Delimiter = ', '], [ $MakeIntoLink = LINK_NONE], [ $ConcatinateTitles = true], string $Delimiter[optional], integer $MakeIntoLink[optional], string $ConcatinateTitles[optional])

Creates an formatted string from an array of UserField objects

Parameters

UserField[] $arrUserFields:
string $Delimiter[optional]:
integer $MakeIntoLink[optional]:
string $ConcatinateTitles[optional]:
$Delimiter:
$MakeIntoLink:
$ConcatinateTitles:

Info

access - public

Method getAllAdminStyles (line 636)

string[] getAllAdminStyles( )

Returns any array of installed styles.

The names of installed styles are derived from the directory names under styles/

Info

return - array of style names
access - public

Method getAllClassifications (line 679)

Classification[] getAllClassifications( )

Retrieves all Classifications from the database

The returned array of Classification objects is nested such that the objects will have their Classification[] member variable populated with their children, which allows for a complete tree structure.

Info

access - public

Method getAllCollections (line 719)

Collection[] getAllCollections( [ $MakeIntoIndex = false], [ $ExcludeDisabledCollections = false], [ $RepositoryID = 0], boolean $MakeIntoIndex[optional], boolean $ExcludeDisabledCollections[optional], integer $RepositoryID[optional])

Retrieves all Collections from the database

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

Please realize that calling this function could take a very long time if there are a lot of collections.

Also, this function does NOT load content or retrieve related information like subjects, creators, etc.

Parameters

boolean $MakeIntoIndex[optional]:
boolean $ExcludeDisabledCollections[optional]:
integer $RepositoryID[optional]:
$MakeIntoIndex:
$ExcludeDisabledCollections:
$RepositoryID:

Info

access - public

Method getAllCreators (line 799)

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

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.

Parameters

$MakeIntoIndex[optional] $MakeIntoIndex:

Info

access - public

Method getAllCreatorTypes (line 844)

CreatorType[] getAllCreatorTypes( )

Retrieves all Creator Types from the database

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

Info

access - public

Method getAllDescRules (line 861)

DescRules[] getAllDescRules( )

Retrieves all Descriptive Rules from the database

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

Info

access - public

Method getAllDigitalContent (line 885)

DigitalContent[] getAllDigitalContent( [$MakeIntoIndex[optional] $MakeIntoIndex = false])

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.

Parameters

$MakeIntoIndex[optional] $MakeIntoIndex:

Info

access - public

Method getAllEADElements (line 930)

EADElement[] getAllEADElements( )

Retrieves all EAD Elements from the database

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

Info

access - public

Method getAllExtentUnits (line 947)

ExtentUnits[] getAllExtentUnits( )

Retrieves all Extent Units from the database

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

Info

access - public

Method getAllFiles (line 964)

Files[] getAllFiles( )

Retrieves all Files from the database

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

Info

access - public

Method getAllFileTypes (line 981)

FileTypes[] getAllFileTypes( )

Retrieves all File Types from the database

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

Info

access - public

Method getAllIncomingFiles (line 998)

string[] getAllIncomingFiles( )

Returns any array of installed IncomingFiles.

The names of installed IncomingFiles are derived from the directory names under IncomingFiles/

Info

return - array of style names
access - public

Method getAllLanguages (line 1039)

Language[] getAllLanguages( )

Retrieves all Languages from the database

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

Info

access - public

Method getAllLevelContainers (line 774)

LevelContainer[] getAllLevelContainers( )

Retrieves all Container Types from the database

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

Info

access - public

Method getAllLocations (line 1056)

Location[] getAllLocations( )

Retrieves all Locations from the database

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

Info

access - public

Method getAllMaterialTypes (line 1073)

MaterialType[] getAllMaterialTypes( )

Retrieves all Material Types from the database

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

Info

access - public

Method getAllMediaTypes (line 1090)

MediaTypes[] getAllMediaTypes( )

Retrieves all Media Types from the database

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

Info

access - public

Method getAllModuleCategories (line 1107)

ModuleCategory[] getAllModuleCategories( )

Retrieves all Module Categories from the database

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

Info

access - public

Method getAllModules (line 1124)

Module[] getAllModules( )

Retrieves all Modules from the database

The returned array of Module objects is sorted by Category, Module and has IDs as keys.

Info

access - public

Method getAllPhrases (line 1159)

Phrase[] getAllPhrases( )

Retrieves all Phrases from the database

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

Info

access - public

Method getAllPhraseTypes (line 1176)

PhraseType[] getAllPhraseTypes( )

Retrieves all Phrase Types from the database

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

Info

access - public

Method getAllRepositories (line 1193)

Repository[] getAllRepositories( )

Retrieves all Repositories from the database

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

Info

access - public

Method getAllSessions (line 1210)

Repository[] getAllSessions( )

Retrieves all Repositories from the database

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

Info

access - public

Method getAllStyles (line 1227)

string[] getAllStyles( )

Returns any array of installed styles.

The names of installed styles are derived from the directory names under styles/

Info

return - array of style names
access - public

Method getAllSubjects (line 1275)

Subject[] getAllSubjects( [ $MakeIntoIndex = false], boolean $MakeIntoIndex[optional])

Retrieves all Subjects from the database

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

Parameters

boolean $MakeIntoIndex[optional]:
$MakeIntoIndex:

Info

access - public

Method getAllSubjectsForSubjectTypeID (line 1325)

Subject[] getAllSubjectsForSubjectTypeID( $SubjectTypeID)

Retrieves all Subjects for a subject type from the database

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

Parameters

$SubjectTypeID:

Info

access - public

Method getAllSubjectSources (line 1364)

SubjectSource[] getAllSubjectSources( )

Retrieves all Subject Sources from the database

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

Info

access - public

Method getAllSubjectTypes (line 1347)

SubjectType[] getAllSubjectTypes( )

Retrieves all Subject Types from the database

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

Info

access - public

Method getAllTemplates (line 1381)

string[] getAllTemplates( )

Returns any array of installed templates.

The names of installed templates are derived from the directory names under templates/

Info

return - array of template names
access - public

Method getAllUsergroups (line 1422)

Usergroup[] getAllUsergroups( )

Retrieves all Usergroups from the database

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

Info

access - public

Method getAllUsers (line 1448)

User[] getAllUsers( )

Retrieves all Users from the database

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

Info

access - public

Method getChildClassifications (line 1482)

Classification[] getChildClassifications( [ $ID = 0], integer $ID[optional])

Retrieves child Classifications for Classification specified by $ID

Parameters

integer $ID[optional]:
$ID:

Info

access - public

Method getChildCollectionContent (line 1506)

CollectionContent[] getChildCollectionContent( integer $ContentID, [ $CollectionID = 0], integer $CollectionID[optional])

Retrieves child CollectionContent for CollectionContent specified by $ContentID

$CollectionID is required whenever $ContentID = 0

Parameters

integer $ContentID:
integer $CollectionID[optional]:
$CollectionID:

Info

access - public

Method getChildSubjects (line 1556)

Subject[] getChildSubjects( integer $ID)

Retrieves child Subjects for Subject specified by $ID

Parameters

integer $ID:

Info

access - public

Method getClassificationArrayFromIDArray (line 1579)

Classification[] getClassificationArrayFromIDArray( integer[] $arrIDs)

Retrieves an array containing Classification objects for each ID in $arrIDs

Parameters

integer[] $arrIDs:

Info

access - public

Method getCollectionContentArrayFromIDArray (line 1641)

CollectionContent[] getCollectionContentArrayFromIDArray( integer[] $arrIDs)

Retrieves an array containing CollectionContent objects for each ID in $arrIDs

Parameters

integer[] $arrIDs:

Info

access - public

Method getCollectionContentIDForData (line 1703)

integer getCollectionContentIDForData( integer $CollectionID, integer $LevelContainerID, integer $LevelContainerNumber, [ $ParentID = 0], integer $ParentID[optional])

Returns CollectionContentID when passed the CollectionID, LevelContainerID, LevelContainerNumber, and ParentID

Parameters

integer $CollectionID:
integer $LevelContainerID:
integer $LevelContainerNumber:
integer $ParentID[optional]:
$ParentID:

Info

access - public

Method getCollectionsForClassification (line 1770)

Collection[] getCollectionsForClassification( integer $ID, [ $ExcludeDisabledCollections = false], boolean $ExcludeDisabledCollections[optional])

Retrieves an array of Collection objects that are organized under the Classification specified by $ID

Parameters

integer $ID:
boolean $ExcludeDisabledCollections[optional]:
$ExcludeDisabledCollections:

Info

access - public

Method getCreatorIDFromString (line 1852)

integer getCreatorIDFromString( string $String)

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

Parameters

string $String:

Info

access - public

Method getCreatorTypeIDFromString (line 1880)

integer getCreatorTypeIDFromString( string $String)

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

Parameters

string $String:

Info

access - public

Method getExtentForLocation (line 1911)

array getExtentForLocation( int $LocationID)

Returns an array containing detailed extent information derived from entries in the location index. Each element in the array will be an object with two member variables:

float Extent ExtentUnits ExtentUnits

Parameters

int $LocationID:

Info

access - public

Method getExtentUnitsIDFromString (line 1967)

integer getExtentUnitsIDFromString( string $String)

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

Parameters

string $String:

Info

access - public

Method getFileTypeForExtension (line 1993)

FileType getFileTypeForExtension( string $Extension)

Returns the appropriate FileType for a specified extension.

Parameters

string $Extension:

Info

access - public

Method getLanguageIDFromString (line 2032)

integer getLanguageIDFromString( string $String)

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

Parameters

string $String:

Info

access - public

Method getLatestArchonVersion (line 2057)

string getLatestArchonVersion( )

Returns the version of the latest of Archon

Info

access - public

Method getLevelContainerIDFromString (line 1824)

integer getLevelContainerIDFromString( string $String)

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

Parameters

string $String:

Info

access - public

Method getMaterialTypeIDFromString (line 2074)

integer getMaterialTypeIDFromString( string $String)

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

Parameters

string $String:

Info

access - public

Method getModuleIDFromScript (line 2101)

integer getModuleIDFromScript( string $Script)

Returns ModuleID value when passed the module script string.

Parameters

string $Script:

Info

access - public

Method getNextLevelContainerNumber (line 2129)

integer getNextLevelContainerNumber( integer $CollectionID, integer $LevelContainerID, [ $ParentID = 0], integer $ParentID[optional])

Returns next container number when passed the CollectionID, ParentID, and LevelContainerID

Parameters

integer $CollectionID:
integer $LevelContainerID:
integer $ParentID[optional]:
$ParentID:

Info

access - public

Method getPermissionsForUser (line 2181)

integer getPermissionsForUser( integer $UserID, integer $ModuleID)

Retrives permissions for a specified user and module

Parameters

integer $UserID:
integer $ModuleID:

Info

access - public

Method getPermissionsForUsergroup (line 2255)

integer getPermissionsForUsergroup( integer $UsergroupID, integer $ModuleID)

Retrives permissions for a specified usergroup and module

Parameters

integer $UsergroupID:
integer $ModuleID:

Info

access - public

Method getPhrase (line 2319)

Phrase getPhrase( string $PhraseName, [ $PhraseTypeID = 0], [ $LanguageID = DEFAULT_LANGUAGE], integer $PhraseTypeID[optional], integer $LanguageID[optional])

Retrieves Phrase for Phrase specified by PhraseName and PhraseTypeID

Parameters

string $PhraseName:
integer $PhraseTypeID[optional]:
integer $LanguageID[optional]:
$PhraseTypeID:
$LanguageID:

Info

access - public

Method getPhraseTypeIDFromString (line 2368)

integer getPhraseTypeIDFromString( string $String)

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

Parameters

string $String:

Info

access - public

Method getSiblingCollectionContent (line 2395)

CollectionContent[] getSiblingCollectionContent( integer $ID)

Retrieves sibling CollectionContent for CollectionContent specified by $ID

$CollectionID is required whenever $ID = 0

Parameters

integer $ID:

Info

access - public

Method getSubjectArrayFromIDArray (line 2447)

Subject[] getSubjectArrayFromIDArray( integer[] $arrIDs)

Retrieves an array containing Subject objects for each ID in $arrIDs

Parameters

integer[] $arrIDs:

Info

access - public

Method getSubjectIDFromString (line 2505)

integer getSubjectIDFromString( string $String)

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

Parameters

string $String:

Info

access - public

Method getSubjectTypeIDFromString (line 2533)

integer getSubjectTypeIDFromString( string $String)

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

Parameters

string $String:

Info

access - public

Method getUserArrayFromIDArray (line 2561)

User[] getUserArrayFromIDArray( integer[] $arrIDs)

Retrieves an array containing User objects for each ID in $arrIDs

Parameters

integer[] $arrIDs:

Info

access - public

Method getUsergroupArrayFromIDArray (line 2620)

Usergroup[] getUsergroupArrayFromIDArray( integer[] $arrIDs)

Retrieves an array containing Usergroup objects for each ID in $arrIDs

Parameters

integer[] $arrIDs:

Info

access - public

Method getUserIDForLogin (line 2674)

integer getUserIDForLogin( string $Login)

Returns UserID value when passed the user's login string.

Parameters

string $Login:

Info

access - public

Method initialize (line 2703)

void initialize( )

Initializes Archon for use

Info

access - public

Method loadTemplates (line 2802)

array loadTemplates( string $TemplateSet)

Loads Templates according to named Template Set

Parameters

string $TemplateSet:

Info

return - with container types for keys and file contents for container type as values
access - public

Method processPhrase (line 2880)

string processPhrase( string $Phrase)

Processes phrase and translates as necessary.

Parameters

string $Phrase:

Info

access - public

Method searchClassifications (line 2917)

Classification[] searchClassifications( string $SearchQuery, [ $ParentID = NULL], [ $Limit = SEARCH_RESULTS_LIMIT], integer $ParentID[optional], integer $Limit[optional])

Searches the Classification database

Parameters

string $SearchQuery:
integer $ParentID[optional]:
integer $Limit[optional]:
$ParentID:
$Limit:

Info

access - public

Method searchCollections (line 2947)

Collection[] searchCollections( string $SearchQuery, [ $SearchFlags = SEARCH_COLLECTIONS], [ $SubjectID = 0], [ $CreatorID = 0], [ $LanguageID = 0], [ $RepositoryID = 0], [ $LocationID = 0], [ $Range = NULL], [ $Section = NULL], [ $Shelf = NULL], [ $Limit = SEARCH_RESULTS_LIMIT], integer $SearchFlags[optional], integer $SubjectID[optional], integer $CreatorID[optional], integer $LanguageID[optional], integer $RepositoryID[optional], integer $LocationID[optional], string $Range[optional], string $Section[optional], string $Shelf[optional], integer $Limit[optional])

Searches the Collection database

Parameters

string $SearchQuery:
integer $SearchFlags[optional]:
integer $SubjectID[optional]:
integer $CreatorID[optional]:
integer $LanguageID[optional]:
integer $RepositoryID[optional]:
integer $LocationID[optional]:
string $Range[optional]:
string $Section[optional]:
string $Shelf[optional]:
integer $Limit[optional]:
$SearchFlags:
$SubjectID:
$CreatorID:
$LanguageID:
$RepositoryID:
$LocationID:
$Range:
$Section:
$Shelf:
$Limit:

Info

access - public
todo - Search User-defined fields

Method searchCollectionsByClassification (line 3210)

void searchCollectionsByClassification( string $SearchQuery, [ $SearchFlags = SEARCH_COLLECTIONS], [ $SubjectID = 0], [ $CreatorID = 0], [ $LanguageID = 0], [ $RepositoryID = 0], [ $LocationID = 0], [ $Range = NULL], [ $Section = NULL], [ $Shelf = NULL], [ $Limit = SEARCH_RESULTS_LIMIT], integer $SearchFlags[optional], integer $SubjectID[optional], integer $CreatorID[optional], integer $LanguageID[optional], integer $RepositoryID[optional], integer $LocationID[optional], string $Range[optional], string $Section[optional], string $Shelf[optional], integer $Limit[optional])

Searches the CollectionContent database and returns an array of sorted Classification objects that have the matching Collections in the Classifications' Collections[] member variable, and if $SearchContent is true, the matching Content in the Collections' Content member variable.

Parameters

string $SearchQuery:
integer $SearchFlags[optional]:
integer $SubjectID[optional]:
integer $CreatorID[optional]:
integer $LanguageID[optional]:
integer $RepositoryID[optional]:
integer $LocationID[optional]:
string $Range[optional]:
string $Section[optional]:
string $Shelf[optional]:
integer $Limit[optional]:
$SearchFlags:
$SubjectID:
$CreatorID:
$LanguageID:
$RepositoryID:
$LocationID:
$Range:
$Section:
$Shelf:
$Limit:

Info

access - public
todo - Search User-defined fields

Method searchCreators (line 3528)

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

Searches the Creator database

Parameters

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

Info

access - public

Method searchDigitalLibrary (line 3551)

DigitalContent[] searchDigitalLibrary( string $SearchQuery, [ $SearchFlags = SEARCH_DIGITALCONTENT], [ $CollectionID = 0], [ $CollectionContentID = 0], [ $SubjectID = 0], [ $CreatorID = 0], [ $FileTypeID = 0], [ $MediaTypeID = 0], [ $Limit = 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])

Searches the Digital Library database

Parameters

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:

Info

access - public

Method searchFileTypes (line 3654)

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

Searches the FileType database

Parameters

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

Info

access - public

Method searchLanguages (line 3670)

Language[] searchLanguages( string $SearchQuery, [ $Limit = SEARCH_RESULTS_LIMIT], integer $Limit[optional])

Searches the Language database

Parameters

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

Info

access - public

Method searchLevelContainers (line 3512)

LevelContainer[] searchLevelContainers( string $SearchQuery, [ $Limit = SEARCH_RESULTS_LIMIT], integer $Limit[optional])

Searches the LevelContainer database

Parameters

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

Info

access - public

Method searchLocations (line 3686)

Location[] searchLocations( string $SearchQuery, [ $Limit = SEARCH_RESULTS_LIMIT], integer $Limit[optional])

Searches the Location database

Parameters

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

Info

access - public

Method searchMaterialTypes (line 3702)

MaterialType[] searchMaterialTypes( string $SearchQuery, [ $Limit = SEARCH_RESULTS_LIMIT], integer $Limit[optional])

Searches the MaterialType database

Parameters

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

Info

access - public

Method searchPhrases (line 3720)

Phrase[] searchPhrases( string $SearchQuery, [ $PhraseTypeID = 0], [ $LanguageID = DEFAULT_LANGUAGE], [ $Limit = SEARCH_RESULTS_LIMIT], integer $PhraseTypeID[optional], integer $LanguageID[optional], integer $Limit[optional])

Searches the Phrase database

Parameters

string $SearchQuery:
integer $PhraseTypeID[optional]:
integer $LanguageID[optional]:
integer $Limit[optional]:
$PhraseTypeID:
$LanguageID:
$Limit:

Info

access - public

Method searchRepositories (line 3745)

Repository[] searchRepositories( string $SearchQuery, [ $Limit = SEARCH_RESULTS_LIMIT], integer $Limit[optional])

Searches the Repository database

Parameters

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

Info

access - public

Method searchSubjects (line 3763)

Creator[] searchSubjects( string $SearchQuery, [ $ParentID = NULL], [ $SubjectTypeID = 0], [ $Limit = SEARCH_RESULTS_LIMIT], integer $ParentID[optional], integer $SubjectTypeID[optional], integer $Limit[optional])

Searches the Subject database

Parameters

string $SearchQuery:
integer $ParentID[optional]:
integer $SubjectTypeID[optional]:
integer $Limit[optional]:
$ParentID:
$SubjectTypeID:
$Limit:

Info

access - public

Method sendMessageAndRedirect (line 3870)

void sendMessageAndRedirect( string $Message, [string $Location = NULL])

Sends message to user via the message frame and redirects to specified location.

Parameters

string $Message:
string $Location:

Info

access - public

Method traverseClassification (line 3943)

Classification[] traverseClassification( integer $ID)

Returns an array containing Classification objects sorted from root to node

Parameters

integer $ID:

Info

access - public

Method traverseCollectionContent (line 3975)

CollectionContent[] traverseCollectionContent( integer $ID)

Returns an array containing CollectionContent objects sorted from root to node

Parameters

integer $ID:

Info

access - public

Method traverseSubject (line 4007)

Subject[] traverseSubject( integer $ID)

Returns an array containing Subject objects sorted from root to node

Parameters

integer $ID:

Info

access - public

Class Archon

Description

Archon Object Defintion

Class Variables

$ArchonURL = 'http://www.archon.org/' (line 4320)

Data type : string

Contains the URL to The Archon Project website.

$Configuration = NULL (line 4329)

Data type : ArchonConfiguration[]

Contains and array of ArchonConfiguration objects, each of which represents a configuration directive in the Configuration table.

$Copyright = 'Copyright &copy;2006 <a href="http://www.uiuc.edu/">The University of Illinois at Urbana-Champaign</a>' (line 4334)

Data type : string

$Delimiter = '/' (line 4339)

Data type : string

$Disabled = false (line 4349)

Data type : boolean

When this variable is set to true, Archon is disabled to the public.

$Error = NULL (line 4357)

Data type : string

If an error occurs within the API, this value will be set to a text description of the error.

$ProductName = 'Archon' (line 4367)

Data type : string

$ReleaseDate = '2007.01.04' (line 4372)

Data type : string

$Security = NULL (line 4377)

Data type : ArchonSecurity

$TemplateSet = NULL (line 4382)

Data type : array

$Version = '1.10' (line 4389)

Data type : string

Contains the version of the Archon codebase.

Class Constants

Method Detail

Constructor Archon (line 48)

Archon Archon( )

Archon Constructor

Info

Method clearCacheEntry (line 74)

boolean clearCacheEntry( string $Table)

Clears Memory Cache of the entry denoted by $Table

Parameters

Info

Method createConsensusVariable (line 100)

mixed createConsensusVariable( mixed $var1, mixed $var2)

Fully traverses two variables and returns a "consensus" variable

Parameters

Info

Method createFormattedPhrase (line 324)

string createFormattedPhrase( string[] $arrArguments, string $PhraseName, int $PhraseTypeID, [ $LanguageID = DEFAULT_LANGUAGE], int $LanguageID[optional])

Creates a formatted phrase (depreciated)

Parameters

Info

Method createImageThumbnail (line 219)

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

Creates a thumbnail of an image.

Parameters

Info

Method createNumericArrayFromString (line 284)

integer[] createNumericArrayFromString( string $String)

Takes a string representing a range or list of numbers and creates and array containing all numbers the string represents.

Parameters

Info

Method createSearchWordArray (line 357)

string[] createSearchWordArray( string $String)

Creates an array of words and phrases parsed from a query string

Parameters

Info

Method createStringFromCreatorArray (line 423)

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

Creates a formatted string from an array of Creator objects

Parameters

Info

Method createStringFromDigitalContentArray (line 457)

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

Creates a formatted string from an array of DigitalContent objects

Parameters

Info

Method createStringFromLanguageArray (line 492)

string createStringFromLanguageArray( Language[] $arrLanguages, [ $Delimiter = ', '], [ $MakeIntoLink = LINK_NONE], string $Delimiter[optional], integer $MakeIntoLink[optional])

Creates an formatted string from an array of Language objects

$Copyright = 'Copyright ©2006 <a href="http://www.uiuc.edu/">The University of Illinois at Urbana-Champaign</a>' (line 4334)