t3lib_admin Klassenreferenz

Aufstellung aller Elemente

Öffentliche Methoden
	genTree ($theID, $depthData, $versions=FALSE)
	genTree_records ($theID, $depthData, $table='', $versions=FALSE)
	genTreeStatus ($root=0)
	lostRecords ($pid_list)
	fixLostRecord ($table, $uid)
	countRecords ($pid_list)
	getGroupFields ($mode)
	getFileFields ($uploadfolder)
	getDBFields ($theSearchTable)
	selectNonEmptyRecordsWithFkeys ($fkey_arrays)
	testFileRefs ()
	testDBRefs ($theArray)
	whereIsRecordReferenced ($searchTable, $id)
	whereIsFileReferenced ($uploadfolder, $filename)
Öffentliche Attribute
	$genTree_includeDeleted = TRUE
	$genTree_includeVersions = TRUE
	$genTree_includeRecords = FALSE
	$perms_clause = ''
	$genTree_makeHTML = 0
	$page_idArray = Array()
	$rec_idArray = Array()
	$getTree_HTML = ''
	$backPath = ''
	$checkFileRefs = Array()
	$checkSelectDBRefs = Array()
	$checkGroupDBRefs = Array()
	$recStats
	$lRecords = Array()
	$lostPagesList = ''

---

Dokumentation der Elementfunktionen

t3lib_admin::countRecords

(

$

pid_list

)

Counts records from $TCA-tables that ARE attached to an existing page.

Parameter:

string

list of pid's (page-record uid's). This list is probably made by genTree()

Rückgabe:

array an array with the number of records from all $TCA-tables that are attached to a PID in the pid-list.

t3lib_admin::fixLostRecord	(	$	table,
		$	uid
	)

Fixes lost record from $table with uid $uid by setting the PID to zero. If there is a disabled column for the record that will be set as well.

Parameter:

	string	Database tablename
	integer	The uid of the record which will have the PID value set to 0 (zero)

Rückgabe:

boolean True if done.

t3lib_admin::genTree	(	$	theID,
		$	depthData,
		$	versions = FALSE
	)

Generates a list of Page-uid's that corresponds to the tables in the tree. This list should ideally include all records in the pages-table.

Parameter:

	integer	a pid (page-record id) from which to start making the tree
	string	HTML-code (image-tags) used when this function calls itself recursively.
	boolean	Internal variable, don't set from outside!

Rückgabe:

void

t3lib_admin::genTree_records	(	$	theID,
		$	depthData,
		$	table = '',
		$	versions = FALSE
	)

Parameter:

	[type]	$theID: ...
	[type]	$depthData: ...
	[type]	$table: ...
	[type]	$versions: ...

Rückgabe:

[type] ...

t3lib_admin::genTreeStatus

(

$

root = 0

)

[Describe function...]

Rückgabe:

[type] ...

t3lib_admin::getDBFields

(

$

theSearchTable

)

Returns an array with arrays of table/field pairs which are allowed to hold references to the input table name - according to $TCA

Parameter:

string

Table name

Rückgabe:

array

t3lib_admin::getFileFields

(

$

uploadfolder

)

Finds all fields that hold filenames from uploadfolder

Parameter:

string

Path to uploadfolder

Rückgabe:

array An array with all fields listed that have references to files in the $uploadfolder

t3lib_admin::getGroupFields

(

$

mode

)

Finding relations in database based on type 'group' (files or database-uid's in a list)

Parameter:

string

$mode = file, $mode = db, $mode = '' (all...)

Rückgabe:

array An array with all fields listed that somehow are references to other records (foreign-keys) or files

t3lib_admin::lostRecords

(

$

pid_list

)

Fills $this->lRecords with the records from all tc-tables that are not attached to a PID in the pid-list.

Parameter:

string

list of pid's (page-record uid's). This list is probably made by genTree()

Rückgabe:

void

t3lib_admin::selectNonEmptyRecordsWithFkeys

(

$

fkey_arrays

)

This selects non-empty-records from the tables/fields in the fkey_array generated by getGroupFields()

Parameter:

array

Array with tables/fields generated by getGroupFields()

Rückgabe:

void

Siehe auch:

getGroupFields()

t3lib_admin::testDBRefs

(

$

theArray

)

Depends on selectNonEmpty.... to be executed first!!

Parameter:

array

Table with key/value pairs being table names and arrays with uid numbers

Rückgabe:

string HTML Error message

t3lib_admin::testFileRefs

(

)

Depends on selectNonEmpty.... to be executed first!!

Rückgabe:

array Report over files; keys are "moreReferences", "noReferences", "noFile", "error"

t3lib_admin::whereIsFileReferenced	(	$	uploadfolder,
		$	filename
	)

Finding all references to file based on uploadfolder / filename

Parameter:

	string	Upload folder where file is found
	string	Filename to search for

Rückgabe:

array Array with other arrays containing information about where references was found

t3lib_admin::whereIsRecordReferenced	(	$	searchTable,
		$	id
	)

Finding all references to record based on table/uid

Parameter:

	string	Table name
	integer	Uid of database record

Rückgabe:

array Array with other arrays containing information about where references was found

---

Dokumentation der Datenelemente

t3lib_admin::$recStats

Initialisierung:

 Array(
                'allValid' => array(),
                'published_versions' => array(),
                'deleted' => array(),
        )

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• /srv/www/vhosts/typo3.local/typo3_src-4.2.10/t3lib/class.t3lib_admin.php