Docs For Class Accessions

Description

abstract:

Located in /packages/accessions/lib/accession.inc.php (line 2)

Variable Summary

string $AccessionDate

string $AccessionDateDay

string $AccessionDateMonth

string $AccessionDateYear

AccessionCollectionEntry[] $CollectionEntries

string $Comments

Creator[] $Creators

string $Donor

string $DonorContactInformation

string $DonorNotes

integer $Enabled

integer $ID

string $Identifier

string $InclusiveDates

AccessionLocationEntry[] $LocationEntries

integer $MaterialTypeID

string $PhysicalDescription

AccessionCollectionEntry $PrimaryCollectionEntry

Creator $PrimaryCreator

integer $ProcessingPriorityID

float $ReceivedExtent

integer $ReceivedExtentUnitID

string $ScopeContent

string $Title

float $UnprocessedExtent

integer $UnprocessedExtentUnitID

Method Summary

mixed createCollection ()

boolean dbDelete ()

boolean dbLoad ()

boolean dbLoadAll ()

boolean dbLoadCollectionEntries ()

boolean dbLoadCreators ()

boolean dbLoadLocationEntries ()

boolean dbRelateCreator (integer $CreatorID)

boolean dbStore ()

boolean dbUnrelateAllCreators ()

boolean dbUnrelateCreator (integer $CreatorID)

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

boolean verifyRepositoryPermissions ()

string __toString ()

Variables

string $AccessionDate = NULL (line 940)

access: public

string $AccessionDateDay (line 1021)

access: public

string $AccessionDateMonth (line 1018)

access: public

string $AccessionDateYear (line 1024)

access: public

AccessionCollectionEntry[] $CollectionEntries = array() (line 1029)

access: public

string $Comments = NULL (line 1015)

access: public

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

access: public

string $Donor = NULL (line 990)

access: public

string $DonorContactInformation = NULL (line 995)

access: public

string $DonorNotes = NULL (line 1000)

access: public

integer $Enabled = 1 (line 935)

access: public

integer $ID = 0 (line 930)

access: public

string $Identifier = NULL (line 950)

access: public

string $InclusiveDates = NULL (line 955)

access: public

AccessionLocationEntry[] $LocationEntries = array() (line 1034)

access: public

integer $MaterialTypeID = 0 (line 980)

access: public

string $PhysicalDescription = NULL (line 1005)

access: public

AccessionCollectionEntry $PrimaryCollectionEntry = NULL (line 1044)

access: public

Creator $PrimaryCreator = NULL (line 1049)

access: public

integer $ProcessingPriorityID = 0 (line 985)

access: public

float $ReceivedExtent = NULL (line 960)

access: public

integer $ReceivedExtentUnitID = 0 (line 965)

access: public

string $ScopeContent = NULL (line 1010)

access: public

string $Title = NULL (line 945)

access: public

float $UnprocessedExtent = NULL (line 970)

access: public

integer $UnprocessedExtentUnitID = 0 (line 975)

access: public

Methods

createCollection (line 11)

Creates a new collection based upon the information stored in the accession.

The new collection will have fields filled in when applicable and belong to the primary classification associated with the accession.

return: The created Collection on success and false on failure.
access: public

mixed createCollection ()

dbDelete (line 81)

Deletes a Accession from the database

access: public

boolean dbDelete ()

dbLoad (line 149)

Loads Accession from the database

access: public

boolean dbLoad ()

dbLoadAll (line 200)

Loads Accession and all related data and objects

access: public

boolean dbLoadAll ()

dbLoadCollectionEntries (line 298)

Loads Collection Entries for Accession instance

access: public

boolean dbLoadCollectionEntries ()

dbLoadCreators (line 245)

Loads Creators for Accession instance

access: public

boolean dbLoadCreators ()

dbLoadLocationEntries (line 359)

Loads Location Entries for Accession instance

access: public

boolean dbLoadLocationEntries ()

dbRelateCreator (line 410)

Relate Creator to Accession

access: public

boolean dbRelateCreator (integer $CreatorID)

integer $CreatorID

dbStore (line 516)

Stores Accession to the database

access: public

boolean dbStore ()

dbUnrelateAllCreators (line 713)

Unrelates all creators for accession

access: public

boolean dbUnrelateAllCreators ()

dbUnrelateCreator (line 769)

Unrelate Creator from Accession

access: public

boolean dbUnrelateCreator (integer $CreatorID)

integer $CreatorID

toString (line 900)

Generates a formatted string of the Accession object

access: public
todo: Custom Formatting

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

integer $MakeIntoLink[optional]
$MakeIntoLink

verifyRepositoryPermissions (line 847)

Returns true only if a user with correct repository editing permissions is currently logged in.

This will return false if the Accession is associated with one or more collections outside the users repository permissions and no collections within his or her permissions.

access: public

boolean verifyRepositoryPermissions ()

__toString (line 922)

access: public
magic:
see: Accessions_Accession::toString()

string __toString ()

Class Accessions_Accession