From de40f5d07b119195ec76b5fc135169667d653839 Mon Sep 17 00:00:00 2001 From: Jules Pietri Date: Mon, 12 Nov 2018 11:47:20 +0100 Subject: [PATCH] [Form] Minor fixes in docs and cs --- src/Symfony/Component/Form/Form.php | 24 ++++++++++--------- .../Component/Form/NativeRequestHandler.php | 4 ++-- src/Symfony/Component/Form/Util/FormUtil.php | 2 +- .../Component/Form/Util/OrderedHashMap.php | 2 +- .../Form/Util/OrderedHashMapIterator.php | 4 +--- 5 files changed, 18 insertions(+), 18 deletions(-) diff --git a/src/Symfony/Component/Form/Form.php b/src/Symfony/Component/Form/Form.php index 9234073831..95186fae76 100644 --- a/src/Symfony/Component/Form/Form.php +++ b/src/Symfony/Component/Form/Form.php @@ -32,16 +32,18 @@ use Symfony\Component\PropertyAccess\PropertyPath; * * (1) the "model" format required by the form's object * (2) the "normalized" format for internal processing - * (3) the "view" format used for display + * (3) the "view" format used for display simple fields + * or map children model data for compound fields * * A date field, for example, may store a date as "Y-m-d" string (1) in the * object. To facilitate processing in the field, this value is normalized * to a DateTime object (2). In the HTML representation of your form, a - * localized string (3) is presented to and modified by the user. + * localized string (3) may be presented to and modified by the user, or it could be an array of values + * to be mapped to choices fields. * * In most cases, format (1) and format (2) will be the same. For example, * a checkbox field uses a Boolean value for both internal processing and - * storage in the object. In these cases you simply need to set a value + * storage in the object. In these cases you simply need to set a view * transformer to convert between formats (2) and (3). You can do this by * calling addViewTransformer(). * @@ -49,7 +51,7 @@ use Symfony\Component\PropertyAccess\PropertyPath; * demonstrate this, let's extend our above date field to store the value * either as "Y-m-d" string or as timestamp. Internally we still want to * use a DateTime object for processing. To convert the data from string/integer - * to DateTime you can set a normalization transformer by calling + * to DateTime you can set a model transformer by calling * addModelTransformer(). The normalized data is then converted to the displayed * data as described before. * @@ -218,7 +220,7 @@ class Form implements \IteratorAggregate, FormInterface } if (null === $this->getName() || '' === $this->getName()) { - return; + return null; } $parent = $this->parent; @@ -341,8 +343,8 @@ class Form implements \IteratorAggregate, FormInterface $modelData = $event->getData(); } - // Treat data as strings unless a value transformer exists - if (!$this->config->getViewTransformers() && !$this->config->getModelTransformers() && is_scalar($modelData)) { + // Treat data as strings unless a transformer exists + if (is_scalar($modelData) && !$this->config->getViewTransformers() && !$this->config->getModelTransformers()) { $modelData = (string) $modelData; } @@ -1068,7 +1070,7 @@ class Form implements \IteratorAggregate, FormInterface } /** - * Normalizes the value if a normalization transformer is set. + * Normalizes the value if a model transformer is set. * * @param mixed $value The value to transform * @@ -1090,7 +1092,7 @@ class Form implements \IteratorAggregate, FormInterface } /** - * Reverse transforms a value if a normalization transformer is set. + * Reverse transforms a value if a model transformer is set. * * @param string $value The value to reverse transform * @@ -1114,7 +1116,7 @@ class Form implements \IteratorAggregate, FormInterface } /** - * Transforms the value if a value transformer is set. + * Transforms the value if a view transformer is set. * * @param mixed $value The value to transform * @@ -1145,7 +1147,7 @@ class Form implements \IteratorAggregate, FormInterface } /** - * Reverse transforms a value if a value transformer is set. + * Reverse transforms a value if a view transformer is set. * * @param string $value The value to reverse transform * diff --git a/src/Symfony/Component/Form/NativeRequestHandler.php b/src/Symfony/Component/Form/NativeRequestHandler.php index ccebdab6d8..94210d51e8 100644 --- a/src/Symfony/Component/Form/NativeRequestHandler.php +++ b/src/Symfony/Component/Form/NativeRequestHandler.php @@ -15,7 +15,7 @@ use Symfony\Component\Form\Exception\UnexpectedTypeException; use Symfony\Component\Form\Util\ServerParams; /** - * A request handler using PHP's super globals $_GET, $_POST and $_SERVER. + * A request handler using PHP super globals $_GET, $_POST and $_SERVER. * * @author Bernhard Schussek */ @@ -213,7 +213,7 @@ class NativeRequestHandler implements RequestHandlerInterface if (self::$fileKeys === $keys) { if (UPLOAD_ERR_NO_FILE === $data['error']) { - return; + return null; } return $data; diff --git a/src/Symfony/Component/Form/Util/FormUtil.php b/src/Symfony/Component/Form/Util/FormUtil.php index 0862179f54..53053f9d5b 100644 --- a/src/Symfony/Component/Form/Util/FormUtil.php +++ b/src/Symfony/Component/Form/Util/FormUtil.php @@ -27,7 +27,7 @@ class FormUtil * Returns whether the given data is empty. * * This logic is reused multiple times throughout the processing of - * a form and needs to be consistent. PHP's keyword `empty` cannot + * a form and needs to be consistent. PHP keyword `empty` cannot * be used as it also considers 0 and "0" to be empty. * * @param mixed $data diff --git a/src/Symfony/Component/Form/Util/OrderedHashMap.php b/src/Symfony/Component/Form/Util/OrderedHashMap.php index 6a97559850..26e45a4622 100644 --- a/src/Symfony/Component/Form/Util/OrderedHashMap.php +++ b/src/Symfony/Component/Form/Util/OrderedHashMap.php @@ -128,7 +128,7 @@ class OrderedHashMap implements \ArrayAccess, \IteratorAggregate, \Countable $key = array() === $this->orderedKeys // If the array is empty, use 0 as key ? 0 - // Imitate PHP's behavior of generating a key that equals + // Imitate PHP behavior of generating a key that equals // the highest existing integer key + 1 : 1 + (int) max($this->orderedKeys); } diff --git a/src/Symfony/Component/Form/Util/OrderedHashMapIterator.php b/src/Symfony/Component/Form/Util/OrderedHashMapIterator.php index 3de636392d..93a7caa58d 100644 --- a/src/Symfony/Component/Form/Util/OrderedHashMapIterator.php +++ b/src/Symfony/Component/Form/Util/OrderedHashMapIterator.php @@ -56,8 +56,6 @@ class OrderedHashMapIterator implements \Iterator private $current; /** - * Creates a new iterator. - * * @param array $elements The elements of the map, indexed by their * keys * @param array $orderedKeys The keys of the map in the order in which @@ -84,7 +82,7 @@ class OrderedHashMapIterator implements \Iterator */ public function __destruct() { - // Use array_splice() instead of isset() to prevent holes in the + // Use array_splice() instead of unset() to prevent holes in the // array indices, which would break the initialization of $cursorId array_splice($this->managedCursors, $this->cursorId, 1); }