StudipLitList Class Reference

Inheritance diagram for StudipLitList:

Collaboration diagram for StudipLitList:

Public Member Functions
	__construct ($range_id)
	init ()
	isElement ($id)
	getListIds ()
	getVisibleListIds ()
	getListEntries ($list_id)
	getNewListId ()
	getNewListElementId ()
	getFormattedEntry ($item_id, $fields=null)
	copyList ($list_id)
	insertElementBulk ($catalog_ids, $list_id)
	updateElement ($fields)
	insertElement ($fields)
	deleteElement ($element_id)
	updateList ($fields)
	insertList ($fields)
	deleteList ($list_id)
	triggerListChdate ($list_id)
	GetTabbedList ($range_id, $list_id)
	DeleteListsByRange ($range_id)
	GetListCountByRange ($range_id)
Public Member Functions inherited from TreeAbstract
	init ()
	storeItem ($item_id, $parent_id, $name, $priority)
	buildIndex ($item_id=false)
	getKids ($item_id)
	getNumKids ($item_id)
	getKidsKids ($item_id, $in_recursion=false)
	getNumKidsKids ($item_id, $in_recursion=false)
	isLastKid ($item_id)
	isFirstKid ($item_id)
	isChildOf ($ancestor_id, $item_id)
	hasKids ($item_id)
	getItemPath ($item_id)
	getParents ($item_id)
	getShortPath ($item_id, $length=null, $delimeter=">", $offset=0)
	getMaxPriority ($parent_id)
	getNumEntries ($item_id, $num_entries_from_kids=false)
	getNumEntriesKids ($item_id, $in_recursion=false)
	getValue ($item_id, $field)

Static Public Member Functions
static	GetListsByRange ($range_id, $format='default')
static	GetFormattedListsByRange ($range_id, $last_modified_since=false, $copy_link=true)
static	exportUserData (StoredUserData $storage)
Static Public Member Functions inherited from TreeAbstract
static	GetInstance ($class_name, $args=null, $invalidate_cache=false)

Data Fields
	$format_default = "**{authors}** - {dc_title} - %%{published}%%"
	$cat_element
	$range_id
	$range_type
Data Fields inherited from TreeAbstract
	$root_name
	$view
	$tree_data = []
	$tree_childs = []
	$tree_num_childs = []
	$index_offset = 0

Additional Inherited Members
Protected Member Functions inherited from TreeAbstract
	__construct ()

Constructor & Destructor Documentation

__construct()

__construct

(

$range_id

)

constructor

do not use directly, call TreeAbstract::GetInstance("StudipLitList", $range_id) @access private

Here is the call graph for this function:

Member Function Documentation

copyList()

copyList

(

$list_id

)

Here is the call graph for this function:

deleteElement()

deleteElement

(

$element_id

)

Here is the call graph for this function:

deleteList()

deleteList

(

$list_id

)

Here is the call graph for this function:

DeleteListsByRange()

DeleteListsByRange

(

$range_id

)

Here is the call graph for this function:

Here is the caller graph for this function:

exportUserData()

static exportUserData ( StoredUserData  $storage )

static

Export available data of a given user into a storage object (an instance of the StoredUserData class) for that user.

Parameters

StoredUserData

$storage

object to store data into

Here is the call graph for this function:

getFormattedEntry()

getFormattedEntry	(		$item_id,
			$fields = null
	)

Here is the call graph for this function:

GetFormattedListsByRange()

static GetFormattedListsByRange (   $range_id,   $last_modified_since = false,   $copy_link = true  )

static

Here is the call graph for this function:

Here is the caller graph for this function:

GetListCountByRange()

GetListCountByRange

(

$range_id

)

Here is the call graph for this function:

getListEntries()

getListEntries

(

$list_id

)

Here is the call graph for this function:

getListIds()

getListIds

(

)

Here is the call graph for this function:

GetListsByRange()

static GetListsByRange (   $range_id,   $format = 'default'  )

static

Here is the call graph for this function:

Here is the caller graph for this function:

getNewListElementId()

getNewListElementId

(

)

Here is the caller graph for this function:

getNewListId()

getNewListId

(

)

Here is the caller graph for this function:

GetTabbedList()

GetTabbedList	(		$range_id,
			$list_id
	)

Here is the call graph for this function:

Here is the caller graph for this function:

getVisibleListIds()

getVisibleListIds

(

)

Here is the call graph for this function:

init()

init

(

)

initializes the tree

stores all rows from table range_tree in array $tree_data @access public

Reimplemented from TreeAbstract.

Here is the call graph for this function:

insertElement()

insertElement

(

$fields

)

Here is the call graph for this function:

Here is the caller graph for this function:

insertElementBulk()

insertElementBulk	(		$catalog_ids,
			$list_id
	)

Here is the call graph for this function:

insertList()

insertList

(

$fields

)

Here is the call graph for this function:

Here is the caller graph for this function:

isElement()

isElement

(

$id

)

Here is the caller graph for this function:

triggerListChdate()

triggerListChdate

(

$list_id

)

Here is the caller graph for this function:

updateElement()

updateElement

(

$fields

)

Here is the call graph for this function:

updateList()

updateList

(

$fields

)

Here is the call graph for this function:

Field Documentation

$cat_element

$cat_element

$format_default

$format_default = "**{authors}** - {dc_title} - %%{published}%%"

$range_id

$range_id

$range_type

$range_type

---

The documentation for this class was generated from the following file:

• lib/classes/StudipLitList.class.php