Solutions Open Source

Référence de la classe recordList

Graphe d'héritage de recordList:

[légende]

Graphe de collaboration de recordList:

[légende]

Liste de tous les membres

Fonctions membres publiques
	start ($id, $table, $pointer, $search="", $levels="", $showLimit=0)
	generateList ()
	getSearchBox ($formFields=1)
	showSysNotesForPage ()
	setDispFields ()
	thumbCode ($row, $table, $field)
	makeQueryArray ($table, $id, $addWhere="", $fieldList='*')
	setTotalItems ($queryParts)
	makeSearchString ($table)
	linkWrapTable ($table, $code)
	linkWrapItems ($table, $uid, $code, $row)
	linkUrlMail ($code, $testString)
	listURL ($altId='', $table=-1, $exclList='')
	requestUri ()
	makeFieldList ($table, $dontCheckUser=0)
	getTreeObject ($id, $depth, $perms_clause)
	localizationRedirect ($justLocalized)
Attributs publics
	$tableList = ''
	$returnUrl = ''
	$thumbs = 0
	$itemsLimitPerTable = 20
	$itemsLimitSingleTable = 100
	$widthGif = '<img src="clear.gif" width="1" height="4" hspace="160" alt="" />'
	$script = 'db_list.php'
	$allFields = 0
	$localizationView = FALSE
	$csvOutput = FALSE
	$sortField
	$sortRev
	$displayFields
	$duplicateField
	$id
	$table = ''
	$listOnlyInSingleTableMode = FALSE
	$firstElementNumber = 0
	$searchString = ''
	$searchLevels = ''
	$showLimit = 0
	$pidSelect = ''
	$perms_clause = ''
	$calcPerms = 0
	$clickTitleMode = ''
	$modSharedTSconfig = array()
	$pageRecord = array()
	$hideTables = ''
	$JScode = ''
	$HTMLcode = ''
	$iLimit = 0
	$eCounter = 0
	$totalItems = ''
	$recPath_cache = array()
	$setFields = array()
	$currentTable = array()
	$duplicateStack = array()

---

Documentation des fonctions membres

recordList::start	(	$	id,
		$	table,
		$	pointer,
		$	search = "",
		$	levels = "",
		$	showLimit = 0
	)

Initializes the list generation

Paramètres:

	integer	Page id for which the list is rendered. Must be >= 0
	string	Tablename - if extended mode where only one table is listed at a time.
	integer	Browsing pointer.
	string	Search word, if any
	integer	Number of levels to search down the page tree
	integer	Limit of records to be listed.

Renvoie:

void

recordList::generateList

(

)

Traverses the table(s) to be listed and renders the output code for each: The HTML is accumulated in $this->HTMLcode Finishes off with a stopper-gif

Renvoie:

void

recordList::getSearchBox

(

$

formFields = 1

)

Creates the search box

Paramètres:

boolean

If true, the search box is wrapped in its own form-tags

Renvoie:

string HTML for the search box

recordList::showSysNotesForPage

(

)

Creates the display of sys_notes for the page. Relies on the "sys_note" extension to be loaded.

Renvoie:

string HTML for the sys-notes (if any)

recordList::setDispFields

(

)

Setting the field names to display in extended list. Sets the internal variable $this->setFields

Renvoie:

void

recordList::thumbCode	(	$	row,
		$	table,
		$	field
	)

Create thumbnail code for record/field

Paramètres:

	array	Record array
	string	Table (record is from)
	string	Field name for which thumbsnail are to be rendered.

Renvoie:

string HTML for thumbnails, if any.

recordList::makeQueryArray	(	$	table,
		$	id,
		$	addWhere = "",
		$	fieldList = '*'
	)

Returns the SQL-query array to select the records from a table $table with pid = $id

Paramètres:

	string	Table name
	integer	Page id (NOT USED! $this->pidSelect is used instead)
	string	Additional part for where clause
	string	Field list to select, * for all (for "SELECT [fieldlist] FROM ...")

Renvoie:

array Returns query array

recordList::setTotalItems

(

$

queryParts

)

Based on input query array (query for selecting count(*) from a table) it will select the number of records and set the value in $this->totalItems

Paramètres:

array

Query array

Renvoie:

void

Voir également:

makeQueryArray()

recordList::makeSearchString

(

$

table

)

Creates part of query for searching after a word ($this->searchString) fields in input table

Paramètres:

string

Table, in which the fields are being searched.

Renvoie:

string Returns part of WHERE-clause for searching, if applicable.

recordList::linkWrapTable	(	$	table,
		$	code
	)

Returns the title (based on $code) of a table ($table) with the proper link around. For headers over tables. The link will cause the display of all extended mode or not for the table.

Paramètres:

	string	Table name
	string	Table label

Renvoie:

string The linked table label

Réimplémentée dans TBE_browser_recordList.

recordList::linkWrapItems	(	$	table,
		$	uid,
		$	code,
		$	row
	)

Returns the title (based on $code) of a record (from table $table) with the proper link around (that is for 'pages'-records a link to the level of that record...)

Paramètres:

	string	Table name
	integer	Item uid
	string	Item title (not htmlspecialchars()'ed yet)
	array	Item row

Renvoie:

string The item title. Ready for HTML output (is htmlspecialchars()'ed)

Réimplémentée dans TBE_browser_recordList.

recordList::linkUrlMail	(	$	code,
		$	testString
	)

Wrapping input code in link to URL or email if $testString is either.

Paramètres:

	string	code to wrap
	string	String which is tested for being a URL or email and which will be used for the link if so.

Renvoie:

string Link-Wrapped $code value, if $testString was URL or email.

recordList::listURL	(	$	altId = '',
		$	table = -1,
		$	exclList = ''
	)

Creates the URL to this script, including all relevant GPvars Fixed GPvars are id, table, imagemode, returlUrl, search_field, search_levels and showLimit The GPvars "sortField" and "sortRev" are also included UNLESS they are found in the $exclList variable.

Paramètres:

	string	Alternative id value. Enter blank string for the current id ($this->id)
	string	Tablename to display. Enter "-1" for the current table.
	string	Commalist of fields NOT to include ("sortField" or "sortRev")

Renvoie:

string URL

Réimplémentée dans TBE_browser_recordList.

recordList::requestUri

(

)

Returns "requestUri" - which is basically listURL

Renvoie:

string Content of ->listURL()

recordList::makeFieldList	(	$	table,
		$	dontCheckUser = 0
	)

Makes the list of fields to select for a table

Paramètres:

	string	Table name
	boolean	If set, users access to the field (non-exclude-fields) is NOT checked.

Renvoie:

array Array, where values are fieldnames to include in query

recordList::getTreeObject	(	$	id,
		$	depth,
		$	perms_clause
	)

Creates an instance of t3lib_pageTree which will select a page tree to $depth and return the object. In that object we will find the ids of the tree.

Paramètres:

	integer	Page id.
	integer	Depth to go down.
	string	Select clause

Renvoie:

object t3lib_pageTree instance with created list of ids.

recordList::localizationRedirect

(

$

justLocalized

)

Redirects to TCEforms (alt_doc) if a record is just localized.

Paramètres:

string

string with table, orig uid and language separated by ":"

Renvoie:

void

---

Documentation des données membres

recordList::$tableList = ''

recordList::$returnUrl = ''

recordList::$thumbs = 0

recordList::$itemsLimitPerTable = 20

recordList::$itemsLimitSingleTable = 100

recordList::$widthGif = '<img src="clear.gif" width="1" height="4" hspace="160" alt="" />'

recordList::$script = 'db_list.php'

Réimplémentée à partir de t3lib_recordList.

recordList::$allFields = 0

recordList::$localizationView = FALSE

recordList::$csvOutput = FALSE

Réimplémentée dans localRecordList.

recordList::$sortField

recordList::$sortRev

recordList::$displayFields

recordList::$duplicateField

recordList::$id

recordList::$table = ''

recordList::$listOnlyInSingleTableMode = FALSE

recordList::$firstElementNumber = 0

Réimplémentée à partir de t3lib_recordList.

recordList::$searchString = ''

recordList::$searchLevels = ''

recordList::$showLimit = 0

recordList::$pidSelect = ''

recordList::$perms_clause = ''

recordList::$calcPerms = 0

recordList::$clickTitleMode = ''

recordList::$modSharedTSconfig = array()

recordList::$pageRecord = array()

recordList::$hideTables = ''

recordList::$JScode = ''

recordList::$HTMLcode = ''

Réimplémentée à partir de t3lib_recordList.

recordList::$iLimit = 0

Réimplémentée à partir de t3lib_recordList.

recordList::$eCounter = 0

Réimplémentée à partir de t3lib_recordList.

recordList::$totalItems = ''

Réimplémentée à partir de t3lib_recordList.

recordList::$recPath_cache = array()

recordList::$setFields = array()

recordList::$currentTable = array()

recordList::$duplicateStack = array()

Réimplémentée dans localRecordList.

---

La documentation de cette classe a été générée à partir du fichier suivant :

• Z:/doxygen/typo3_src-4.1.2/typo3/class.db_list.inc

---