Docs For Class Collections

Class Collections_Collection

Description

abstract:

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

Variable 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

DescriptiveRules $DescriptiveRules

integer $DescriptiveRulesID

integer $Enabled

string $Extent

ExtentUnit $ExtentUnit

integer $ExtentUnitID

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

Method Summary

integer countContent ()

boolean dbDeleteCollection ()

boolean dbLoad ()

boolean dbLoadAll ([integer $RootContentID = LOADCONTENT_ALL])

unknown dbLoadContainerCount ()

boolean dbLoadContent ([ $RootContentID = LOADCONTENT_ALL], integer $RootContentID[optional])

boolean dbLoadCreators ()

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)

boolean rootContentIDsSet ()

string toString ([ $MakeIntoLink = LINK_NONE], [ $ConcatinateCollectionIdentifier = false], integer $MakeIntoLink[optional])

string __toString ()

Variables

string $AccessRestrictions = NULL (line 1989)

access: public

string $AccrualInfo = NULL (line 2017)

access: public

string $AcquisitionDate = NULL (line 2011)

Format: YYYYMMDD

access: public

string $AcquisitionDateDay (line 2081)

access: public

string $AcquisitionDateMonth (line 2078)

access: public

string $AcquisitionDateYear (line 2084)

access: public

string $AcquisitionMethod = NULL (line 2004)

access: public

string $AcquisitionSource = NULL (line 2001)

access: public

string $AltExtentStatement = NULL (line 1986)

access: public

string $AppraisalInfo = NULL (line 2014)

access: public

string $Arrangement = NULL (line 1980)

access: public

Classification $Classification = NULL (line 2143)

access: public

integer $ClassificationID = 0 (line 1939)

access: public

string $CollectionIdentifier = NULL (line 1944)

access: public

CollectionContent[] $Content = array() (line 2105)

Array containing Content for Collection

access: public

Creator[] $Creators = array() (line 2112)

Array containing Creators for Collection

access: public

string $CustodialHistory = NULL (line 2020)

access: public

DescriptiveRules $DescriptiveRules = NULL (line 2163)

Descriptive Rules Used for the Finding Aid

access: public

integer $DescriptiveRulesID = 0 (line 2050)

access: public

integer $Enabled = 1 (line 1933)

access: public

string $Extent = NULL (line 1968)

access: public

ExtentUnit $ExtentUnit = NULL (line 2146)

access: public

integer $ExtentUnitID = 0 (line 1971)

access: public

string $FindingAidAuthor = NULL (line 1965)

access: public

Language $FindingLanguage = NULL (line 2156)

Language of the Finding Aid

access: public

integer $FindingLanguageID = 0 (line 2069)

access: public

integer $ID = 0 (line 1928)

access: public

string $InclusiveDates = NULL (line 1953)

access: public

Language[] $Languages = array() (line 2133)

Array containing Languages for Collection

access: public

LocationEntry[] $LocationEntries = array() (line 2126)

Array containing Location Entries for Collection

access: public

MaterialType $MaterialType = NULL (line 2149)

access: public

integer $MaterialTypeID = 0 (line 1983)

access: public

string $NormalDateBegin = NULL (line 1959)

access: public

string $NormalDateEnd = NULL (line 1962)

access: public

string $OrigCopiesNote = NULL (line 2023)

access: public

string $OrigCopiesURL = NULL (line 2026)

access: public

string $OtherNote = NULL (line 2044)

access: public

string $OtherURL = NULL (line 2047)

access: public

string $PhysicalAccess = NULL (line 1995)

access: public

string $PredominantDates = NULL (line 1956)

access: public

string $PreferredCitation = NULL (line 2041)

access: public

Creator $PrimaryCreator = NULL (line 2171)

Creator Object of the Primary Creator for Collection

access: public

string $ProcessingInfo = NULL (line 2053)

access: public

string $PublicationDate = NULL (line 2063)

Format: YYYYMMDD

access: public

string $PublicationDateDay (line 2090)

access: public

string $PublicationDateMonth (line 2087)

access: public

string $PublicationDateYear (line 2093)

access: public

string $PublicationNote = NULL (line 2066)

access: public

string $RelatedMaterials = NULL (line 2029)

access: public

string $RelatedMaterialsURL = NULL (line 2032)

access: public

string $RelatedPublications = NULL (line 2035)

access: public

Repository $Repository = NULL (line 2140)

Repository where the Collection is stored

access: public

integer $RepositoryID = 0 (line 1936)

access: public

string $RevisionHistory = NULL (line 2056)

access: public

string $Scope = NULL (line 1977)

access: public

string $SeparatedMaterials = NULL (line 2038)

access: public

string $SortTitle = NULL (line 1950)

access: public

Subject[] $Subjects = array() (line 2119)

Array containing Subjects for Collection

access: public

string $TechnicalAccess = NULL (line 1998)

access: public

string $TemplateSet = NULL (line 1974)

access: public

string $Title = NULL (line 1947)

access: public

string $UseRestrictions = NULL (line 1992)

access: public

Methods

countContent (line 9)

Returns the number of content items in the collections

access: public

integer countContent ()

dbDeleteCollection (line 27)

Deletes Collection from the database

access: public

boolean dbDeleteCollection ()

dbLoad (line 164)

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

access: public

boolean dbLoad ()

dbLoadAll (line 114)

Loads Collection and all related data and objects

access: public

boolean dbLoadAll ([integer $RootContentID = LOADCONTENT_ALL])

integer $RootContentID

dbLoadContainerCount (line 224)

Loads Container Statistics for Collection instance

access: public
todo: Revamp

unknown dbLoadContainerCount ()

dbLoadContent (line 284)

Loads Content for Collection instance

access: public

boolean dbLoadContent ([ $RootContentID = LOADCONTENT_ALL], integer $RootContentID[optional])

integer $RootContentID[optional]: Specifies which top level container to pull content from. LOADCONTENT defines may be used to grab all content or no content with this function
$RootContentID

dbLoadCreators (line 399)

Loads Creators for Collection instance

access: public

boolean dbLoadCreators ()

dbLoadLanguages (line 453)

Loads Languages for Collection instance

access: public

boolean dbLoadLanguages ()

dbLoadLocationEntries (line 497)

Loads Location Entries for Collection instance

access: public

boolean dbLoadLocationEntries ()

dbLoadRelatedObjects (line 548)

Loads All Related Objects for Collection instance

access: public

boolean dbLoadRelatedObjects ()

dbLoadRootContent (line 633)

Loads Root-level Content for Collection instance

access: public

boolean dbLoadRootContent ()

dbLoadSubjects (line 680)

Loads Subjects for Collection instance

access: public

boolean dbLoadSubjects ()

dbRelateCreator (line 744)

Relate Creator to Collection

access: public

boolean dbRelateCreator (integer $CreatorID)

integer $CreatorID

dbRelateLanguage (line 852)

Relate Language to Collection

access: public

boolean dbRelateLanguage (integer $LanguageID)

integer $LanguageID

dbRelateSubject (line 939)

Relate Subject to Collection

access: public

boolean dbRelateSubject (integer $SubjectID)

integer $SubjectID

dbStoreCollection (line 1035)

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 separately call the object's dbStore method.

access: public

boolean dbStoreCollection ()

dbUnrelateAllCreators (line 1394)

Unrelates all creators for collection

access: public

boolean dbUnrelateAllCreators ()

dbUnrelateAllLanguages (line 1457)

Unrelates all languages for collection

access: public

boolean dbUnrelateAllLanguages ()

dbUnrelateAllSubjects (line 1518)

Unrelates all subjects for collection

access: public

boolean dbUnrelateAllSubjects ()

dbUnrelateCreator (line 1581)

Unrelate Creator from Collection

access: public

boolean dbUnrelateCreator (integer $CreatorID)

integer $CreatorID

dbUnrelateLanguage (line 1661)

Unrelate Language from Collection

access: public

boolean dbUnrelateLanguage (integer $LanguageID)

integer $LanguageID

dbUnrelateSubject (line 1741)

Unrelate Subject from Collection

access: public

boolean dbUnrelateSubject (integer $SubjectID)

integer $SubjectID

rootContentIDsSet (line 1818)

Checks to see if all RootContentIDs for this collection are set

access: public

boolean rootContentIDsSet ()

toString (line 1855)

Returns a formatted string of a traversal of subject instance

access: public

string toString ([ $MakeIntoLink = LINK_NONE], [ $ConcatinateCollectionIdentifier = false], integer $MakeIntoLink[optional])

integer $MakeIntoLink[optional]
$MakeIntoLink
$ConcatinateCollectionIdentifier

__toString (line 1911)

Outputs Collection Title if Collection is cast to string

access: public
magic:

string __toString ()

Documentation generated on Wed, 05 Mar 2008 16:45:34 -0600 by phpDocumentor 1.3.1