Joomla Platform  13.1
Documentation des API du framework Joomla Platform
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JFormFieldFolderList
+ Graphe d'héritage de JFormFieldFolderList:
+ Graphe de collaboration de JFormFieldFolderList:

Liste de tous les membres

Fonctions membres publiques

 __get ($name)
 __set ($name, $value)
 setup (SimpleXMLElement $element, $value, $group=null)

Fonctions membres protégées

 getOptions ()
- Fonctions membres protégées inherited from JFormFieldList
 getInput ()
- Fonctions membres protégées inherited from JFormField
 getId ($fieldId, $fieldName)
 getTitle ()
 getLabel ()
 getName ($fieldName)
 getFieldName ($fieldName)

Attributs protégés

 $type = 'FolderList'
 $filter
 $exclude
 $hideNone = false
 $hideDefault = false
 $directory
- Attributs protégés inherited from JFormFieldList
- Attributs protégés inherited from JFormField
 $description
 $hint
 $autocomplete = 'on'
 $spellcheck = true
 $autofocus = false
 $element
 $form
 $formControl
 $hidden = false
 $translateLabel = true
 $translateDescription = true
 $translateHint = true
 $id
 $input
 $label
 $multiple = false
 $pattern
 $name
 $fieldname
 $group
 $required = false
 $disabled = false
 $readonly = false
 $validate
 $value
 $default
 $size
 $class
 $labelClass
 $onchange
 $onclick

Description détaillée

Définition à la ligne 22 du fichier folderlist.php.


Documentation des fonctions membres

JFormFieldFolderList::__get (   $name)

Method to get certain otherwise inaccessible properties from the form field object.

Paramètres:
string$nameThe property name for which to the the value.
Renvoie:
mixed The property value or null.
Depuis:
3.2

Réimplémentée à partir de JFormField.

Définition à la ligne 81 du fichier folderlist.php.

{
switch ($name)
{
case 'filter':
case 'exclude':
case 'hideNone':
case 'hideDefault':
case 'directory':
return $this->$name;
}
}
JFormFieldFolderList::__set (   $name,
  $value 
)

Method to set certain otherwise inaccessible properties of the form field object.

Paramètres:
string$nameThe property name for which to the the value.
mixed$valueThe value of the property.
Renvoie:
void
Depuis:
3.2

Réimplémentée à partir de JFormField.

Définition à la ligne 106 du fichier folderlist.php.

{
switch ($name)
{
case 'filter':
case 'directory':
case 'exclude':
$this->$name = (string) $value;
break;
case 'hideNone':
case 'hideDefault':
$value = (string) $value;
$this->$name = ($value === 'true' || $value === $name || $value === '1');
break;
default:
}
}
JFormFieldFolderList::getOptions ( )
protected

Method to get the field options.

Renvoie:
array The field option objects.
Depuis:
11.1

Réimplémentée à partir de JFormFieldList.

Définition à la ligne 170 du fichier folderlist.php.

Références JText\alt(), et JFolder\folders().

{
$options = array();
if (!is_dir($path))
{
$path = JPATH_ROOT . '/' . $path;
}
// Prepend some default options based on field attributes.
if (!$this->hideNone)
{
$options[] = JHtml::_('select.option', '-1', JText::alt('JOPTION_DO_NOT_USE', preg_replace('/[^a-zA-Z0-9_\-]/', '_', $this->fieldname)));
}
if (!$this->hideDefault)
{
$options[] = JHtml::_('select.option', '', JText::alt('JOPTION_USE_DEFAULT', preg_replace('/[^a-zA-Z0-9_\-]/', '_', $this->fieldname)));
}
// Get a list of folders in the search path with the given filter.
$folders = JFolder::folders($path, $this->filter);
// Build the options list from the list of folders.
if (is_array($folders))
{
foreach ($folders as $folder)
{
// Check to see if the file is in the exclude mask.
if ($this->exclude)
{
if (preg_match(chr(1) . $this->exclude . chr(1), $folder))
{
continue;
}
}
$options[] = JHtml::_('select.option', $folder, $folder);
}
}
// Merge any additional options in the XML definition.
$options = array_merge(parent::getOptions(), $options);
return $options;
}

+ Voici le graphe d'appel pour cette fonction :

JFormFieldFolderList::setup ( SimpleXMLElement  $element,
  $value,
  $group = null 
)

Method to attach a JForm object to the field.

Paramètres:
SimpleXMLElement$elementThe SimpleXMLElement object representing the <field> tag for the form field object.
mixed$valueThe form field value to validate.
string$groupThe field name group control value. This acts as as an array container for the field. For example if the field has name="foo" and the group value is set to "bar" then the full field name would end up being "bar[foo]".
Renvoie:
boolean True on success.
Voir également:
JFormField::setup()
Depuis:
3.2

Réimplémentée à partir de JFormField.

Définition à la ligne 141 du fichier folderlist.php.

{
if ($return)
{
$this->filter = (string) $this->element['filter'];
$this->exclude = (string) $this->element['exclude'];
$hideNone = (string) $this->element['hide_none'];
$this->hideNone = ($hideNone == 'true' || $hideNone == 'hideNone' || $hideNone == '1');
$hideDefault = (string) $this->element['hide_default'];
$this->hideDefault = ($hideDefault == 'true' || $hideDefault == 'hideDefault' || $hideDefault == '1');
// Get the path in which to search for file options.
$this->directory = (string) $this->element['directory'];
}
return $return;
}

Documentation des données membres

JFormFieldFolderList::$directory
protected

Définition à la ligne 70 du fichier folderlist.php.

JFormFieldFolderList::$exclude
protected

Définition à la ligne 46 du fichier folderlist.php.

JFormFieldFolderList::$filter
protected

Définition à la ligne 38 du fichier folderlist.php.

JFormFieldFolderList::$hideDefault = false
protected

Définition à la ligne 62 du fichier folderlist.php.

JFormFieldFolderList::$hideNone = false
protected

Définition à la ligne 54 du fichier folderlist.php.

JFormFieldFolderList::$type = 'FolderList'
protected

Réimplémentée à partir de JFormFieldList.

Définition à la ligne 30 du fichier folderlist.php.


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