Docs For Class CollectionClass

CollectionClass

Description

Located in /CollectionClass.inc (line 21)

Variable Summary

static mixed $COLLECTION_CLASS_COLLECTION_POLICY_STREAM

static mixed $COLLECTION_CLASS_COLLECTION_VIEW_STREAM

mixed $collectionObject

Method Summary

CollectionClass __construct ([string $pid = NULL])

void build_ingest_form ( &$form, &$form_state, $contentModelPid, $contentModelDsid)

void callMethods ( $file, $methods)

void createUserCollection ( &$user)

void getAllowedMimeTypes ( $contentModelPid, $contentModel_dsid)

void getAndDoRules ( $file, $mimetype, $pid, $dsid)

void getCollectionPolicyStream ( $collection_pid)

void getCollectionViewStream ( $collection_pid)

void getContentModels ( $collection_pid, [ $showError = TRUE])

array getFormHandler (string $pid, string $dsid)

void getIngestInterface ()

void getNextPid ( $pid, $dsid)

void getPidNameSpace ( $pid, $dsid)

void getRelatedItems ( $pid, [ $itqlquery = NULL], [ $limit = NULL], [ $offset = NULL])

void getRelatedObjects ( $pid, $limit, $offset, [ $itqlquery = NULL])

void getRelationshipElement ( $collection_pid)

void getStream ( $pid, $dsid, [ $showError = 1])

void getXslContent ( $pid, $path, [ $canUseDefault = TRUE])

void renderCollection ( $content, $pid, $dsId, $collection, [ $pageNumber = NULL])

void showFieldSets ( $page_number)

Variables

static mixed $COLLECTION_CLASS_COLLECTION_POLICY_STREAM = 'COLLECTION_POLICY' (line 23)

access: public

static mixed $COLLECTION_CLASS_COLLECTION_VIEW_STREAM = 'COLLECTION_VIEW' (line 24)

access: public

mixed $collectionObject = NULL (line 28)

access: public

Methods

Constructor __construct (line 36)

Creates a collection object. Optionally can associate it with a single collection with parameter $pid.

CollectionClass __construct ([string $pid = NULL])

string $pid: The pid of the collection to represent.

build_ingest_form (line 305)

grabs a xml form definition from a content model and builds

the form using drupals forms api

void build_ingest_form ( &$form, &$form_state, $contentModelPid, $contentModelDsid)

&$form
&$form_state
$contentModelPid
$contentModelDsid

callMethods (line 273)

calls the methods defined in the content model rules .xml file stored in a Fedora object

void callMethods ( $file, $methods)

$file
$methods

createUserCollection (line 369)

void createUserCollection ( &$user)

&$user

getAllowedMimeTypes (line 228)

void getAllowedMimeTypes ( $contentModelPid, $contentModel_dsid)

$contentModelPid
$contentModel_dsid

getAndDoRules (line 246)

Grabs the rules from the content model stream

file the file that has been uploaded

void getAndDoRules ( $file, $mimetype, $pid, $dsid)

$file
$mimetype
$pid
$dsid

getCollectionPolicyStream (line 106)

void getCollectionPolicyStream ( $collection_pid)

$collection_pid

getCollectionViewStream (line 126)

void getCollectionViewStream ( $collection_pid)

$collection_pid

getContentModels (line 159)

gets a list of content models from a collection policy

void getContentModels ( $collection_pid, [ $showError = TRUE])

$collection_pid
$showError

getFormHandler (line 201)

gets the form handler file, class and method and returns them in an array

return: The file, class and method name to handle the ingest form.

array getFormHandler (string $pid, string $dsid)

string $pid: The content model PID
string $dsid: The content model DSID

getIngestInterface (line 461)

void getIngestInterface ()

getNextPid (line 186)

using the collection policies pid namespace get a new pid by calling fedora' get next pid and appending it to the namespace $pid is the $pid of the content model $dsid is the datastream id of the content model.

void getNextPid ( $pid, $dsid)

$pid
$dsid

getPidNameSpace (line 137)

void getPidNameSpace ( $pid, $dsid)

$pid
$dsid

getRelatedItems (line 62)

Gets objects related to this item. It will query the object for a Query stream and use that as a itql query

or if there is no query stream it will use the default. If you pass a query to this method it will use the passed in query no matter what

void getRelatedItems ( $pid, [ $itqlquery = NULL], [ $limit = NULL], [ $offset = NULL])

$pid
$itqlquery
$limit
$offset

getRelatedObjects (line 48)

void getRelatedObjects ( $pid, $limit, $offset, [ $itqlquery = NULL])

$pid
$limit
$offset
$itqlquery

getRelationshipElement (line 114)

void getRelationshipElement ( $collection_pid)

$collection_pid

getStream (line 131)

void getStream ( $pid, $dsid, [ $showError = 1])

$pid
$dsid
$showError

getXslContent (line 414)

Queries a collection object for an xslt to format how the collection of objects is displayed.

void getXslContent ( $pid, $path, [ $canUseDefault = TRUE])

$pid
$path
$canUseDefault

renderCollection (line 484)

void renderCollection ( $content, $pid, $dsId, $collection, [ $pageNumber = NULL])

$content
$pid
$dsId
$collection
$pageNumber

showFieldSets (line 424)

void showFieldSets ( $page_number)

$page_number

Documentation generated on Thu, 14 Jul 2011 16:55:09 -0300 by phpDocumentor 1.4.3