Docs For Class Collection

Description

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

Collection Object Definition

Class Variables

Summary:

string $AccessRestrictions

string $AccrualInfo

string $AcquisitionDate

string $AcquisitionDateDay

string $AcquisitionDateMonth

string $AcquisitionDateYear

string $AcquisitionMethod

string $AcquisitionSource

string $AltExtentStatement

string $AppraisalInfo

string $Arrangement

Classification $Classification

integer $ClassificationID

string $CollectionIdentifier

CollectionContent[] $Content

Creator[] $Creators

string $CustodialHistory

DescRules $DescRules

integer $DescRulesID

DigitalContent[] $DigitalContent

bit $Enabled

string $Extent

ExtentUnits $ExtentUnits

integer $ExtentUnitsID

string $FindingAidAuthor

Language $FindingLanguage

integer $FindingLanguageID

integer $ID

string $InclusiveDates

Language[] $Languages

LocationEntry[] $LocationEntries

MaterialType $MaterialType

integer $MaterialTypeID

string $NormalDateBegin

string $NormalDateEnd

string $OrigCopiesNote

string $OrigCopiesURL

string $OtherNote

string $OtherURL

string $PhysicalAccess

string $PredominantDates

string $PreferredCitation

Creator $PrimaryCreator

string $ProcessingInfo

string $PublicationDate

string $PublicationDateDay

string $PublicationDateMonth

string $PublicationDateYear

string $PublicationNote

string $RelatedMaterials

string $RelatedMaterialsURL

string $RelatedPublications

Repository $Repository

integer $RepositoryID

string $RevisionHistory

string $Scope

string $SeparatedMaterials

string $SortTitle

Subject[] $Subjects

string $TechnicalAccess

string $TemplateSet

string $Title

string $UseRestrictions

$AccessRestrictions = NULL (line 2012)

Data type : string

access: - public

$AccrualInfo = NULL (line 2040)

Data type : string

access: - public

$AcquisitionDate = NULL (line 2034)

Data type : string

Format: YYYYMMDD

access: - public

$AcquisitionDateDay (line 2104)

Data type : string

access: - public

$AcquisitionDateMonth (line 2101)

Data type : string

access: - public

$AcquisitionDateYear (line 2107)

Data type : string

access: - public

$AcquisitionMethod = NULL (line 2027)

Data type : string

access: - public

$AcquisitionSource = NULL (line 2024)

Data type : string

access: - public

$AltExtentStatement = NULL (line 2009)

Data type : string

access: - public

$AppraisalInfo = NULL (line 2037)

Data type : string

access: - public

$Arrangement = NULL (line 2003)

Data type : string

access: - public

$Classification = NULL (line 2173)

Data type : Classification

access: - public

$ClassificationID = 0 (line 1962)

Data type : integer

access: - public

$CollectionIdentifier = NULL (line 1967)

Data type : string

access: - public

$Content = array() (line 2128)

Data type : CollectionContent[]

Array containing Content for Collection

access: - public

$Creators = array() (line 2142)

Data type : Creator[]

Array containing Creators for Collection

access: - public

$CustodialHistory = NULL (line 2043)

Data type : string

access: - public

$DescRules = NULL (line 2193)

Data type : DescRules

Descriptive Rules Used for the Finding Aid

access: - public

$DescRulesID = 0 (line 2073)

Data type : integer

access: - public

$DigitalContent = array() (line 2135)

Data type : DigitalContent[]

Array containing DigitalContent for Collection

access: - public

$Enabled = 1 (line 1956)

Data type : bit

access: - public

$Extent = NULL (line 1991)

Data type : string

access: - public

$ExtentUnits = NULL (line 2176)

Data type : ExtentUnits

access: - public

$ExtentUnitsID = 0 (line 1994)

Data type : integer

access: - public

$FindingAidAuthor = NULL (line 1988)

Data type : string

access: - public

$FindingLanguage = NULL (line 2186)

Data type : Language

Language of the Finding Aid

access: - public

$FindingLanguageID = 0 (line 2092)

Data type : integer

access: - public

$ID = 0 (line 1953)

Data type : integer

access: - public

$InclusiveDates = NULL (line 1976)

Data type : string

access: - public

$Languages = array() (line 2163)

Data type : Language[]

Array containing Languages for Collection

access: - public

$LocationEntries = array() (line 2156)

Data type : LocationEntry[]

Array containing Location Entries for Collection

access: - public

$MaterialType = NULL (line 2179)

Data type : MaterialType

access: - public

$MaterialTypeID = 0 (line 2006)

Data type : integer

access: - public

$NormalDateBegin = NULL (line 1982)

Data type : string

access: - public

$NormalDateEnd = NULL (line 1985)

Data type : string

access: - public

$OrigCopiesNote = NULL (line 2046)

Data type : string

access: - public

$OrigCopiesURL = NULL (line 2049)

Data type : string

access: - public

$OtherNote = NULL (line 2067)

Data type : string

access: - public

$OtherURL = NULL (line 2070)

Data type : string

access: - public

$PhysicalAccess = NULL (line 2018)

Data type : string

access: - public

$PredominantDates = NULL (line 1979)

Data type : string

access: - public

$PreferredCitation = NULL (line 2064)

Data type : string

access: - public

$PrimaryCreator = NULL (line 2201)

Data type : Creator

Creator Object of the Primary Creator for Collection

access: - public

$ProcessingInfo = NULL (line 2076)

Data type : string

access: - public

$PublicationDate = NULL (line 2086)

Data type : string

Format: YYYYMMDD

access: - public

$PublicationDateDay (line 2113)

Data type : string

access: - public

$PublicationDateMonth (line 2110)

Data type : string

access: - public

$PublicationDateYear (line 2116)

Data type : string

access: - public

$PublicationNote = NULL (line 2089)

Data type : string

access: - public

$RelatedMaterials = NULL (line 2052)

Data type : string

access: - public

$RelatedMaterialsURL = NULL (line 2055)

Data type : string

access: - public

$RelatedPublications = NULL (line 2058)

Data type : string

access: - public

$Repository = NULL (line 2170)

Data type : Repository

Repository where the Collection is stored

access: - public

$RepositoryID = 0 (line 1959)

Data type : integer

access: - public

$RevisionHistory = NULL (line 2079)

Data type : string

access: - public

$Scope = NULL (line 2000)

Data type : string

access: - public

$SeparatedMaterials = NULL (line 2061)

Data type : string

access: - public

$SortTitle = NULL (line 1973)

Data type : string

access: - public

$Subjects = array() (line 2149)

Data type : Subject[]

Array containing Subjects for Collection

access: - public

$TechnicalAccess = NULL (line 2021)

Data type : string

access: - public

$TemplateSet = NULL (line 1997)

Data type : string

access: - public

$Title = NULL (line 1970)

Data type : string

access: - public

$UseRestrictions = NULL (line 2015)

Data type : string

access: - public

Class Constants

Summary:

Method Detail

Summary:

Collection Collection ([integer|array $ID_or_Row = NULL])

boolean dbDeleteCollection ()

boolean dbLoadAll ()

boolean dbLoadCollection ()

unknown dbLoadContainerCount ()

boolean dbLoadContent ()

boolean dbLoadCreators ()

boolean dbLoadDigitalContent ()

boolean dbLoadLanguages ()

boolean dbLoadLocationEntries ()

boolean dbLoadRelatedObjects ()

boolean dbLoadRootContent ()

boolean dbLoadSubjects ()

boolean dbRelateCreator (integer $CreatorID)

boolean dbRelateLanguage (integer $LanguageID)

boolean dbRelateSubject (integer $SubjectID)

boolean dbStoreCollection ()

boolean dbUnrelateAllCreators ()

boolean dbUnrelateAllLanguages ()

boolean dbUnrelateAllSubjects ()

boolean dbUnrelateCreator (integer $CreatorID)

boolean dbUnrelateLanguage (integer $LanguageID)

boolean dbUnrelateSubject (integer $SubjectID)

string toString ([ $MakeIntoLink = LINK_NONE], boolean $MakeIntoLink[optional])

string __toString ()

Constructor Collection (line 40)

Collection Collection( [integer|array $ID_or_Row = NULL])

Collection Constructor

If ID is passed as an argument, no data will be loaded until some varation of dbLoad is called.

If a table row is passed as an argument, the array will be parsed, and object variables will be assigned.

Parameters

integer|array $ID_or_Row: Collection ID or array containing row from tblCol_Collections

Info

access - public

Method dbDeleteCollection (line 76)

boolean dbDeleteCollection( )

Deletes Collection from the database

Info

access - public

Method dbLoadAll (line 192)

boolean dbLoadAll( )

Loads Collection and all related data and objects

Loaded objects which may contain multiple instances:

Content
Creators
Locations
Subjects

Loaded objects which will only contain one instance:

Repository
Classification
ExtentUnits
MaterialType
Language
FindingLanguage

This function is the most expensive of any in the project. It should ONLY be called when an entire finding aid is being generated.

Info

access - public

Method dbLoadCollection (line 247)

boolean dbLoadCollection( )

Loads Collection and root-level Content

This function loads all data related to the collection except for the full content tree. It is much faster than dbLoadAll().

Info

access - public

Method dbLoadContainerCount (line 307)

unknown dbLoadContainerCount( )

Loads Container Statistics for Collection instance

Info

access - public
todo - Revamp

Method dbLoadContent (line 361)

boolean dbLoadContent( )

Loads Content for Collection instance

Info

access - public

Method dbLoadCreators (line 456)

boolean dbLoadCreators( )

Loads Creators for Collection instance

Info

access - public

Method dbLoadDigitalContent (line 508)

boolean dbLoadDigitalContent( )

Loads Digital Content for Collection instance

Info

access - public

Method dbLoadLanguages (line 558)

boolean dbLoadLanguages( )

Loads Languages for Collection instance

Info

access - public

Method dbLoadLocationEntries (line 600)

boolean dbLoadLocationEntries( )

Loads Location Entries for Collection instance

Info

access - public

Method dbLoadRelatedObjects (line 649)

boolean dbLoadRelatedObjects( )

Loads All Related Objects for Collection instance

Info

access - public

Method dbLoadRootContent (line 734)

boolean dbLoadRootContent( )

Loads Root-level Content for Collection instance

Info

access - public

Method dbLoadSubjects (line 779)

boolean dbLoadSubjects( )

Loads Subjects for Collection instance

Info

access - public

Method dbRelateCreator (line 841)

boolean dbRelateCreator( integer $CreatorID)

Relate Creator to Collection

Parameters

integer $CreatorID:

Info

access - public

Method dbRelateLanguage (line 954)

boolean dbRelateLanguage( integer $LanguageID)

Relate Language to Collection

Parameters

integer $LanguageID:

Info

access - public

Method dbRelateSubject (line 1041)

boolean dbRelateSubject( integer $SubjectID)

Relate Subject to Collection

Parameters

integer $SubjectID:

Info

access - public

Method dbStoreCollection (line 1137)

boolean dbStoreCollection( )

Stores Collection to the database

If the ID value has been set, dbStore will try to update an existing collection. Otherwise, it will add a new collection.

IMPORTANT:

dbStore will NOT store any information added/modified to ANY member objects! If you wish to update the database entries for member objects, you will need to seperately call the object's dbStore method.

Info

access - public

Method dbUnrelateAllCreators (line 1473)

boolean dbUnrelateAllCreators( )

Unrelates all creators for collection

Info

access - public

Method dbUnrelateAllLanguages (line 1535)

boolean dbUnrelateAllLanguages( )

Unrelates all languages for collection

Info

access - public

Method dbUnrelateAllSubjects (line 1596)

boolean dbUnrelateAllSubjects( )

Unrelates all subjects for collection

Info

access - public

Method dbUnrelateCreator (line 1659)

boolean dbUnrelateCreator( integer $CreatorID)

Unrelate Creator from Collection

Parameters

integer $CreatorID:

Info

access - public

Method dbUnrelateLanguage (line 1737)

boolean dbUnrelateLanguage( integer $LanguageID)

Unrelate Language from Collection

Parameters

integer $LanguageID:

Info

access - public

Method dbUnrelateSubject (line 1815)

boolean dbUnrelateSubject( integer $SubjectID)

Unrelate Subject from Collection

Parameters

integer $SubjectID:

Info

access - public

Method toString (line 1892)

string toString( [ $MakeIntoLink = LINK_NONE], boolean $MakeIntoLink[optional])

Returns a formatted string of a traversal of subject instance

Parameters

boolean $MakeIntoLink[optional]:
$MakeIntoLink:

Info

access - public

Method __toString (line 1936)

string __toString( )

Outputs Collection Title if Collection is cast to string

Info

access - public
magic -