Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. FormFieldRegistry.php

class FormFieldRegistry

This is an internal class that must not be used directly.

@internal

Hierarchy

  • class \Symfony\Component\DomCrawler\FormFieldRegistry

Expanded class hierarchy of FormFieldRegistry

File

vendor/symfony/dom-crawler/FormFieldRegistry.php, line 21

Namespace

Symfony\Component\DomCrawler
View source
class FormFieldRegistry {
    private array $fields = [];
    private string $base = '';
    
    /**
     * Adds a field to the registry.
     */
    public function add(FormField $field) : void {
        $segments = $this->getSegments($field->getName());
        $target =& $this->fields;
        while ($segments) {
            if (!\is_array($target)) {
                $target = [];
            }
            $path = array_shift($segments);
            if ('' === $path) {
                $target =& $target[];
            }
            else {
                $target =& $target[$path];
            }
        }
        $target = $field;
    }
    
    /**
     * Removes a field based on the fully qualified name and its children from the registry.
     */
    public function remove(string $name) : void {
        $segments = $this->getSegments($name);
        $target =& $this->fields;
        while (\count($segments) > 1) {
            $path = array_shift($segments);
            if (!\is_array($target) || !\array_key_exists($path, $target)) {
                return;
            }
            $target =& $target[$path];
        }
        unset($target[array_shift($segments)]);
    }
    
    /**
     * Returns the value of the field based on the fully qualified name and its children.
     *
     * @return FormField|FormField[]|FormField[][]
     *
     * @throws \InvalidArgumentException if the field does not exist
     */
    public function &get(string $name) : FormField|array {
        $segments = $this->getSegments($name);
        $target =& $this->fields;
        while ($segments) {
            $path = array_shift($segments);
            if (!\is_array($target) || !\array_key_exists($path, $target)) {
                throw new \InvalidArgumentException(\sprintf('Unreachable field "%s".', $path));
            }
            $target =& $target[$path];
        }
        return $target;
    }
    
    /**
     * Tests whether the form has the given field based on the fully qualified name.
     */
    public function has(string $name) : bool {
        try {
            $this->get($name);
            return true;
        } catch (\InvalidArgumentException) {
            return false;
        }
    }
    
    /**
     * Set the value of a field based on the fully qualified name and its children.
     *
     * @throws \InvalidArgumentException if the field does not exist
     */
    public function set(string $name, mixed $value) : void {
        $target =& $this->get($name);
        if (!\is_array($value) && $target instanceof FormField || $target instanceof Field\ChoiceFormField) {
            $target->setValue($value);
        }
        elseif (\is_array($value)) {
            $registry = new static();
            $registry->base = $name;
            $registry->fields = $value;
            foreach ($registry->all() as $k => $v) {
                $this->set($k, $v);
            }
        }
        else {
            throw new \InvalidArgumentException(\sprintf('Cannot set value on a compound field "%s".', $name));
        }
    }
    
    /**
     * Returns the list of field with their value.
     *
     * @return FormField[] The list of fields as [string] Fully qualified name => (mixed) value)
     */
    public function all() : array {
        return $this->walk($this->fields, $this->base);
    }
    
    /**
     * Transforms a PHP array in a list of fully qualified name / value.
     */
    private function walk(array $array, ?string $base = '', array &$output = []) : array {
        foreach ($array as $k => $v) {
            $path = $base ? \sprintf('%s[%s]', $base, $k) : $k;
            if (\is_array($v)) {
                $this->walk($v, $path, $output);
            }
            else {
                $output[$path] = $v;
            }
        }
        return $output;
    }
    
    /**
     * Splits a field name into segments as a web browser would do.
     *
     *     getSegments('base[foo][3][]') = ['base', 'foo, '3', ''];
     *
     * @return string[]
     */
    private function getSegments(string $name) : array {
        if (preg_match('/^(?P<base>[^[]+)(?P<extra>(\\[.*)|$)/', $name, $m)) {
            $segments = [
                $m['base'],
            ];
            while (!empty($m['extra'])) {
                $extra = $m['extra'];
                if (preg_match('/^\\[(?P<segment>.*?)\\](?P<extra>.*)$/', $extra, $m)) {
                    $segments[] = $m['segment'];
                }
                else {
                    $segments[] = $extra;
                }
            }
            return $segments;
        }
        return [
            $name,
        ];
    }

}

Members

Title Sort descending Modifiers Object type Summary
FormFieldRegistry::$base private property
FormFieldRegistry::$fields private property
FormFieldRegistry::add public function Adds a field to the registry.
FormFieldRegistry::all public function Returns the list of field with their value.
FormFieldRegistry::get public function Returns the value of the field based on the fully qualified name and its children.
FormFieldRegistry::getSegments private function Splits a field name into segments as a web browser would do.
FormFieldRegistry::has public function Tests whether the form has the given field based on the fully qualified name.
FormFieldRegistry::remove public function Removes a field based on the fully qualified name and its children from the registry.
FormFieldRegistry::set public function Set the value of a field based on the fully qualified name and its children.
FormFieldRegistry::walk private function Transforms a PHP array in a list of fully qualified name / value.
RSS feed
Powered by Drupal