Solutions Open Source

Référence de la classe tx_lowlevel_cleaner_core

Graphe d'héritage de tx_lowlevel_cleaner_core:

[légende]

Graphe de collaboration de tx_lowlevel_cleaner_core:

[légende]

Liste de tous les membres

Fonctions membres publiques
	tx_lowlevel_cleaner_core ()
	cli_main ($argv)
	cli_referenceIndexCheck ()
	cli_noExecutionCheck ($matchString)
	cli_printInfo ($header, $res)
	genTree ($rootID, $depth=1000, $echoLevel=0, $callBack='')
	genTree_traverse ($rootID, $depth, $echoLevel=0, $callBack='', $versionSwapmode='', $rootIsVersion=0, $accumulatedPath='')
	infoStr ($rec)
Attributs publics
	$genTree_traverseDeleted = TRUE
	$genTree_traverseVersions = TRUE
	$label_infoString = 'The list of records is organized as [table]:[uid]:[field]:[flexpointer]:[softref_key]'
	$pagetreePlugins = array()
	$cleanerModules = array()

---

Documentation des fonctions membres

tx_lowlevel_cleaner_core::tx_lowlevel_cleaner_core

(

)

Constructor

Renvoie:

void

tx_lowlevel_cleaner_core::cli_main

(

$

argv

)

CLI engine

Paramètres:

array

Command line arguments

Renvoie:

string

tx_lowlevel_cleaner_core::cli_referenceIndexCheck

(

)

Checks reference index

Renvoie:

boolean TRUE if reference index was OK (either OK, updated or ignored)

tx_lowlevel_cleaner_core::cli_noExecutionCheck

(

$

matchString

)

Paramètres:

[type]

$matchString: ...

Renvoie:

string If string, it's the reason for not executing. Returning FALSE means it should execute.

tx_lowlevel_cleaner_core::cli_printInfo	(	$	header,
		$	res
	)

Formats a result array from a test so it fits output in the shell

Paramètres:

	string	name of the test (eg. function name)
	array	Result array from an analyze function

Renvoie:

void Outputs with echo - capture content with output buffer if needed.

tx_lowlevel_cleaner_core::genTree	(	$	rootID,
		$	depth = 1000,
		$	echoLevel = 0,
		$	callBack = ''
	)

Traverses the FULL/part of page tree, mainly to register ALL validly connected records (to find orphans) but also to register deleted records, versions etc. Output (in $this->recStats) can be useful for multiple purposes.

Paramètres:

	integer	Root page id from where to start traversal. Use "0" (zero) to have full page tree (necessary when spotting orphans, otherwise you can run it on parts only)
	integer	Depth to traverse. zero is do not traverse at all. 1 = 1 sublevel, 1000= 1000 sublevels (all...)
	boolean	If >0, will echo information about the traversal process.
	string	Call back function (from this class or subclass)

Renvoie:

void

tx_lowlevel_cleaner_core::genTree_traverse	(	$	rootID,
		$	depth,
		$	echoLevel = 0,
		$	callBack = '',
		$	versionSwapmode = '',
		$	rootIsVersion = 0,
		$	accumulatedPath = ''
	)

Recursive traversal of page tree:

Paramètres:

	integer	Page root id (must be online, valid page record - or zero for page tree root)
	integer	Depth
	integer	Echo Level
	string	Call back function (from this class or subclass)
	string	DON'T set from outside, internal. (indicates we are inside a version of a page)
	integer	DON'T set from outside, internal. (1: Indicates that rootID is a version of a page, 2: ...that it is even a version of a version (which triggers a warning!)
	string	Internal string that accumulates the path

Renvoie:

void private

tx_lowlevel_cleaner_core::infoStr

(

$

rec

)

Compile info-string

Paramètres:

array

Input record from sys_refindex

Renvoie:

string String identifying the main record of the reference

---

Documentation des données membres

tx_lowlevel_cleaner_core::$genTree_traverseDeleted = TRUE

tx_lowlevel_cleaner_core::$genTree_traverseVersions = TRUE

tx_lowlevel_cleaner_core::$label_infoString = 'The list of records is organized as [table]:[uid]:[field]:[flexpointer]:[softref_key]'

tx_lowlevel_cleaner_core::$pagetreePlugins = array()

tx_lowlevel_cleaner_core::$cleanerModules = array()

---

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

• Z:/doxygen/typo3_src-4.1.2/typo3/sysext/lowlevel/class.tx_lowlevel_cleaner_core.php

---