Class cdeAllConstants

# $firstLast	Array containing first and last constant names, for each displayed page
# $pageIndex2	Part of 'page index' (links to other constant pages) common to all pages
# $sortedConstants	Alphabetical array of constants

Instance methods

# computeFirstLast()	Computes `$first_last`
# computeIndex()	Returns the HTML code of method index (links to other pages containing methods)
# computeIndex2()	Auxiliary method of `computeIndex()`
+ generateContents()	Generates pages containing non-object constant lists
# sortConstants()	Computes `$sortedConstants`

Details

Instance fields

$firstLast

protected $firstLast = ''

Array containing first and last constant names, for each displayed page
Each entry is an associative array with 2 elements : 'first' and 'last'

Defined in helpers/contentsGenerators/default/cdeAllConstants.php, line 29

$pageIndex2

protected $pageIndex2 = ''

Part of 'page index' (links to other constant pages) common to all pages

Defined in helpers/contentsGenerators/default/cdeAllConstants.php, line 32

$sortedConstants

protected $sortedConstants

Alphabetical array of constants
Array containing the sorted indices of $this->docu->data['constants']
Ex : if $this->docu->data['constants'][0] contains 'ZZZ'
[1] contains 'AAA'
[2] contains 'TOTO'
$sortedConstants will be array(1, 2, 0)

Defined in helpers/contentsGenerators/default/cdeAllConstants.php, line 23

Instance methods

computeFirstLast()

protected function computeFirstLast( $n $nbPerPage $nbPages)

Computes $first_last

Parameters

`$n`	Nb of constants in the documented API
`$nbPerPage`	Number of constants listed in a page
`$nbPages`	Nb of pages containing constants lists

Defined in helpers/contentsGenerators/default/cdeAllConstants.php, line 141

computeIndex()

protected function computeIndex( $i $n $nbPerPage $nbPages)

Returns the HTML code of method index (links to other pages containing methods)
Note : this index is variable only because of prev / next links

Parameters

`$i`
`$n`	Nb of class methods in the documented API
`$nbPerPage`	Number of method listed in a page
`$nbPages`	Nb of pages containing method lists

Pre $firstLast must have been computed

Defined in helpers/contentsGenerators/default/cdeAllConstants.php, line 168

computeIndex2()

protected function computeIndex2( $n $nbPerPage $nbPages)

Auxiliary method of computeIndex()
Computes the fixed part of page index (common to all method pages).

Parameters

`$n`
`$nbPerPage`
`$nbPages`

Defined in helpers/contentsGenerators/default/cdeAllConstants.php, line 203

generateContents()

public function generateContents( )

Generates pages containing non-object constant lists

Overrides ContentsGenerator->generateContents()

Defined in helpers/contentsGenerators/default/cdeAllConstants.php, line 39

sortConstants()

protected function sortConstants( )

Computes $sortedConstants

Defined in helpers/contentsGenerators/default/cdeAllConstants.php, line 123