Docs For Class CollectionClass

CollectionClass

Description

To change the template for this generated file go to Window - Preferences - PHPeclipse - PHP - Code Templates

module_load_include('nc', 'CollectionClass', ''); This CLASS caches the streams so once you call a getstream once it will always return the same stream as long as you are using the instance of this class. Cached to prevent mutiple hits to fedora. maybe a bit confusing though if this class is used in a different context.

Located in /CollectionClass.inc (line 18)

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

access: public

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

access: public

mixed $collectionObject = NULL (line 25)

access: public

Methods

Constructor __construct (line 33)

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

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

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

void callMethods ( $file, $methods)

$file
$methods

createUserCollection (line 366)

void createUserCollection ( &$user)

&$user

getAllowedMimeTypes (line 225)

void getAllowedMimeTypes ( $contentModelPid, $contentModel_dsid)

$contentModelPid
$contentModel_dsid

getAndDoRules (line 243)

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

void getCollectionPolicyStream ( $collection_pid)

$collection_pid

getCollectionViewStream (line 123)

void getCollectionViewStream ( $collection_pid)

$collection_pid

getContentModels (line 156)

gets a list of content models from a collection policy

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

$collection_pid
$showError

getFormHandler (line 198)

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

void getIngestInterface ()

getNextPid (line 183)

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

void getPidNameSpace ( $pid, $dsid)

$pid
$dsid

getRelatedItems (line 59)

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

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

$pid
$limit
$offset
$itqlquery

getRelationshipElement (line 111)

void getRelationshipElement ( $collection_pid)

$collection_pid

getStream (line 128)

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

$pid
$dsid
$showError

getXslContent (line 411)

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

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

$content
$pid
$dsId
$collection
$pageNumber

showFieldSets (line 421)

void showFieldSets ( $page_number)

$page_number

Documentation generated on Thu, 14 Jul 2011 16:56:03 -0300 by phpDocumentor 1.4.3