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

string $ExpectedCompletionDate

string $ExpectedCompletionDateDay

string $ExpectedCompletionDateMonth

string $ExpectedCompletionDateYear

integer $ID

string $Identifier

string $InclusiveDates

AccessionLocationEntry[] $LocationEntries

MaterialType $MaterialType

integer $MaterialTypeID

string $PhysicalDescription

AccessionCollectionEntry $PrimaryCollectionEntry

Creator $PrimaryCreator

ProcessingPriority $ProcessingPriority

integer $ProcessingPriorityID

float $ReceivedExtent

ExtentUnit $ReceivedExtentUnit

integer $ReceivedExtentUnitID

string $ScopeContent

Subject[] $Subjects

string $Title

float $UnprocessedExtent

ExtentUnit $UnprocessedExtentUnit

integer $UnprocessedExtentUnitID

Method Summary

Accessions_Accession __construct ()

mixed createCollection ()

boolean dbDelete ()

boolean dbLoad ()

boolean dbLoadAll ()

boolean dbLoadCollectionEntries ()

boolean dbLoadCreators ()

boolean dbLoadLocationEntries ()

boolean dbLoadSubjects ()

boolean dbRelateCreator (integer $CreatorID)

boolean dbRelateSubject (integer $SubjectID)

boolean dbStore ()

boolean dbUnrelateAllCreators ()

boolean dbUnrelateAllSubjects ()

boolean dbUnrelateCreator (integer $CreatorID)

boolean dbUnrelateSubject (integer $SubjectID)

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

boolean verifyRepositoryPermissions ()

Variables

string $AccessionDate = NULL (line 1328)

access: public

string $AccessionDateDay (line 1437)

access: public

string $AccessionDateMonth (line 1434)

access: public

string $AccessionDateYear (line 1440)

access: public

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

access: public

string $Comments = NULL (line 1431)

access: public

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

access: public

string $Donor = NULL (line 1399)

access: public

string $DonorContactInformation = NULL (line 1404)

access: public

string $DonorNotes = NULL (line 1409)

access: public

integer $Enabled = 1 (line 1323)

access: public

string $ExpectedCompletionDate = NULL (line 1394)

access: public

string $ExpectedCompletionDateDay (line 1446)

access: public

string $ExpectedCompletionDateMonth (line 1443)

access: public

string $ExpectedCompletionDateYear (line 1449)

access: public

integer $ID = 0 (line 1318)

access: public

string $Identifier = NULL (line 1338)

access: public

string $InclusiveDates = NULL (line 1343)

access: public

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

access: public

MaterialType $MaterialType = NULL (line 1374)

access: public

integer $MaterialTypeID = 0 (line 1379)

access: public

string $PhysicalDescription = NULL (line 1414)

access: public

AccessionCollectionEntry $PrimaryCollectionEntry = NULL (line 1469)

access: public

Creator $PrimaryCreator = NULL (line 1474)

access: public

ProcessingPriority $ProcessingPriority = NULL (line 1389)

access: public

integer $ProcessingPriorityID = 0 (line 1384)

access: public

float $ReceivedExtent = NULL (line 1348)

access: public

ExtentUnit $ReceivedExtentUnit = NULL (line 1351)

access: public

integer $ReceivedExtentUnitID = 0 (line 1356)

access: public

string $ScopeContent = NULL (line 1419)

access: public

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

Array containing Subjects for Accession

access: public

string $Title = NULL (line 1333)

access: public

float $UnprocessedExtent = NULL (line 1361)

access: public

ExtentUnit $UnprocessedExtentUnit = NULL (line 1365)

access: public

integer $UnprocessedExtentUnitID = 0 (line 1370)

access: public

Methods

Constructor __construct (line 9)

Digital Content Constructor

access: public

Accessions_Accession __construct ()

createCollection (line 33)

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

Deletes a Accession from the database

access: public

boolean dbDelete ()

dbLoad (line 178)

Loads Accession from the database

access: public

boolean dbLoad ()

dbLoadAll (line 242)

Loads Accession and all related data and objects

access: public

boolean dbLoadAll ()

dbLoadCollectionEntries (line 345)

Loads Collection Entries for Accession instance

access: public

boolean dbLoadCollectionEntries ()

dbLoadCreators (line 292)

Loads Creators for Accession instance

access: public

boolean dbLoadCreators ()

dbLoadLocationEntries (line 406)

Loads Location Entries for Accession instance

access: public

boolean dbLoadLocationEntries ()

dbLoadSubjects (line 456)

Loads Subjects for Accession instance

access: public

boolean dbLoadSubjects ()

dbRelateCreator (line 519)

Relate Creator to Accession

access: public

boolean dbRelateCreator (integer $CreatorID)

integer $CreatorID

dbRelateSubject (line 625)

Relate Subject to Accession

access: public

boolean dbRelateSubject (integer $SubjectID)

integer $SubjectID

dbStore (line 710)

Stores Accession to the database

access: public

boolean dbStore ()

dbUnrelateAllCreators (line 940)

Unrelates all creators for accession

access: public

boolean dbUnrelateAllCreators ()

dbUnrelateAllSubjects (line 995)

Unrelates all subjects for accession

access: public

boolean dbUnrelateAllSubjects ()

dbUnrelateCreator (line 1056)

Unrelate Creator from Accession

access: public

boolean dbUnrelateCreator (integer $CreatorID)

integer $CreatorID

dbUnrelateSubject (line 1134)

Unrelate Subject from Accession

access: public

boolean dbUnrelateSubject (integer $SubjectID)

integer $SubjectID

toString (line 1265)

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

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

Class Accessions_Accession