locomotivemtl / charcoal-ui

src/Charcoal/Ui/Form/FormTrait.php

Doc Comments +12 added lines, -12 removed lines

@@ -111,7 +111,7 @@ 
 
     /**
      * @param FactoryInterface $factory A factory, to create customized form gorup objects.
-     * @return FormInterface Chainable
+     * @return FormTrait Chainable
      */
     public function setFormGroupFactory(FactoryInterface $factory)
     {
@@ -137,7 +137,7 @@ 
 
     /**
      * @param callable $cb The group callback.
-     * @return FormInterface Chainable
+     * @return FormTrait Chainable
      */
     public function setGroupCallback(callable $cb)
     {
@@ -149,7 +149,7 @@ 
     /**
      * @param string $action The "action" value, typically a URL.
      * @throws InvalidArgumentException If the action argument is not a string.
-     * @return FormInterface Chainable
+     * @return FormTrait Chainable
      */
     public function setAction($action)
     {
@@ -176,7 +176,7 @@ 
      *
      * @param string $method Either "post" or "get".
      * @throws InvalidArgumentException If the method is not post or get.
-     * @return FormInterface Chainable
+     * @return FormTrait Chainable
      */
     public function setMethod($method)
     {
@@ -201,7 +201,7 @@ 
 
     /**
      * @param string $mode The l10n mode.
-     * @return FormInterface Chainable
+     * @return FormTrait Chainable
      */
     public function setL10nMode($mode)
     {
@@ -222,7 +222,7 @@ 
      * Set the object's form groups.
      *
      * @param array $groups A collection of group structures.
-     * @return FormInterface Chainable
+     * @return FormTrait Chainable
      */
     public function setGroups(array $groups)
     {
@@ -279,7 +279,7 @@ 
      * @param  string                   $groupIdent The group identifier.
      * @param  array|FormGroupInterface $group      The group object or structure.
      * @throws InvalidArgumentException If the identifier is not a string or the group is invalid.
-     * @return FormInterface Chainable
+     * @return FormTrait Chainable
      */
     public function addGroup($groupIdent, $group)
     {
@@ -399,7 +399,7 @@ 
      * Retrieve the form groups.
      *
      * @param callable $groupCallback Optional callback applied to each form group.
-     * @return FormGroupInterface[]|Generator
+     * @return \Generator
      */
     public function groups(callable $groupCallback = null)
     {
@@ -520,7 +520,7 @@ 
      *
      * @param string $mode Group display mode.
      * @throws InvalidArgumentException If the display mode is not a string.
-     * @return ObjectFormWidget Chainable.
+     * @return FormTrait Chainable.
      */
     public function setGroupDisplayMode($mode)
     {
@@ -561,7 +561,7 @@ 
 
     /**
      * @param array $formData The (pre-populated) form data, as [$key=>$val] array.
-     * @return FormInterface Chainable
+     * @return FormTrait Chainable
      */
     public function setFormData(array $formData)
     {
@@ -574,7 +574,7 @@ 
      * @param string $key The form data key, or poperty identifier.
      * @param mixed  $val The form data value, for a given key.
      * @throws InvalidArgumentException If the key argument is not a string.
-     * @return FormInterface Chainable
+     * @return FormTrait Chainable
      */
     public function addFormData($key, $val)
     {
@@ -597,7 +597,7 @@ 
     }
 
     /**
-     * @return FormWidget
+     * @return FormTrait
      */
     protected function formWidget()
     {