Docs For Class Collections

Description

Located in File: /packages/collections/lib/core/archon.inc.php

abstract: -

Class Variables

Summary:

Repository $Repository

$Repository = NULL (line 1917)

Data type : Repository

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

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

CollectionContent[] getCollectionContentArrayFromIDArray (integer[] $arrIDs)

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

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], 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 = CONFIG_CORE_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 = CONFIG_CORE_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])

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

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

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

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

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

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

Classification[] traverseClassification (integer $ID)

CollectionContent[] traverseCollectionContent (integer $ID)

Method countCollections (line 17)

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 createStringFromLocationEntryArray (line 89)

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 createStringFromUserFieldArray (line 125)

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 getAllClassifications (line 162)

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

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 getAllDescriptiveRules (line 257)

DescriptiveRules[] getAllDescriptiveRules( )

Retrieves all Descriptive Rules from the database

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

Info

access - public

Method getAllEADElements (line 274)

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

ExtentUnit[] getAllExtentUnits( )

Retrieves all Extent Units from the database

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

Info

access - public

Method getAllLevelContainers (line 308)

LevelContainer[] getAllLevelContainers( )

Retrieves all Level/Containers from the database

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

Info

access - public

Method getAllLocations (line 325)

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

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

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 getChildClassifications (line 375)

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

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 getClassificationArrayFromIDArray (line 447)

Classification[] getClassificationArrayFromIDArray( integer[] $arrIDs)

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

Parameters

integer[] $arrIDs:

Info

access - public

Method getCollectionContentArrayFromIDArray (line 507)

CollectionContent[] getCollectionContentArrayFromIDArray( integer[] $arrIDs)

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

Parameters

integer[] $arrIDs:

Info

access - public

Method getCollectionContentIDFromData (line 567)

integer getCollectionContentIDFromData( 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 getCollectionsForChar (line 632)

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

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

Parameters

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

Info

access - public

Method getCollectionsForClassification (line 685)

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 getEADElementIDFromString (line 762)

integer getEADElementIDFromString( string $String)

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

Parameters

string $String:

Info

access - public

Method getExtentForLocation (line 791)

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

Parameters

int $LocationID:

Info

access - public

Method getExtentUnitIDFromString (line 845)

integer getExtentUnitIDFromString( string $String)

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

Parameters

string $String:

Info

access - public

Method getLevelContainerIDFromString (line 737)

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

integer getMaterialTypeIDFromString( string $String)

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

Parameters

string $String:

Info

access - public

Method getNextLevelContainerNumber (line 897)

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 getSiblingCollectionContent (line 948)

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 initialize (line 996)

void initialize( )

Initializes Archon for use

Info

access - public

Method searchClassifications (line 1032)

Classification[] searchClassifications( string $SearchQuery, [ $ParentID = NULL], [ $Limit = CONFIG_CORE_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 1062)

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], 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 1350)

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], 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 searchExtentUnits (line 1686)

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

Searches the ExtentUnit database

Parameters

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

Info

access - public

Method searchLevelContainers (line 1702)

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

Searches the LevelContainer database

Parameters

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

Info

access - public

Method searchLocations (line 1718)

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

Searches the Location database

Parameters

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

Info

access - public

Method searchMaterialTypes (line 1734)

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

Searches the MaterialType database

Parameters

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

Info

access - public

Method searchRepositories (line 1750)

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

Searches the Repository database

Parameters

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

Info

access - public

Method shiftLevelContainerNumbers (line 1766)

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

Bulk renumbering of level container numbers

Parameters

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

Info

access - public

Method traverseClassification (line 1854)

Classification[] traverseClassification( integer $ID)

Returns an array containing Classification objects sorted from root to node

Parameters

integer $ID:

Info

access - public

Method traverseCollectionContent (line 1886)

CollectionContent[] traverseCollectionContent( integer $ID)

Returns an array containing CollectionContent objects sorted from root to node

Parameters

integer $ID:

Info

access - public

Class Collections_Archon

Description

Class Variables

$Repository = NULL (line 1917)

Data type : Repository

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

Class Constants

Method Detail

Method countCollections (line 17)

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

Parameters

Info

Method createStringFromLocationEntryArray (line 89)

Creates an formatted string from an array of LocationEntry objects

Parameters

Info

Method createStringFromUserFieldArray (line 125)

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

Info

Method getAllClassifications (line 162)

Classification[] getAllClassifications( )

Retrieves all Classifications from the database

Info

Method getAllCollections (line 202)

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

Retrieves all Collections from the database

Parameters

Info

Method getAllDescriptiveRules (line 257)

DescriptiveRules[] getAllDescriptiveRules( )

Retrieves all Descriptive Rules from the database

Info

Method getAllEADElements (line 274)

EADElement[] getAllEADElements( )

Retrieves all EAD Elements from the database

Info

Method getAllExtentUnits (line 291)

ExtentUnit[] getAllExtentUnits( )

Retrieves all Extent Units from the database

Info

Method getAllLevelContainers (line 308)

LevelContainer[] getAllLevelContainers( )

Retrieves all Level/Containers from the database

Info

Method getAllLocations (line 325)

Location[] getAllLocations( )

Retrieves all Locations from the database

Info

Method getAllMaterialTypes (line 342)

MaterialType[] getAllMaterialTypes( )

Retrieves all Material Types from the database

Info

Method getAllRepositories (line 359)

Repository[] getAllRepositories( )

Retrieves all Repositories from the database

Info

Method getChildClassifications (line 375)

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

Retrieves child Classifications for Classification specified by $ID

Parameters

Info

Method getChildCollectionContent (line 399)

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

Retrieves child CollectionContent for CollectionContent specified by $ContentID

Parameters

Info

Method getClassificationArrayFromIDArray (line 447)

Classification[] getClassificationArrayFromIDArray( integer[] $arrIDs)

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

Parameters

Info

Method getCollectionContentArrayFromIDArray (line 507)

CollectionContent[] getCollectionContentArrayFromIDArray( integer[] $arrIDs)

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

Parameters

Info

Method getCollectionContentIDFromData (line 567)