Référence de la classe Modules

Fonctions membres publiques
	templates ($clientId=0, $state='')
	types ()
	templateStates ()
	state ($value, $i, $enabled=true, $checkbox='cb')
	positions ($clientId, $state=1, $selectedPosition='')
	batchOptions ()
	positionList ($clientId=0)

Description détaillée

HTMLHelper module helper class.

Depuis

1.6

Documentation des fonctions membres

batchOptions()

batchOptions

(

)

Get a select with the batch action options

Renvoie

void

Références $options, Text\_(), et HTMLHelper\_().

positionList()

positionList

(

$clientId = 0

)

Method to get the field options.

Paramètres

integer

$clientId

The client ID

Renvoie

array The field option objects.

Depuis

2.5

Obsolète:

5.0 Will be removed with no replacement

Références $clientId, $db, $options, $query, Factory\getApplication(), Factory\getDbo(), ParameterType\INTEGER, et text.

positions()

positions	(		$clientId,
			$state = 1,
			$selectedPosition = ''
	)

Display a batch widget for the module position selector.

Paramètres

integer	$clientId	The client ID.
integer	$state	The state of the module (enabled, unenabled, trashed).
string	$selectedPosition	The currently selected position for the module.

Renvoie

string The necessary positions for the widget.

Depuis

2.5

Références $app, $clientId, $option, $options, $position, $positions, $state, $template, $text, Text\_(), HTMLHelper\_(), ModulesHelper\createOption(), ModulesHelper\createOptionGroup(), Factory\getApplication(), ModulesHelper\getPositions(), TemplatesHelper\getPositions(), ModulesHelper\getTemplates(), ModulesHelper\getTranslatedModulePosition(), et ArrayHelper\sortObjects().

state()

state	(		$value,
			$i,
			$enabled = true,
			$checkbox = 'cb'
	)

Returns a published state on a grid

Paramètres

integer	$value	The state value.
integer	$i	The row index
boolean	$enabled	An optional setting for access control on the action.
string	$checkbox	An optional prefix for checkboxes.

Renvoie

string The Html code

Voir également

HTMLHelperJGrid::state

Depuis

1.7.1

Références $enabled, $i, $value, et HTMLHelper\_().

templates()

templates	(		$clientId = 0,
			$state = ''
	)

Builds an array of template options

Paramètres

integer	$clientId	The client id.
string	$state	The state of the template.

Renvoie

array

Références $clientId, $options, $state, $template, HTMLHelper\_(), et ModulesHelper\getTemplates().

templateStates()

templateStates

(

)

Builds an array of template state options

Renvoie

array

Références $options, et HTMLHelper\_().

types()

types

(

)

Builds an array of template type options

Renvoie

array

Références $options, et HTMLHelper\_().

---

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

• Modules.php