"TYPO3 4.0.1: t3lib_admin Class Reference", "datetime" => "Sat Dec 2 19:25:43 2006", "date" => "2 Dec 2006", "doxygenversion" => "1.4.6", "projectname" => "TYPO3 4.0.1", "projectnumber" => "4.0.1" ); get_header($doxygen_vars); ?>

t3lib_admin Class Reference

List of all members.

Public Member Functions

 genTree ($theID, $depthData, $versions=FALSE)
 genTree_records ($theID, $depthData, $table='', $versions=FALSE)
 genTreeStatus ()
 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)

Public Attributes

 $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 = ''

Detailed Description

Definition at line 93 of file class.t3lib_admin.php.

Member Function Documentation

t3lib_admin::countRecords (  $  pid_list  ) 
 

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

Parameters:
string list of pid's (page-record uid's). This list is probably made by genTree()
Returns:
array an array with the number of records from all $TCA-tables that are attached to a PID in the pid-list.

Definition at line 367 of file class.t3lib_admin.php.

References t3lib_BEfunc::deleteClause(), and t3lib_div::loadTCA().

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.

Parameters:
string Database tablename
integer The uid of the record which will have the PID value set to 0 (zero)
Returns:
boolean True if done.

Definition at line 346 of file class.t3lib_admin.php.

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.

Parameters:
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!
Returns:
void

Definition at line 128 of file class.t3lib_admin.php.

References t3lib_div::fixed_lgd_cs(), genTree_records(), t3lib_iconWorks::getIconImage(), and t3lib_extMgm::isLoaded().

Referenced by genTreeStatus().

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

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

Definition at line 217 of file class.t3lib_admin.php.

References t3lib_BEfunc::deleteClause(), t3lib_BEfunc::getCommonSelectFields(), t3lib_iconWorks::getIconImage(), and t3lib_BEfunc::getRecordTitle().

Referenced by genTree().

t3lib_admin::genTreeStatus (   ) 
 

[Describe function...]

Returns:
[type] ...

Definition at line 292 of file class.t3lib_admin.php.

References genTree().

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

Parameters:
string Table name
Returns:
array

Definition at line 452 of file class.t3lib_admin.php.

References t3lib_div::loadTCA().

t3lib_admin::getFileFields (  $  uploadfolder  ) 
 

Finds all fields that hold filenames from uploadfolder

Parameters:
string Path to uploadfolder
Returns:
array An array with all fields listed that have references to files in the $uploadfolder

Definition at line 429 of file class.t3lib_admin.php.

References t3lib_div::loadTCA().

t3lib_admin::getGroupFields (  $  mode  ) 
 

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

Parameters:
string $mode = file, $mode = db, $mode = '' (all...)
Returns:
array An array with all fields listed that somehow are references to other records (foreign-keys) or files

Definition at line 395 of file class.t3lib_admin.php.

References t3lib_div::loadTCA().

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.

Parameters:
string list of pid's (page-record uid's). This list is probably made by genTree()
Returns:
void

Definition at line 315 of file class.t3lib_admin.php.

References t3lib_div::loadTCA().

t3lib_admin::selectNonEmptyRecordsWithFkeys (  $  fkey_arrays  ) 
 

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

Parameters:
array Array with tables/fields generated by getGroupFields()
Returns:
void
See also:
getGroupFields()

Definition at line 480 of file class.t3lib_admin.php.

References t3lib_extMgm::isLoaded(), t3lib_div::loadTCA(), and t3lib_div::makeInstance().

t3lib_admin::testDBRefs (  $  theArray  ) 
 

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

Parameters:
array Table with key/value pairs being table names and arrays with uid numbers
Returns:
string HTML Error message

Definition at line 620 of file class.t3lib_admin.php.

References t3lib_BEfunc::deleteClause().

t3lib_admin::testFileRefs (   ) 
 

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

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

Definition at line 569 of file class.t3lib_admin.php.

t3lib_admin::whereIsFileReferenced (  $  uploadfolder,
$  filename
) 
 

Finding all references to file based on uploadfolder / filename

Parameters:
string Upload folder where file is found
string Filename to search for
Returns:
array Array with other arrays containing information about where references was found

Definition at line 695 of file class.t3lib_admin.php.

t3lib_admin::whereIsRecordReferenced (  $  searchTable,
$  id
) 
 

Finding all references to record based on table/uid

Parameters:
string Table name
integer Uid of database record
Returns:
array Array with other arrays containing information about where references was found

Definition at line 658 of file class.t3lib_admin.php.

References t3lib_div::loadTCA(), and t3lib_div::makeInstance().

Member Data Documentation

t3lib_admin::$recStats
 

Initial value:

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

Definition at line 111 of file class.t3lib_admin.php.

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