Back to FolderlistField class

Method setup

public bool
setup
(\SimpleXMLElement $element, mixed $value, mixed $group = null)
Method to attach a Form object to the field.
Parameters
  • \SimpleXMLElement $element The SimpleXMLElement object representing the `<field>` tag for the form field object.
  • mixed $value The form field value to validate.
  • string $group The field name group control value. This acts 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]".
Returns
  • bool True on success.
Since
  • 3.2
-
  • \Joomla\CMS\Form\Field\FormField::setup()

Method setup - Source code

/**
 * Method to attach a Form object to the field.
 *
 * @param   \SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
 * @param   mixed              $value    The form field value to validate.
 * @param   string             $group    The field name group control value. This acts 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]".
 *
 * @return  boolean  True on success.
 *
 * @see     FormField::setup()
 * @since   3.2
 */
public function setup(\SimpleXMLElement $element, $value, $group = null)
{
    $return = parent::setup($element, $value, $group);
    if ($return) {
        $this->folderFilter = (string) $this->element['folderFilter'];
        $this->exclude = (string) $this->element['exclude'];
        $recursive = (string) $this->element['recursive'];
        $this->recursive = $recursive === 'true' || $recursive === 'recursive' || $recursive === '1';
        $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;
}