Docs For Class Archon

Description

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

Archon Object Defintion

Class Variables

Summary:

ArchonConfiguration $Configuration

string $Copyright

string $Delimiter

string $Error

string $ProductName

string $ReleaseDate

ArchonSecurity $Security

array $TemplateSet

string $Version

$Configuration = NULL (line 3793)

Data type : ArchonConfiguration

access: - public

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

Data type : string

access: - public

$Delimiter = '/' (line 3811)

Data type : string

access: - public

$Error = NULL (line 3806)

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

Data type : string

access: - public

$ReleaseDate = '2006.08.04' (line 3783)

Data type : string

access: - public

$Security = NULL (line 3798)

Data type : ArchonSecurity

access: - public

$TemplateSet = NULL (line 3816)

Data type : array

access: - public

$Version = '1.00' (line 3778)

Data type : string

access: - public

Class Constants

Summary:

Method Detail

Summary:

Archon Archon ()

void clearCacheEntry ( $Table)

mixed createConsensusVariable (mixed $var1, mixed $var2)

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 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 $SubDelimiter[optional])

string[] getAllAdminStyles ()

Classification[] getAllClassifications ()

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

ContainerType[] getAllContainerTypes ()

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

CreatorType[] getAllCreatorTypes ()

DescRules[] getAllDescRules ()

DLContent[] getAllDLContent ([$MakeIntoIndex[optional] $MakeIntoIndex = false])

EADElement[] getAllEADElements ()

ExtentUnits[] getAllExtentUnits ()

Files[] getAllFiles ()

FileTypes[] getAllFileTypes ()

string[] getAllIncomingFiles ()

Language[] getAllLanguages ()

Location[] getAllLocations ()

MaterialType[] getAllMaterialTypes ()

MediaTypes[] getAllMediaTypes ()

ModuleCategory[] getAllModuleCategories ()

Module[] getAllModules ()

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, [integer $CollectionID = 0])

Subject[] getChildSubjects (integer $ID)

Classification[] getClassificationArrayFromIDArray (integer[] $arrIDs)

CollectionContent[] getCollectionContentArrayFromIDArray (integer[] $arrIDs)

integer getCollectionContentIDForData (integer $CollectionID, integer $ContainerTypeID, integer $ContainerNumber, [ $ParentID = 0], integer $ParentID[optional])

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

integer getContainerTypeIDFromString (string $String)

integer getCreatorIDFromString (string $String)

integer getCreatorTypeIDFromString (string $String)

array getExtentForLocation ( $LocationID, int $CollectionID)

integer getExtentUnitsIDFromString (string $String)

FileType getFileTypeForExtension (string $Extension)

integer getLanguageIDFromString (string $String)

string getLatestArchonVersion ()

integer getMaterialTypeIDFromString (string $String)

integer getModuleIDFromScript (string $Script)

integer getNextContainerNumber (integer $CollectionID, integer $ContainerTypeID, [ $ParentID = 0], integer $ParentID[optional])

integer getPermissionsForUser (integer $UserID, integer $ModuleID)

integer getPermissionsForUsergroup (integer $UsergroupID, integer $ModuleID)

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

unknown loadTemplates (unknown_type $TemplateSet)

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

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

Classification[] searchCollectionsByClassification (string $SearchQuery, [ $SearchContent = false], [ $SubjectID = 0], [ $CreatorID = 0], [ $LanguageID = 0], [ $RepositoryID = 0], [ $LocationID = 0], [ $Range = NULL], [ $Section = NULL], [ $Shelf = NULL], [ $Limit = SEARCH_RESULTS_LIMIT], boolean $SearchContent[optional], integer $Limit[optional], integer $RepositoryID[optional], integer $LocationID[optional], string $Range[optional], string $Section[optional], string $Shelf[optional])

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

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

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

MaterialType[] searchMaterialTypes (string $SearchQuery, [ $Limit = SEARCH_RESULTS_LIMIT], 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 $Limit[optional])

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

Classification[] traverseClassification (integer $ID)

CollectionContent[] traverseCollectionContent (integer $ID)

Subject[] traverseSubject (integer $ID)

Constructor Archon (line 42)

Archon Archon( )

Info

access - public

Method clearCacheEntry (line 62)

void clearCacheEntry( $Table)

Parameters

$Table:

Info

access - public

Method createConsensusVariable (line 88)

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 createImageThumbnail (line 251)

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

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

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

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

Creates an formatted string from an array of Creator objects

Parameters

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

Info

access - public

Method createStringFromLanguageArray (line 412)

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

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

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

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

Creates an formatted string from an array of UserField objects

Parameters

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

Info

access - public

Method getAllAdminStyles (line 556)

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

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

Collection[] getAllCollections( [ $MakeIntoIndex = false], [ $ExcludeDisabledCollections = false], [ $RepositoryID = 0], boolean $ExcludeDisabledCollections[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 $ExcludeDisabledCollections[optional]:
$MakeIntoIndex:
$ExcludeDisabledCollections:
$RepositoryID:

Info

access - public

Method getAllContainerTypes (line 692)

ContainerType[] getAllContainerTypes( )

Retrieves all Container Types from the database

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

Info

access - public

Method getAllCreators (line 717)

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

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

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 getAllDLContent (line 803)

DLContent[] getAllDLContent( [$MakeIntoIndex[optional] $MakeIntoIndex = false])

Retrieves all Digital Content from the database

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

Parameters

$MakeIntoIndex[optional] $MakeIntoIndex:

Info

access - public

Method getAllEADElements (line 848)

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

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

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

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

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

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 getAllLocations (line 974)

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

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

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

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

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 getAllRepositories (line 1077)

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

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

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

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

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

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

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

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

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

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

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

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

Retrieves child CollectionContent for CollectionContent specified by $ContentID

$CollectionID is required whenever $ContentID = 0

Parameters

integer $ContentID:
integer $CollectionID:

Info

Method getChildSubjects (line 1440)

Subject[] getChildSubjects( integer $ID)

Retrieves child Subjects for Subject specified by $ID

Parameters

integer $ID:

Info

access - public

Method getClassificationArrayFromIDArray (line 1463)

Classification[] getClassificationArrayFromIDArray( integer[] $arrIDs)

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

Parameters

integer[] $arrIDs:

Info

Method getCollectionContentArrayFromIDArray (line 1525)

CollectionContent[] getCollectionContentArrayFromIDArray( integer[] $arrIDs)

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

Parameters

integer[] $arrIDs:

Info

Method getCollectionContentIDForData (line 1587)

integer getCollectionContentIDForData( integer $CollectionID, integer $ContainerTypeID, integer $ContainerNumber, [ $ParentID = 0], integer $ParentID[optional])

Returns CollectionContentID when passed the CollectionID, ContainerTypeID, ContainerNumber, and ParentID

Parameters

integer $CollectionID:
integer $ContainerTypeID:
integer $ContainerNumber:
integer $ParentID[optional]:
$ParentID:

Info

access - public

Method getCollectionsForClassification (line 1624)

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

Method getContainerTypeIDFromString (line 1678)

integer getContainerTypeIDFromString( string $String)

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

Parameters

string $String:

Info

access - public

Method getCreatorIDFromString (line 1706)

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

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

array getExtentForLocation( $LocationID, int $CollectionID)

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 $CollectionID:
$LocationID:

Info

access - public

Method getExtentUnitsIDFromString (line 1821)

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

FileType getFileTypeForExtension( string $Extension)

Returns the appropriate FileType for a specified extension.

Parameters

string $Extension:

Info

access - public

Method getLanguageIDFromString (line 1886)

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

string getLatestArchonVersion( )

Returns the version of the latest of Archon

Info

access - public

Method getMaterialTypeIDFromString (line 1914)

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

integer getModuleIDFromScript( string $Script)

Returns ModuleID value when passed the module script string.

Parameters

string $Script:

Info

access - public

Method getNextContainerNumber (line 1983)

integer getNextContainerNumber( integer $CollectionID, integer $ContainerTypeID, [ $ParentID = 0], integer $ParentID[optional])

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

Parameters

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

Info

access - public

Method getPermissionsForUser (line 2017)

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

integer getPermissionsForUsergroup( integer $UsergroupID, integer $ModuleID)

Retrives permissions for a specified usergroup and module

Parameters

integer $UsergroupID:
integer $ModuleID:

Info

access - public

Method getSiblingCollectionContent (line 2131)

CollectionContent[] getSiblingCollectionContent( integer $ID)

Retrieves sibling CollectionContent for CollectionContent specified by $ID

$CollectionID is required whenever $ID = 0

Parameters

integer $ID:

Info

Method getSubjectArrayFromIDArray (line 2183)

Subject[] getSubjectArrayFromIDArray( integer[] $arrIDs)

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

Parameters

integer[] $arrIDs:

Info

Method getSubjectIDFromString (line 2241)

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

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

User[] getUserArrayFromIDArray( integer[] $arrIDs)

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

Parameters

integer[] $arrIDs:

Info

Method getUsergroupArrayFromIDArray (line 2356)

Usergroup[] getUsergroupArrayFromIDArray( integer[] $arrIDs)

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

Parameters

integer[] $arrIDs:

Info

Method getUserIDForLogin (line 2410)

integer getUserIDForLogin( string $Login)

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

Parameters

string $Login:

Info

access - public

Method initialize (line 2435)

void initialize( )

Info

access - public

Method loadTemplates (line 2487)

unknown loadTemplates( unknown_type $TemplateSet)

Enter description here...

Parameters

unknown_type $TemplateSet:

Info

Method searchClassifications (line 2567)

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

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

Searches the Collection database

Parameters

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

Info

access - public

Method searchCollectionsByClassification (line 2816)

Classification[] searchCollectionsByClassification( string $SearchQuery, [ $SearchContent = false], [ $SubjectID = 0], [ $CreatorID = 0], [ $LanguageID = 0], [ $RepositoryID = 0], [ $LocationID = 0], [ $Range = NULL], [ $Section = NULL], [ $Shelf = NULL], [ $Limit = SEARCH_RESULTS_LIMIT], boolean $SearchContent[optional], integer $Limit[optional], integer $RepositoryID[optional], integer $LocationID[optional], string $Range[optional], string $Section[optional], string $Shelf[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:
boolean $SearchContent[optional]:
integer $Limit[optional]:
integer $RepositoryID[optional]:
integer $LocationID[optional]:
string $Range[optional]:
string $Section[optional]:
string $Shelf[optional]:
$SearchContent:
$SubjectID:
$CreatorID:
$LanguageID:
$RepositoryID:
$LocationID:
$Range:
$Section:
$Shelf:
$Limit:

Info

access - public
todo - Search User-defined fields....

Method searchCreators (line 3081)

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

Creator[] searchDigitalLibrary( string $SearchQuery, [ $CollectionID = 0], [ $CollectionContentID = 0], [ $SubjectID = 0], [ $CreatorID = 0], [ $GenreID = 0], [ $FileTypeID = 0], [ $MediaTypeID = 0], [ $Limit = SEARCH_RESULTS_LIMIT], integer $Limit[optional])

Searches the Digital Library database

Parameters

string $SearchQuery:
integer $Limit[optional]:
$CollectionID:
$CollectionContentID:
$SubjectID:
$CreatorID:
$GenreID:
$FileTypeID:
$MediaTypeID:
$Limit:

Info

access - public

Method searchFileTypes (line 3169)

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

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 searchLocations (line 3201)

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

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 searchRepositories (line 3233)

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

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

Searches the Subject database

Parameters

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

Info

access - public

Method sendMessageAndRedirect (line 3356)

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

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

Parameters

string $msg:
string $location:
$Message:
$Location:

Info

access - public

Method traverseClassification (line 3420)

Classification[] traverseClassification( integer $ID)

Returns an array containing Classification objects sorted from root to node

Parameters

integer $ID:

Info

access - public

Method traverseCollectionContent (line 3452)

CollectionContent[] traverseCollectionContent( integer $ID)

Returns an array containing CollectionContent objects sorted from root to node

Parameters

integer $ID:

Info

access - public

Method traverseSubject (line 3484)

Subject[] traverseSubject( integer $ID)

Returns an array containing Subject objects sorted from root to node

Parameters

integer $ID:

Class Archon

Description

Archon Object Defintion

Class Variables

$Configuration = NULL (line 3793)

Data type : ArchonConfiguration

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

Data type : string

$Delimiter = '/' (line 3811)

Data type : string

$Error = NULL (line 3806)

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

Data type : string

$ReleaseDate = '2006.08.04' (line 3783)

Data type : string

$Security = NULL (line 3798)

Data type : ArchonSecurity

$TemplateSet = NULL (line 3816)

Data type : array

$Version = '1.00' (line 3778)

Data type : string

Class Constants

Method Detail

Constructor Archon (line 42)

Archon Archon( )

Info

Method clearCacheEntry (line 62)

void clearCacheEntry( $Table)

Parameters

Info

Method createConsensusVariable (line 88)

mixed createConsensusVariable( mixed $var1, mixed $var2)

Fully traverses two variables and returns a "consensus" variable

Parameters

Info

Method createImageThumbnail (line 251)

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

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

string[] createSearchWordArray( string $String)

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

Parameters

Info

Method createStringFromCreatorArray (line 377)

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

Creates an formatted string from an array of Creator objects

Parameters

Info

Method createStringFromLanguageArray (line 412)

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

Info

Method createStringFromLocationEntryArray (line 449)

Creates an formatted string from an array of LocationEntry objects

Parameters

Info

Method createStringFromSubjectArray (line 485)

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

Info

Method createStringFromUserFieldArray (line 521)

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

Creates an formatted string from an array of UserField objects

Parameters

Info

Method getAllAdminStyles (line 556)

string[] getAllAdminStyles( )

Returns any array of installed styles.

Info

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