Class Variables
Summary:
string
$ArchonURL
ArchonConfiguration[]
$Configuration
string
$Copyright
string
$Delimiter
boolean
$Disabled
string
$Error
string
$ProductName
string
$ReleaseDate
array
$TemplateSet
string
$Version
$ArchonURL = 'http://www.archon.org/' (line 4562)
Data type : string
Contains the URL to The Archon Project website.
- access: - public
$Configuration = NULL (line 4571)
Data type : ArchonConfiguration[]
Contains and array of ArchonConfiguration objects, each of which represents a configuration directive in the Configuration table.
- access: - public
$Copyright = 'Copyright ©2007 <a href="http://www.uiuc.edu/">The University of Illinois at Urbana-Champaign</a>' (line 4576)
Data type : string
- access: - public
$Delimiter = '/' (line 4581)
Data type : string
- access: - public
$Disabled = false (line 4591)
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 4599)
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 4609)
Data type : string
- access: - public
$ReleaseDate = '2007.02.02' (line 4614)
Data type : string
- access: - public
$TemplateSet = NULL (line 4624)
Data type : array
- access: - public
$Version = '1.11' (line 4631)
Data type : string
Contains the version of the Archon codebase.
- access: - public
Class Constants
Summary:Method Detail
Summary:
integer|Array
countCollections
([ $Alphabetical = false], [ $ExcludeDisabledCollections = false], [ $RepositoryID = 0], boolean $Alphabetical[optional], boolean $ExcludeDisabledCollections[optional], integer $RepositoryID[optional])
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])
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])
CreatorType[]
getAllCreatorTypes
()
DescRules[]
getAllDescRules
()
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
()
SubjectSource[]
getAllSubjectSources
()
SubjectType[]
getAllSubjectTypes
()
string[]
getAllTemplates
()
Usergroup[]
getAllUsergroups
()
User[]
getAllUsers
()
CollectionContent[]
getChildCollectionContent
(integer $ContentID, [ $CollectionID = 0], integer $CollectionID[optional])
integer
getCollectionContentIDForData
(integer $CollectionID, integer $LevelContainerID, integer $LevelContainerNumber, [ $ParentID = 0], integer $ParentID[optional])
Collection[]
getCollectionsForClassification
(integer $ID, [ $ExcludeDisabledCollections = false], boolean $ExcludeDisabledCollections[optional])
string
getLatestArchonVersion
()
integer
getNextLevelContainerNumber
(integer $CollectionID, integer $LevelContainerID, [ $ParentID = 0], integer $ParentID[optional])
Phrase
getPhrase
(string $PhraseName, [ $PhraseTypeID = 0], [ $LanguageID = DEFAULT_LANGUAGE], integer $PhraseTypeID[optional], integer $LanguageID[optional])
void
initialize
()
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])
Constructor Archon (line
Method clearCacheEntry (line 74)
boolean clearCacheEntry( string $Table)
Clears Memory Cache of the entry denoted by $Table
Parameters
- string $Table:
Info
- access - public
Method countCollections (line 98)
integer|Array countCollections( [ $Alphabetical = false], [ $ExcludeDisabledCollections = false], [ $RepositoryID = 0], boolean $Alphabetical[optional], boolean $ExcludeDisabledCollections[optional], integer $RepositoryID[optional])
Returns the number of Collections 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 Collection SortTitles starting with that character. # represents all collections starting with a number, and * holds the total count of all collections.
Parameters
- boolean $Alphabetical[optional]:
- boolean $ExcludeDisabledCollections[optional]:
- integer $RepositoryID[optional]:
- $Alphabetical:
- $ExcludeDisabledCollections:
- $RepositoryID:
Info
- access - public
Method countCreators (line 173)
integer|Array countCreators( [ $Alphabetical = false], boolean $Alphabetical[optional])
Returns the number of Creators in the database
If $Alphabetical is set to true, an array will be returned with keys of a-z, #, and * each holding the count for Creator Names starting with that character. # represents all collections starting with a number, and * holds the total count of all collections.
Parameters
- boolean $Alphabetical[optional]:
- $Alphabetical:
Info
- access - public
Method countDigitalContent (line 228)
integer|Array countDigitalContent( [ $Alphabetical = false], boolean $Alphabetical[optional])
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.
Parameters
- boolean $Alphabetical[optional]:
- $Alphabetical:
Info
- access - public
Method countSubjects (line 283)
integer|Array countSubjects( [ $Alphabetical = false], boolean $Alphabetical[optional])
Returns the number of Subjects 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 Subject Subjects starting with that character. # represents all collections starting with a number, and * holds the total count of all collections.
Parameters
- boolean $Alphabetical[optional]:
- $Alphabetical:
Info
- access - public
Method createConsensusVariable (line 342)
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 566)
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 461)
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 526)
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 599)
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 665)
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 699)
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 734)
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 771)
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 807)
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 843)
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 878)
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 921)
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 961)
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 1024)
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.
Parameters
- $MakeIntoIndex[optional] $MakeIntoIndex:
Info
- access - public
Method getAllCreatorTypes (line 1069)
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 1086)
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 1110)
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.
Parameters
- $MakeIntoIndex[optional] $MakeIntoIndex:
Info
- access - public
Method getAllEADElements (line 1155)
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 1172)
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 1189)
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 1206)
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 1223)
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 1264)
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 1281)
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 1298)
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 1315)
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 1332)
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 1349)
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 1366)
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 1401)
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 1418)
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 1435)
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 1452)
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 1469)
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 1517)
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.
Parameters
- boolean $MakeIntoIndex[optional]:
- $MakeIntoIndex:
Info
- access - public
Method getAllSubjectsForSubjectTypeID (line 1567)
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 1606)
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 1589)
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 1623)
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 1664)
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 1690)
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 1724)
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 1748)
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 1798)
Subject[] getChildSubjects( integer $ID)
Retrieves child Subjects for Subject specified by $ID
Parameters
- integer $ID:
Info
- access - public
Method getClassificationArrayFromIDArray (line 1821)
Classification[] getClassificationArrayFromIDArray( integer[] $arrIDs)
Retrieves an array containing Classification objects for each ID in $arrIDs
Parameters
- integer[] $arrIDs:
Info
- access - public
Method getCollectionContentArrayFromIDArray (line 1883)
CollectionContent[] getCollectionContentArrayFromIDArray( integer[] $arrIDs)
Retrieves an array containing CollectionContent objects for each ID in $arrIDs
Parameters
- integer[] $arrIDs:
Info
- access - public
Method getCollectionContentIDForData (line 1945)
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 2012)
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 2094)
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 2122)
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 2153)
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 2209)
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 2235)
FileType getFileTypeForExtension( string $Extension)
Returns the appropriate FileType for a specified extension.
Parameters
- string $Extension:
Info
- access - public
Method getLanguageIDFromString (line 2274)
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 2299)
string getLatestArchonVersion( )
Returns the version of the latest of Archon
Info
- access - public
Method getLevelContainerIDFromString (line 2066)
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 2316)
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 2343)
integer getModuleIDFromScript( string $Script)
Returns ModuleID value when passed the module script string.
Parameters
- string $Script:
Info
- access - public
Method getNextLevelContainerNumber (line 2371)
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 2423)
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 2497)
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 2561)
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 2610)
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 2637)
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 2689)
Subject[] getSubjectArrayFromIDArray( integer[] $arrIDs)
Retrieves an array containing Subject objects for each ID in $arrIDs
Parameters
- integer[] $arrIDs:
Info
- access - public
Method getSubjectIDFromString (line 2747)
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 2775)
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 2803)
User[] getUserArrayFromIDArray( integer[] $arrIDs)
Retrieves an array containing User objects for each ID in $arrIDs
Parameters
- integer[] $arrIDs:
Info
- access - public
Method getUsergroupArrayFromIDArray (line 2862)
Usergroup[] getUsergroupArrayFromIDArray( integer[] $arrIDs)
Retrieves an array containing Usergroup objects for each ID in $arrIDs
Parameters
- integer[] $arrIDs:
Info
- access - public
Method getUserIDForLogin (line 2916)
integer getUserIDForLogin( string $Login)
Returns UserID value when passed the user's login string.
Parameters
- string $Login:
Info
- access - public
Method initialize (line 2945)
void initialize( )
Initializes Archon for use
Info
- access - public
Method loadTemplates (line 3044)
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 3122)
string processPhrase( string $Phrase)
Processes phrase and translates as necessary.
Parameters
- string $Phrase:
Info
- access - public
Method searchClassifications (line 3159)
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 3189)
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 3452)
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 3770)
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 3793)
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 3896)
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 3912)
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 3754)
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 3928)
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 3944)
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 3962)
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 3987)
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 4005)
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 4112)
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 4185)
Classification[] traverseClassification( integer $ID)
Returns an array containing Classification objects sorted from root to node
Parameters
- integer $ID:
Info
- access - public
Method traverseCollectionContent (line 4217)
CollectionContent[] traverseCollectionContent( integer $ID)
Returns an array containing CollectionContent objects sorted from root to node
Parameters
- integer $ID:
Info
- access - public
Method traverseSubject (line 4249)
Subject[] traverseSubject( integer $ID)
Returns an array containing Subject objects sorted from root to node
Parameters
- integer $ID:
Info
- access - public