TYPO3 API  SVNRelease
Public Member Functions | Public Attributes
t3lib_admin Class Reference

List of all members.

Public Member Functions

 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)
 testFileRefs ()
 testDBRefs ($theArray)
 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()
 $genTree_HTML = ''
 $backPath = ''
 $checkFileRefs = array()
 $checkSelectDBRefs = array()
 $checkGroupDBRefs = array()
 $recStats
 $lRecords = array()
 $lostPagesList = ''

Detailed Description

Definition at line 75 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:
stringlist 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 390 of file class.t3lib_admin.php.

References $GLOBALS, $TCA, 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:
stringDatabase tablename
integerThe uid of the record which will have the PID value set to 0 (zero)
Returns:
boolean True if done.

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

References $GLOBALS.

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:
integera pid (page-record id) from which to start making the tree
stringHTML-code (image-tags) used when this function calls itself recursively.
booleanInternal variable, don't set from outside!
Returns:
void

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

References $GLOBALS, $res, $row, t3lib_div\fixed_lgd_cs(), genTree_records(), t3lib_iconWorks\getSpriteIconForRecord(), t3lib_extMgm\isLoaded(), and t3lib_iconWorks\skinImg().

Referenced by genTreeStatus().

t3lib_admin::genTree_records ( theID,
depthData,
table = '',
versions = FALSE 
)
Parameters:
integera pid (page-record id) from which to start making the tree
stringHTML-code used when this function calls itself recursively.
stringTable to get the records from
boolInternal variable, don't set from outside!
Returns:
void

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

References $GLOBALS, $res, $row, $TCA, t3lib_BEfunc\deleteClause(), t3lib_BEfunc\getCommonSelectFields(), t3lib_BEfunc\getRecordTitle(), t3lib_iconWorks\getSpriteIconForRecord(), and t3lib_iconWorks\skinImg().

Referenced by genTree().

t3lib_admin::genTreeStatus ( root = 0)

Generates tree and returns statistics

Returns:
array Record statistics

Definition at line 311 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:
stringTable name
Returns:
array

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

References $TCA, and t3lib_div\loadTCA().

t3lib_admin::getFileFields ( uploadfolder)

Finds all fields that hold filenames from uploadfolder

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

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

References $TCA, and t3lib_div\loadTCA().

Referenced by whereIsFileReferenced().

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 424 of file class.t3lib_admin.php.

References $TCA, and 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:
stringlist of pid's (page-record uid's). This list is probably made by genTree()
Returns:
void

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

References $GLOBALS, $row, $TCA, and t3lib_div\loadTCA().

t3lib_admin::testDBRefs ( theArray)

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

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

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

References $GLOBALS, $row, $TCA, and 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 594 of file class.t3lib_admin.php.

References $GLOBALS, $value, and whereIsFileReferenced().

t3lib_admin::whereIsFileReferenced ( uploadfolder,
filename 
)

Finding all references to file based on uploadfolder / filename

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

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

References $GLOBALS, $row, $TCA, and getFileFields().

Referenced by testFileRefs().


Member Data Documentation

t3lib_admin::$backPath = ''

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

t3lib_admin::$checkFileRefs = array()

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

t3lib_admin::$checkGroupDBRefs = array()

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

t3lib_admin::$checkSelectDBRefs = array()

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

t3lib_admin::$genTree_HTML = ''

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

t3lib_admin::$genTree_includeDeleted = TRUE

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

t3lib_admin::$genTree_includeRecords = FALSE

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

t3lib_admin::$genTree_includeVersions = TRUE

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

t3lib_admin::$genTree_makeHTML = 0

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

t3lib_admin::$lostPagesList = ''

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

t3lib_admin::$lRecords = array()

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

t3lib_admin::$page_idArray = array()

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

t3lib_admin::$perms_clause = ''

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

t3lib_admin::$rec_idArray = array()

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

t3lib_admin::$recStats
Initial value:
 array(
        'allValid' => array(),
        'published_versions' => array(),
        'deleted' => array(),
    )

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


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