Docs For Class Collections

Class Collections_Archon

Description

abstract:

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

Variable Summary

Repository $Repository

Method Summary

integer|Array countCollections ([ $Alphabetical = false], [ $ExcludeDisabledCollections = false], [ $RepositoryID = 0], boolean $Alphabetical[optional], boolean $ExcludeDisabledCollections[optional], integer $RepositoryID[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 createStringFromUserFieldArray (UserField[] $arrUserFields, [ $Delimiter = ', '], [ $MakeIntoLink = LINK_NONE], [ $ConcatinateTitles = true], string $Delimiter[optional], integer $MakeIntoLink[optional], string $ConcatinateTitles[optional])

Classification[] getAllClassifications ()

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

DescriptiveRules[] getAllDescriptiveRules ()

EADElement[] getAllEADElements ()

ExtentUnit[] getAllExtentUnits ()

LevelContainer[] getAllLevelContainers ()

Location[] getAllLocations ()

MaterialType[] getAllMaterialTypes ()

Repository[] getAllRepositories ()

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

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

Classification[] getClassificationArrayFromIDArray (integer[] $arrIDs)

unknown getClassificationIDForNumber (unknown_type $RecordGroupNumber)

CollectionContent[] getCollectionContentArrayFromIDArray (integer[] $arrIDs)

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

integer getCollectionIDForNumber (string $RecordSeriesNumber)

Collection[] getCollectionsForChar (string $Char, [ $ExcludeDisabledCollections = false], [ $RepositoryID = 0], boolean $ExcludeDisabledCollections[optional], integer $RepositoryID[optional])

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

integer getEADElementIDFromString (string $String)

array getExtentForLocation (int $LocationID)

integer getExtentUnitIDFromString (string $String)

integer getLevelContainerIDFromString (string $String)

integer getMaterialTypeIDFromString (string $String)

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

CollectionContent[] getSiblingCollectionContent (integer $ID)

void initialize ()

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

Classification[] searchCollectionContent (string $SearchQuery, [ $SearchFlags = SEARCH_COLLECTIONCONTENT], [ $CollectionID = 0], [ $RepositoryID = 0], [ $ParentID = NULL], [ $Limit = CONFIG_CORE_SEARCH_RESULTS_LIMIT], [ $Offset = 0], integer $ParentID[optional], integer $Limit[optional], integer $Offset[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 = CONFIG_CORE_SEARCH_RESULTS_LIMIT], [ $Offset = 0], 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], integer $Offset[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 = CONFIG_CORE_SEARCH_RESULTS_LIMIT], [ $Offset = 0], 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], integer $Offset[optional])

ExtentUnit[] searchExtentUnits (string $SearchQuery, [ $Limit = CONFIG_CORE_SEARCH_RESULTS_LIMIT], [ $Offset = 0], integer $Limit[optional], integer $Offset[optional])

LevelContainer[] searchLevelContainers (string $SearchQuery, [ $Limit = CONFIG_CORE_SEARCH_RESULTS_LIMIT], [ $Offset = 0], integer $Limit[optional], integer $Offset[optional])

Location[] searchLocations (string $SearchQuery, [ $Limit = CONFIG_CORE_SEARCH_RESULTS_LIMIT], [ $Offset = 0], integer $Limit[optional], integer $Offset[optional])

MaterialType[] searchMaterialTypes (string $SearchQuery, [ $Limit = CONFIG_CORE_SEARCH_RESULTS_LIMIT], [ $Offset = 0], integer $Limit[optional], integer $Offset[optional])

Repository[] searchRepositories (string $SearchQuery, [ $Limit = CONFIG_CORE_SEARCH_RESULTS_LIMIT], [ $Offset = 0], integer $Limit[optional], integer $Offset[optional])

boolean shiftLevelContainerNumbers ( &$arrCollectionContent, integer $ShiftDirection, integer $ShiftAmount, CollectionContent[] $arrCollectionContent)

Classification[] traverseClassification (integer $ID)

CollectionContent[] traverseCollectionContent (integer $ID)

Variables

Repository $Repository = NULL (line 2240)

Repository object containing the default repository (unless specified otherwise by setrepositoryid

access: public

Methods

countCollections (line 17)

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.

access: public

integer|Array countCollections ([ $Alphabetical = false], [ $ExcludeDisabledCollections = false], $RepositoryID, boolean $Alphabetical[optional], boolean $ExcludeDisabledCollections[optional], integer $RepositoryID[optional])

boolean $Alphabetical[optional]
boolean $ExcludeDisabledCollections[optional]
integer $RepositoryID[optional]
$Alphabetical
$ExcludeDisabledCollections
$RepositoryID

createStringFromLocationEntryArray (line 89)

Creates an formatted string from an array of LocationEntry objects

access: public

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

createStringFromUserFieldArray (line 125)

Creates an formatted string from an array of UserField objects

access: public

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

getAllClassifications (line 162)

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.

access: public

Classification[] getAllClassifications ()

getAllCollections (line 205)

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.

access: public

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

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

getAllDescriptiveRules (line 260)

Retrieves all Descriptive Rules from the database

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

access: public

DescriptiveRules[] getAllDescriptiveRules ()

getAllEADElements (line 277)

Retrieves all EAD Elements from the database

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

access: public

EADElement[] getAllEADElements ()

getAllExtentUnits (line 294)

Retrieves all Extent Units from the database

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

access: public

ExtentUnit[] getAllExtentUnits ()

getAllLevelContainers (line 311)

Retrieves all Level/Containers from the database

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

access: public

LevelContainer[] getAllLevelContainers ()

getAllLocations (line 328)

Retrieves all Locations from the database

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

access: public

Location[] getAllLocations ()

getAllMaterialTypes (line 345)

Retrieves all Material Types from the database

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

access: public

MaterialType[] getAllMaterialTypes ()

getAllRepositories (line 362)

Retrieves all Repositories from the database

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

access: public

Repository[] getAllRepositories ()

getChildClassifications (line 378)

Retrieves child Classifications for Classification specified by $ID

access: public

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

integer $ID[optional]
$ID

getChildCollectionContent (line 410)

Retrieves child CollectionContent for CollectionContent specified by $ContentID

$CollectionID is required whenever $ContentID = 0

access: public

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

integer $ContentID
integer $CollectionID[optional]
$CollectionID

getClassificationArrayFromIDArray (line 458)

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

access: public

Classification[] getClassificationArrayFromIDArray (integer[] $arrIDs)

integer[] $arrIDs

getClassificationIDForNumber (line 518)

Returns Classification ID for given Record Group Number.

Classifications in the number are separated by '/'.

access: public

unknown getClassificationIDForNumber (unknown_type $RecordGroupNumber)

unknown_type $RecordGroupNumber

getCollectionContentArrayFromIDArray (line 565)

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

access: public

CollectionContent[] getCollectionContentArrayFromIDArray (integer[] $arrIDs)

integer[] $arrIDs

getCollectionContentIDFromData (line 625)

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

access: public

integer getCollectionContentIDFromData (integer $CollectionID, integer $LevelContainerID, integer $LevelContainerNumber, $ParentID, integer $ParentID[optional])

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

getCollectionIDForNumber (line 689)

Returns CollectionID for given Record Series Number.

Classifications and Collection Identifiers are separated by '/'s in the number.

access: public

integer getCollectionIDForNumber (string $RecordSeriesNumber)

string $RecordSeriesNumber

getCollectionsForChar (line 752)

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

access: public

Collection[] getCollectionsForChar (string $Char, [ $ExcludeDisabledCollections = false], $RepositoryID, boolean $ExcludeDisabledCollections[optional], integer $RepositoryID[optional])

string $Char
boolean $ExcludeDisabledCollections[optional]
integer $RepositoryID[optional]
$ExcludeDisabledCollections
$RepositoryID

getCollectionsForClassification (line 805)

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

access: public

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

integer $ID
boolean $ExcludeDisabledCollections[optional]
$ExcludeDisabledCollections

getEADElementIDFromString (line 891)

Returns EADElementID value when passed the string value for an EAD element type.

access: public

integer getEADElementIDFromString (string $String)

string $String

getExtentForLocation (line 920)

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 ExtentUnit ExtentUnit

access: public

array getExtentForLocation (int $LocationID)

int $LocationID

getExtentUnitIDFromString (line 974)

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

access: public

integer getExtentUnitIDFromString (string $String)

string $String

getLevelContainerIDFromString (line 866)

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

access: public

integer getLevelContainerIDFromString (string $String)

string $String

getMaterialTypeIDFromString (line 1000)

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

access: public

integer getMaterialTypeIDFromString (string $String)

string $String

getNextLevelContainerNumber (line 1026)

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

access: public

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

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

getSiblingCollectionContent (line 1077)

Retrieves sibling CollectionContent for CollectionContent specified by $ID

$CollectionID is required whenever $ID = 0

access: public

CollectionContent[] getSiblingCollectionContent (integer $ID)

integer $ID

initialize (line 1125)

Initializes Archon for use

access: public

void initialize ()

searchClassifications (line 1162)

Searches the Classification database

access: public

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

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

searchCollectionContent (line 1192)

Searches the CollectionContent database

access: public

Classification[] searchCollectionContent (string $SearchQuery, [ $SearchFlags = SEARCH_COLLECTIONCONTENT], $CollectionID, $RepositoryID, [ $ParentID = NULL], [ $Limit = CONFIG_CORE_SEARCH_RESULTS_LIMIT], $Offset, integer $ParentID[optional], integer $Limit[optional], integer $Offset[optional])

string $SearchQuery
integer $ParentID[optional]
integer $Limit[optional]
integer $Offset[optional]
$SearchFlags
$CollectionID
$RepositoryID
$ParentID
$Limit
$Offset

searchCollections (line 1338)

Searches the Collection database

access: public
todo: Search User-defined fields

Collection[] searchCollections (string $SearchQuery, [ $SearchFlags = SEARCH_COLLECTIONS], $SubjectID, $CreatorID, $LanguageID, $RepositoryID, $LocationID, [ $Range = NULL], [ $Section = NULL], [ $Shelf = NULL], [ $Limit = CONFIG_CORE_SEARCH_RESULTS_LIMIT], $Offset, 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], integer $Offset[optional])

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]
integer $Offset[optional]
$SearchFlags
$SubjectID
$CreatorID
$LanguageID
$RepositoryID
$LocationID
$Range
$Section
$Shelf
$Limit
$Offset

searchCollectionsByClassification (line 1645)

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.

access: public
todo: Search User-defined fields

void searchCollectionsByClassification (string $SearchQuery, [ $SearchFlags = SEARCH_COLLECTIONS], $SubjectID, $CreatorID, $LanguageID, $RepositoryID, $LocationID, [ $Range = NULL], [ $Section = NULL], [ $Shelf = NULL], [ $Limit = CONFIG_CORE_SEARCH_RESULTS_LIMIT], $Offset, 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], integer $Offset[optional])

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]
integer $Offset[optional]
$SearchFlags
$SubjectID
$CreatorID
$LanguageID
$RepositoryID
$LocationID
$Range
$Section
$Shelf
$Limit
$Offset

searchExtentUnits (line 2005)

Searches the ExtentUnit database

access: public

ExtentUnit[] searchExtentUnits (string $SearchQuery, [ $Limit = CONFIG_CORE_SEARCH_RESULTS_LIMIT], $Offset, integer $Limit[optional], integer $Offset[optional])

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

searchLevelContainers (line 2022)

Searches the LevelContainer database

access: public

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

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

searchLocations (line 2039)

Searches the Location database

access: public

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

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

searchMaterialTypes (line 2056)

Searches the MaterialType database

access: public

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

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

searchRepositories (line 2073)

Searches the Repository database

access: public

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

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

shiftLevelContainerNumbers (line 2089)

Bulk renumbering of level container numbers

access: public

boolean shiftLevelContainerNumbers ( &$arrCollectionContent, integer $ShiftDirection, integer $ShiftAmount, CollectionContent[] $arrCollectionContent)

CollectionContent[] $arrCollectionContent
integer $ShiftDirection
integer $ShiftAmount
&$arrCollectionContent

traverseClassification (line 2177)

Returns an array containing Classification objects sorted from root to node

access: public

Classification[] traverseClassification (integer $ID)

integer $ID

traverseCollectionContent (line 2209)

Returns an array containing CollectionContent objects sorted from root to node

access: public

CollectionContent[] traverseCollectionContent (integer $ID)

integer $ID

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