Class Collections_Collection

(line 2)

Description




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














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




    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









 $AccessRestrictions =  NULL (line 1957)
 


Data type : string



    
		
  • access: - public
    • 
	








 $AccrualInfo =  NULL (line 1985)
 


Data type : string



    
		
  • access: - public
    • 
	








 $AcquisitionDate =  NULL (line 1979)
 


Data type : string



Format: YYYYMMDD


    
		
  • access: - public
    • 
	








 $AcquisitionDateDay (line 2049)
 


Data type : string



    
		
  • access: - public
    • 
	








 $AcquisitionDateMonth (line 2046)
 


Data type : string



    
		
  • access: - public
    • 
	








 $AcquisitionDateYear (line 2052)
 


Data type : string



    
		
  • access: - public
    • 
	








 $AcquisitionMethod =  NULL (line 1972)
 


Data type : string



    
		
  • access: - public
    • 
	








 $AcquisitionSource =  NULL (line 1969)
 


Data type : string



    
		
  • access: - public
    • 
	








 $AltExtentStatement =  NULL (line 1954)
 


Data type : string



    
		
  • access: - public
    • 
	








 $AppraisalInfo =  NULL (line 1982)
 


Data type : string



    
		
  • access: - public
    • 
	








 $Arrangement =  NULL (line 1948)
 


Data type : string



    
		
  • access: - public
    • 
	








 $Classification =  NULL (line 2111)
 


Data type : Classification



    
		
  • access: - public
    • 
	








 $ClassificationID =  0 (line 1907)
 


Data type : integer



    
		
  • access: - public
    • 
	








 $CollectionIdentifier =  NULL (line 1912)
 


Data type : string



    
		
  • access: - public
    • 
	








 $Content = array() (line 2073)
 


Data type : CollectionContent[]



Array containing Content for Collection


    
		
  • access: - public
    • 
	








 $Creators = array() (line 2080)
 


Data type : Creator[]



Array containing Creators for Collection


    
		
  • access: - public
    • 
	








 $CustodialHistory =  NULL (line 1988)
 


Data type : string



    
		
  • access: - public
    • 
	








 $DescriptiveRules =  NULL (line 2131)
 


Data type : DescriptiveRules



Descriptive Rules Used for the Finding Aid


    
		
  • access: - public
    • 
	








 $DescriptiveRulesID =  0 (line 2018)
 


Data type : integer



    
		
  • access: - public
    • 
	








 $Enabled =  1 (line 1901)
 


Data type : integer



    
		
  • access: - public
    • 
	








 $Extent =  NULL (line 1936)
 


Data type : string



    
		
  • access: - public
    • 
	








 $ExtentUnit =  NULL (line 2114)
 


Data type : ExtentUnit



    
		
  • access: - public
    • 
	








 $ExtentUnitID =  0 (line 1939)
 


Data type : integer



    
		
  • access: - public
    • 
	








 $FindingAidAuthor =  NULL (line 1933)
 


Data type : string



    
		
  • access: - public
    • 
	








 $FindingLanguage =  NULL (line 2124)
 


Data type : Language



Language of the Finding Aid


    
		
  • access: - public
    • 
	








 $FindingLanguageID =  0 (line 2037)
 


Data type : integer



    
		
  • access: - public
    • 
	








 $ID =  0 (line 1896)
 


Data type : integer



    
		
  • access: - public
    • 
	








 $InclusiveDates =  NULL (line 1921)
 


Data type : string



    
		
  • access: - public
    • 
	








 $Languages = array() (line 2101)
 


Data type : Language[]



Array containing Languages for Collection


    
		
  • access: - public
    • 
	








 $LocationEntries = array() (line 2094)
 


Data type : LocationEntry[]



Array containing Location Entries for Collection


    
		
  • access: - public
    • 
	








 $MaterialType =  NULL (line 2117)
 


Data type : MaterialType



    
		
  • access: - public
    • 
	








 $MaterialTypeID =  0 (line 1951)
 


Data type : integer



    
		
  • access: - public
    • 
	








 $NormalDateBegin =  NULL (line 1927)
 


Data type : string



    
		
  • access: - public
    • 
	








 $NormalDateEnd =  NULL (line 1930)
 


Data type : string



    
		
  • access: - public
    • 
	








 $OrigCopiesNote =  NULL (line 1991)
 


Data type : string



    
		
  • access: - public
    • 
	








 $OrigCopiesURL =  NULL (line 1994)
 


Data type : string



    
		
  • access: - public
    • 
	








 $OtherNote =  NULL (line 2012)
 


Data type : string



    
		
  • access: - public
    • 
	








 $OtherURL =  NULL (line 2015)
 


Data type : string



    
		
  • access: - public
    • 
	








 $PhysicalAccess =  NULL (line 1963)
 


Data type : string



    
		
  • access: - public
    • 
	








 $PredominantDates =  NULL (line 1924)
 


Data type : string



    
		
  • access: - public
    • 
	








 $PreferredCitation =  NULL (line 2009)
 


Data type : string



    
		
  • access: - public
    • 
	








 $PrimaryCreator =  NULL (line 2139)
 


Data type : Creator



Creator Object of the Primary Creator for Collection


    
		
  • access: - public
    • 
	








 $ProcessingInfo =  NULL (line 2021)
 


Data type : string



    
		
  • access: - public
    • 
	








 $PublicationDate =  NULL (line 2031)
 


Data type : string



Format: YYYYMMDD


    
		
  • access: - public
    • 
	








 $PublicationDateDay (line 2058)
 


Data type : string



    
		
  • access: - public
    • 
	








 $PublicationDateMonth (line 2055)
 


Data type : string



    
		
  • access: - public
    • 
	








 $PublicationDateYear (line 2061)
 


Data type : string



    
		
  • access: - public
    • 
	








 $PublicationNote =  NULL (line 2034)
 


Data type : string



    
		
  • access: - public
    • 
	








 $RelatedMaterials =  NULL (line 1997)
 


Data type : string



    
		
  • access: - public
    • 
	








 $RelatedMaterialsURL =  NULL (line 2000)
 


Data type : string



    
		
  • access: - public
    • 
	








 $RelatedPublications =  NULL (line 2003)
 


Data type : string



    
		
  • access: - public
    • 
	








 $Repository =  NULL (line 2108)
 


Data type : Repository



Repository where the Collection is stored


    
		
  • access: - public
    • 
	








 $RepositoryID =  0 (line 1904)
 


Data type : integer



    
		
  • access: - public
    • 
	








 $RevisionHistory =  NULL (line 2024)
 


Data type : string



    
		
  • access: - public
    • 
	








 $Scope =  NULL (line 1945)
 


Data type : string



    
		
  • access: - public
    • 
	








 $SeparatedMaterials =  NULL (line 2006)
 


Data type : string



    
		
  • access: - public
    • 
	








 $SortTitle =  NULL (line 1918)
 


Data type : string



    
		
  • access: - public
    • 
	








 $Subjects = array() (line 2087)
 


Data type : Subject[]



Array containing Subjects for Collection


    
		
  • access: - public
    • 
	








 $TechnicalAccess =  NULL (line 1966)
 


Data type : string



    
		
  • access: - public
    • 
	








 $TemplateSet =  NULL (line 1942)
 


Data type : string



    
		
  • access: - public
    • 
	








 $Title =  NULL (line 1915)
 


Data type : string



    
		
  • access: - public
    • 
	








 $UseRestrictions =  NULL (line 1960)
 


Data type : string



    
		
  • access: - public
    • 
	










Class Constants


Summary:









Method Detail


Summary:



    

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











 Method dbDeleteCollection (line 9)
 
 

boolean dbDeleteCollection(
)


	

Deletes Collection from the database

		
	
Info

	
    
			
  • access - public
    • 
		






 Method dbLoad (line 139)
 
 

boolean dbLoad(
)


	

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

boolean dbLoadAll(
[integer
$RootContentID = LOADCONTENT_ALL])


	

Loads Collection and all related data and objects

		
Parameters

	
    
			
  • integer $RootContentID: 
    • 
		

		
	
Info

	
    
			
  • access - public
    • 
		






 Method dbLoadContainerCount (line 199)
 
 

unknown dbLoadContainerCount(
)


	

Loads Container Statistics for Collection instance

		
	
Info

	
    
			
  • access - public
    • 
			
  • todo - Revamp
    • 
		






 Method dbLoadContent (line 259)
 
 

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


	

Loads Content for Collection instance

		
Parameters

	
    
			
  • 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: 
    • 
		

		
	
Info

	
    
			
  • access - public
    • 
		






 Method dbLoadCreators (line 374)
 
 

boolean dbLoadCreators(
)


	

Loads Creators for Collection instance

		
	
Info

	
    
			
  • access - public
    • 
		






 Method dbLoadLanguages (line 428)
 
 

boolean dbLoadLanguages(
)


	

Loads Languages for Collection instance

		
	
Info

	
    
			
  • access - public
    • 
		






 Method dbLoadLocationEntries (line 472)
 
 

boolean dbLoadLocationEntries(
)


	

Loads Location Entries for Collection instance

		
	
Info

	
    
			
  • access - public
    • 
		






 Method dbLoadRelatedObjects (line 523)
 
 

boolean dbLoadRelatedObjects(
)


	

Loads All Related Objects for Collection instance

		
	
Info

	
    
			
  • access - public
    • 
		






 Method dbLoadRootContent (line 608)
 
 

boolean dbLoadRootContent(
)


	

Loads Root-level Content for Collection instance

		
	
Info

	
    
			
  • access - public
    • 
		






 Method dbLoadSubjects (line 655)
 
 

boolean dbLoadSubjects(
)


	

Loads Subjects for Collection instance

		
	
Info

	
    
			
  • access - public
    • 
		






 Method dbRelateCreator (line 719)
 
 

boolean dbRelateCreator(
integer
$CreatorID)


	

Relate Creator to Collection

		
Parameters

	
    
			
  • integer $CreatorID: 
    • 
		

		
	
Info

	
    
			
  • access - public
    • 
		






 Method dbRelateLanguage (line 827)
 
 

boolean dbRelateLanguage(
integer
$LanguageID)


	

Relate Language to Collection

		
Parameters

	
    
			
  • integer $LanguageID: 
    • 
		

		
	
Info

	
    
			
  • access - public
    • 
		






 Method dbRelateSubject (line 914)
 
 

boolean dbRelateSubject(
integer
$SubjectID)


	

Relate Subject to Collection

		
Parameters

	
    
			
  • integer $SubjectID: 
    • 
		

		
	
Info

	
    
			
  • access - public
    • 
		






 Method dbStoreCollection (line 1010)
 
 

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

		
	
Info

	
    
			
  • access - public
    • 
		






 Method dbUnrelateAllCreators (line 1359)
 
 

boolean dbUnrelateAllCreators(
)


	

Unrelates all creators for collection

		
	
Info

	
    
			
  • access - public
    • 
		






 Method dbUnrelateAllLanguages (line 1421)
 
 

boolean dbUnrelateAllLanguages(
)


	

Unrelates all languages for collection

		
	
Info

	
    
			
  • access - public
    • 
		






 Method dbUnrelateAllSubjects (line 1482)
 
 

boolean dbUnrelateAllSubjects(
)


	

Unrelates all subjects for collection

		
	
Info

	
    
			
  • access - public
    • 
		






 Method dbUnrelateCreator (line 1545)
 
 

boolean dbUnrelateCreator(
integer
$CreatorID)


	

Unrelate Creator from Collection

		
Parameters

	
    
			
  • integer $CreatorID: 
    • 
		

		
	
Info

	
    
			
  • access - public
    • 
		






 Method dbUnrelateLanguage (line 1625)
 
 

boolean dbUnrelateLanguage(
integer
$LanguageID)


	

Unrelate Language from Collection

		
Parameters

	
    
			
  • integer $LanguageID: 
    • 
		

		
	
Info

	
    
			
  • access - public
    • 
		






 Method dbUnrelateSubject (line 1705)
 
 

boolean dbUnrelateSubject(
integer
$SubjectID)


	

Unrelate Subject from Collection

		
Parameters

	
    
			
  • integer $SubjectID: 
    • 
		

		
	
Info

	
    
			
  • access - public
    • 
		






 Method rootContentIDsSet (line 1782)
 
 

boolean rootContentIDsSet(
)


	

Checks to see if all RootContentIDs for this collection are set

		
	
Info

	
    
			
  • access - public
    • 
		






 Method toString (line 1819)
 
 

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


	

Returns a formatted string of a traversal of subject instance

		
Parameters

	
    
			
  • integer $MakeIntoLink[optional]: 
    • 
			
  •  $MakeIntoLink: 
    • 
			
  •  $ConcatinateCollectionIdentifier: 
    • 
		

		
	
Info

	
    
			
  • access - public
    • 
		






 Method __toString (line 1879)
 
 

string __toString(
)


	

Outputs Collection Title if Collection is cast to string

		
	
Info

	
    
			
  • access - public
    • 
			
  • magic - 
    • 
		








Inherited Variables





Inherited Class Variable Summary


	




Inherited Methods





Inherited Method Summary


	




	

		

		Documentation generated on Mon, 19 Nov 2007 16:16:11 -0600 by phpDocumentor 1.3.1