bitweaver: Pigeonholes Class Reference

Pigeonholes::alphabetiseMembers ( &$ pMememberHash )

Alphabetise all member items

Returns:: a nicely grouped set of pigeonhole members in a set of columns and starting letters. public

Definition at line 549 of file Pigeonholes.php.

References $gBitSystem, $i, $ret, and title.

Referenced by getList().

Pigeonholes::checkPathPermissions ( $ pPath )

Check permissions of all nodes that lead to this

Returns:: a nicely grouped set of pigeonhole members in a set of columns and starting letters. public

Definition at line 524 of file Pigeonholes.php.

References $gBitSystem, $gBitUser, $query, $result, FALSE, and mDb.

Pigeonholes::expunge ( $ pStructureId = NULL )

Expunge currently loaded pigeonhole

Returns:: bool TRUE on success, FALSE if store could not occur. public

Reimplemented from LibertyAttachable.

Definition at line 803 of file Pigeonholes.php.

References $query, $result, $ret, $struct, LibertyContent::expunge(), FALSE, LibertyContent::isValid(), load(), mContentId, mDb, and BitBase::verifyId().

Here is the call graph for this function:

Pigeonholes::expungePigeonholeMember ( $ pParamHash )

Expunge pigeonhole member

Parameters:

	$pParamHash['parent_id']	parent_id of content to be deleted
	$pParamHash['member_id']	content_id of content to be deleted
	$pParamHash['deletables']	array of content_ids to check against when deleting. makes sure that only members of a given structure are removed Note if only one of the 2 ids is given, all items with that id will be removed. if both are given, only that one particular entry is removed

Returns:: bool TRUE on success, FALSE if store could not occur. If FALSE, $this->mErrors will have reason why public

Definition at line 768 of file Pigeonholes.php.

References $pParamHash, $query, $result, mDb, and BitBase::verifyId().

Referenced by store().

Here is the call graph for this function:

Pigeonholes::getAssignableContent ( &$ pListHash )

get all items that are not part of a pigeonhole yet

Returns:: array of content not in any pigeonhole yet public

Definition at line 188 of file Pigeonholes.php.

References $contentTypes, $gBitSystem, $gBitUser, $gLibertySystem, $i, $query, $r, $result, $ret, $row, $type, mDb, mPackages, BitBase::postGetList(), LibertyContent::prepGetList(), title, and BitBase::verifyId().

Here is the call graph for this function:

Pigeonholes::getDisplayLink	(	$	pTitle = `NULL`,
		$	pMixed = `NULL`
	)

Returns HTML link to display a pigeonhole

Parameters:

	$pTitle	is the pigeonhole we want to see
	$pContentId	content id of the pigeonhole in question

Returns:: the link to display the page.

Definition at line 887 of file Pigeonholes.php.

References $gBitSystem, $ret, LibertyContent::getTitle(), mInfo, and title.

Referenced by getList(), and load().

Here is the call graph for this function:

Pigeonholes::getDisplayPath ( $ pPath )

Converts a structure path into valid html links

Parameters:

$pPath

path given by getPigeonholePath()

Returns:: the link to display the page.

Definition at line 378 of file Pigeonholes.php.

References $gBitSystem, $ret, title, and BitBase::verifyId().

Referenced by getList(), and load().

Here is the call graph for this function:

Pigeonholes::getDisplayUrl	(	$	pContentId = `NULL`,
		$	pMixed = `NULL`
	)

Generates the URL to this pigeonhole

Parameters:

$pContentId

is the pigeonhole id we want to see

Returns:: the link to display the page.

Reimplemented from LibertyContent.

Definition at line 860 of file Pigeonholes.php.

References $gBitSystem, $ret, mContentId, and BitBase::verifyId().

Referenced by load().

Here is the call graph for this function:

Pigeonholes::getList ( &$ pListHash )

get list of all pigeonholes

Parameters:

	$pListHash	contains array of items used to limit search results
	$pListHash[sort_mode]	column and orientation by which search results are sorted
	$pListHash[find]	search for a pigeonhole title - case insensitive
	$pListHash[max_records]	maximum number of rows to return
	$pListHash[offset]	number of results data is offset by
	$pListHash[title]	pigeonhole name
	$pListHash[parent_id]	pigeonhole parent_id, optional
	$pListHash[root_structure_id]	only load the pigoenhole this root_structure_id is part of
	$pListHash[load_only_root]	only load top most items
	$pListHash[parent_content_id]	all the sons of the pigeonhole parent content_id , optional
	$pListHash[load_also_root]	if parent_content_id is set load also the father, optionnal

Returns:: array of pigeonholes in 'data' and count of pigeonholes in 'cant' public

Definition at line 405 of file Pigeonholes.php.

References $gBitSystem, $gBitUser, $query, $result, $ret, alphabetiseMembers(), editor, getDisplayLink(), getDisplayPath(), getMemberList(), getPigeonholePath(), BitUser::getTitle(), mDb, LibertyContent::parseData(), BitBase::postGetList(), LibertyContent::prepGetList(), title, and BitBase::verifyId().

Here is the call graph for this function:

Pigeonholes::getMemberList ( $ pListHash = NULL )

get all content inserted in a given pigeonhole. if no id is given, it gets all content for all pigeonholes

Parameters:

$pContentId

content id of the pigeonhole

Returns:: array of pigeonhole members with according title and content type guid public

Definition at line 120 of file Pigeonholes.php.

References $contentTypes, $gBitSystem, $gBitUser, $gLibertySystem, $query, $result, $ret, $type, FALSE, LibertyContent::isViewable(), mContentId, mDb, mPackages, title, and BitBase::verifyId().

Referenced by getList(), and load().

Here is the call graph for this function:

Pigeonholes::getPigeonholePath ( $ pStructureId = NULL )

get the path of a pigeonhole

Parameters:

$pStructureId

structure id of pigeonhole, if no id is given, it gets the id from $this->mStructureId

Returns:: path in form of an array public

Definition at line 356 of file Pigeonholes.php.

References $gStructure, $ret, FALSE, and BitBase::verifyId().

Referenced by getList(), getPigeonholesPathList(), and load().

Here is the call graph for this function:

Pigeonholes::getPigeonholesFromContentId ( $ pContentId )

get all pigeonholes where the contenent has been inserted

Parameters:

$pContentId

content id of item in question

Returns:: basic information about item requested public

Definition at line 338 of file Pigeonholes.php.

References $query, $ret, FALSE, mDb, and BitBase::verifyId().

Referenced by getPigeonholesPathList().

Here is the call graph for this function:

Pigeonholes::getPigeonholesPathList	(	$	pContentId = `NULL`,
		$	pTruncate = `FALSE`
	)

get an array of paths for all pigeonholes. used for pages where data can be inserted into pigeonholes

Parameters:

	numeric	$pContentId content id of pigeonhole.
	numeric	$pTruncate Setting this to a number will do some smart truncations depending on how many parents there are setting it to 60 will allow 30 chars for all parents combined and 30 for the actual title public

Returns:: TRUE on success, FALSE if there is no pigeonhole We need to sort the returned values that successive pigoenholes are grouped together.

Definition at line 277 of file Pigeonholes.php.

References $count, $gBitSystem, $query, $result, $ret, FALSE, getPigeonholePath(), getPigeonholesFromContentId(), mDb, pigeonholes_pathlist_sorter(), title, and BitBase::verifyId().

Here is the call graph for this function:

Pigeonholes::insertPigeonholeMember ( &$ pParamHash )

Store pigeonhole member

Parameters:

	$pParamHash	an array of content to be stored.
	$pParamHash[parent_id]	id of pigeonhole it belongs to, default is $this->mContentId
	$pParamHash[content_id]	content_id of the item to be stored

Returns:: bool TRUE on success, FALSE if store could not occur. If FALSE, $this->mErrors will have reason why public

Definition at line 718 of file Pigeonholes.php.

References $item, $pParamHash, $result, mDb, and verifyPigeonholeMember().

Referenced by store().

Here is the call graph for this function:

Pigeonholes::load	(	$	pExtras = `FALSE`,
		$	pLoadAttachable = `TRUE`
	)

load the pigeonhole

Parameters:

$pExtras

boolean - if set to true, pigeonhole content is added as well

Returns:: bool TRUE on success, FALSE if it's not valid public

Definition at line 69 of file Pigeonholes.php.

References $gBitSystem, $query, $result, $row, editor, getDisplayLink(), getDisplayPath(), getDisplayUrl(), getMemberList(), getPigeonholePath(), BitUser::getTitle(), LibertyAttachable::load(), mContentId, mDb, mInfo, LibertyContent::parseData(), and BitBase::verifyId().

Referenced by expunge(), store(), and verify().

Here is the call graph for this function:

Pigeonholes::Pigeonholes	(	$	pStructureId = `NULL`,
		$	pContentId = `NULL`
	)

initiate class

Parameters:

	$pContentId	content id of the pigeonhole - use either one of the ids.
	$pStructureId	structure id of the pigeonhole - use either one of the ids.

Returns:: none public

Definition at line 43 of file Pigeonholes.php.

References LibertyAttachable::LibertyAttachable(), mContentId, and LibertyContent::registerContentType().

Here is the call graph for this function:

Pigeonholes::store ( &$ pParamHash )

Store pigeonhole data

Parameters:

	$pParamHash	contains all data to store the pigeonholes
	$pParamHash[title]	title of the new pigeonhole
	$pParamHash[edit]	description of the pigeonhole
	$pParamHash[members]	array of content_ids that are associated with this pigeonhole
	$pParamHash[root_structure_id]	if this is set, it will add the pigeonhole to this structure. if it's not set, a new structure / top level pigeonhole is created
	$pParamHash[parent_id]	set the structure_id that will server as the parent in the structure

Returns:: bool TRUE on success, FALSE if store could not occur. If FALSE, $this->mErrors will have reason why public

Reimplemented from LibertyAttachable.

Definition at line 581 of file Pigeonholes.php.

References $gStructure, $pParamHash, $result, expungePigeonholeMember(), insertPigeonholeMember(), load(), mContentId, mDb, LibertyAttachable::store(), and verify().

Here is the call graph for this function:

Pigeonholes::verify ( &$ pParamHash )

verify, clean up and prepare data to be stored

Parameters:

$pParamHash

all information that is being stored. will update $pParamHash by reference with fixed array of itmes

Returns:: bool TRUE on success, FALSE if store could not occur. If FALSE, $this->mErrors will have reason why private

Reimplemented from LibertyAttachable.

Definition at line 633 of file Pigeonholes.php.

References $gBitSystem, $i, $pParamHash, LibertyContent::isValid(), load(), mContentId, mInfo, title, and BitBase::verifyId().

Referenced by store().

Here is the call graph for this function:

Pigeonholes::verifyPigeonholeMember ( &$ pParamHash )

verify, clean up and prepare data to be stored

Parameters:

$pParamHash

all information that is being stored. will update $pParamHash by reference with fixed array of itmes

Returns:: bool TRUE on success, FALSE if store could not occur. If FALSE, $this->mErrors will have reason why private

Definition at line 735 of file Pigeonholes.php.

References $item, $pParamHash, $tmp, mContentId, mDb, tra(), and BitBase::verifyId().

Referenced by insertPigeonholeMember().

Here is the call graph for this function:


Public Member Functions
	alphabetiseMembers (&$pMememberHash)
	checkPathPermissions ($pPath)
	expunge ($pStructureId=NULL)
	expungePigeonholeMember ($pParamHash)
	getAssignableContent (&$pListHash)
	getDisplayLink ($pTitle=NULL, $pMixed=NULL)
	getDisplayPath ($pPath)
	getDisplayUrl ($pContentId=NULL, $pMixed=NULL)
	getList (&$pListHash)
	getMemberList ($pListHash=NULL)
	getPigeonholePath ($pStructureId=NULL)
	getPigeonholesFromContentId ($pContentId)
	getPigeonholesPathList ($pContentId=NULL, $pTruncate=FALSE)
	insertPigeonholeMember (&$pParamHash)
	load ($pExtras=FALSE, $pLoadAttachable=TRUE)
	Pigeonholes ($pStructureId=NULL, $pContentId=NULL)
	store (&$pParamHash)
	verify (&$pParamHash)
	verifyPigeonholeMember (&$pParamHash)

Pigeonholes Class Reference

Public Member Functions

Detailed Description

Member Function Documentation