locomotivemtl / charcoal-ui

src/Charcoal/Ui/FormGroup/FormGroupTrait.php

Doc Comments +7 added lines, -7 removed lines

@@ -74,7 +74,7 @@ 
 
     /**
      * @param FormInputBuilder $builder The builder, to create customized form input objects.
-     * @return FormGroupInterface Chainable
+     * @return FormGroupTrait Chainable
      */
     protected function setFormInputBuilder(FormInputBuilder $builder)
     {
@@ -84,7 +84,7 @@ 
 
     /**
      * @param callable $cb The input callback.
-     * @return FormGroupInterface Chainable
+     * @return FormGroupTrait Chainable
      */
     public function setInputCallback(callable $cb)
     {
@@ -94,7 +94,7 @@ 
 
     /**
      * @param FormInterface $form The parent form object.
-     * @return FormGroupInterface Chainable
+     * @return FormGroupTrait Chainable
      */
     public function setForm(FormInterface $form)
     {
@@ -112,7 +112,7 @@ 
 
     /**
      * @param string $mode The l10n mode.
-     * @return FormGroupInterface Chainable
+     * @return FormGroupTrait Chainable
      */
     public function setL10nMode($mode)
     {
@@ -130,7 +130,7 @@ 
 
     /**
      * @param array $inputs The group inputs.
-     * @return FormGroupInterface Chainable
+     * @return FormGroupTrait Chainable
      */
     public function setInputs(array $inputs)
     {
@@ -145,7 +145,7 @@ 
      * @param string                   $inputIdent The input identifier.
      * @param array|FormInputInterface $input      The input object or structure.
      * @throws InvalidArgumentException If the ident argument is not a string or if the input is not valid.
-     * @return FormGroupInterface Chainable
+     * @return FormGroupTrait Chainable
      */
     public function addInput($inputIdent, $input)
     {
@@ -175,7 +175,7 @@ 
      * Form Input generator.
      *
      * @param callable $inputCallback Optional. Input callback.
-     * @return FormGroupInterface[]|Generator
+     * @return \Generator
      */
     public function inputs(callable $inputCallback = null)
     {

src/Charcoal/Ui/MenuItem/AbstractMenuItem.php

Doc Comments +7 added lines, -7 removed lines

@@ -93,7 +93,7 @@ 
     /**
      * @param string $ident The menu item identifier.
      * @throws InvalidArgumentException If the identifier argument is not a string.
-     * @return MenuItem Chainable
+     * @return AbstractMenuItem Chainable
      */
     public function setIdent($ident)
     {
@@ -116,7 +116,7 @@ 
 
     /**
      * @param mixed $label The menu item label.
-     * @return MenuItem Chainable
+     * @return AbstractMenuItem Chainable
      */
     public function setLabel($label)
     {
@@ -125,7 +125,7 @@ 
     }
 
     /**
-     * @return string
+     * @return \Charcoal\Translator\Translation|null
      */
     public function label()
     {
@@ -134,7 +134,7 @@ 
 
     /**
      * @param string $url The menu item URL.
-     * @return MenuItem Chainable
+     * @return AbstractMenuItem Chainable
      */
     public function setUrl($url)
     {
@@ -160,7 +160,7 @@ 
 
     /**
      * @param array $children The menu item children items structure.
-     * @return MenuItem Chainable
+     * @return AbstractMenuItem Chainable
      */
     public function setChildren(array $children)
     {
@@ -174,7 +174,7 @@ 
     /**
      * @param array|MenuItem $child The child menu structure or object.
      * @throws InvalidArgumentException If the child is not a menu object or structure.
-     * @return MenuItem Chainable
+     * @return AbstractMenuItem Chainable
      */
     public function addChild($child)
     {
@@ -196,7 +196,7 @@ 
      * Children (menu item) generator
      *
      * @param callable $childCallback Optional callback.
-     * @return MenuItemInterface[]
+     * @return \Generator
      */
     public function children(callable $childCallback = null)
     {

src/Charcoal/Ui/ConditionalizableTrait.php

Doc Comments +1 added lines, -1 removed lines

@@ -72,7 +72,7 @@
     /**
      * Resolve the conditional logic.
      *
-     * @param  mixed $condition The condition.
+     * @param  boolean|string $condition The condition.
      * @return boolean|null
      */
     final protected function parseConditionalLogic($condition)

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()
     {

src/Charcoal/Ui/Dashboard/DashboardTrait.php

Doc Comments +5 added lines, -5 removed lines

@@ -54,7 +54,7 @@ 
      *
      * @param  object $builder The builder to create customized widget objects.
      * @throws InvalidArgumentException If the argument is not a widget builder.
-     * @return DashboardInterface Chainable
+     * @return DashboardTrait Chainable
      */
     protected function setWidgetBuilder($builder)
     {
@@ -78,7 +78,7 @@ 
      * @param  callable|null $callable A callback to be applied to each widget
      *     or NULL to disable the callback.
      * @throws InvalidArgumentException If the argument is not callable or NULL.
-     * @return DashboardInterface Chainable
+     * @return DashboardTrait Chainable
      */
     public function setWidgetCallback($callable)
     {
@@ -106,7 +106,7 @@ 
      * Set the dashboard's widgets.
      *
      * @param array $widgets A collection of widgets.
-     * @return DashboardInterface Chainable
+     * @return DashboardTrait Chainable
      */
     public function setWidgets(array $widgets)
     {
@@ -127,7 +127,7 @@ 
      * @param  string                $widgetIdent The widget identifier.
      * @param  UiItemInterface|array $widget      The widget object or structure.
      * @throws InvalidArgumentException If the widget is invalid.
-     * @return DashboardInterface Chainable
+     * @return DashboardTrait Chainable
      */
     public function addWidget($widgetIdent, $widget)
     {
@@ -160,7 +160,7 @@ 
      * Retrieve the dashboard's widgets.
      *
      * @param callable $widgetCallback A callback applied to each widget.
-     * @return UiItemInterface[]|Generator
+     * @return \Generator
      */
     public function widgets(callable $widgetCallback = null)
     {

src/Charcoal/Ui/Menu/AbstractMenu.php

Doc Comments +3 added lines, -3 removed lines

@@ -57,7 +57,7 @@ 
 
     /**
      * @param MenuItemBuilder $menuItemBuilder The Menu Item Builder that will be used to create new items.
-     * @return AsbtractMenu Chainable
+     * @return AbstractMenu Chainable
      */
     public function setMenuItemBuilder(MenuItemBuilder $menuItemBuilder)
     {
@@ -92,7 +92,7 @@ 
      * @param array|MenuItemInterface $item  A menu item structure or object.
      * @param string                  $ident The menu item identifier, if any.
      * @throws InvalidArgumentException If the item argument is not a structure or object.
-     * @return MenuItem Chainable
+     * @return AbstractMenu Chainable
      */
     public function addItem($item, $ident = null)
     {
@@ -125,7 +125,7 @@ 
      * Menu Item generator.
      *
      * @param callable $itemCallback Optional. Item callback.
-     * @return MenuItemInterface[]
+     * @return \Generator
      */
     public function items(callable $itemCallback = null)
     {