locomotivemtl / charcoal-ui

src/Charcoal/Ui/ServiceProvider/LayoutServiceProvider.php

Spacing +2 added lines, -2 removed lines

@@ -32,7 +32,7 @@ 
          * @param Container $container A Pimple DI container.
          * @return LayoutFactory
          */
-        $container['layout/factory'] = function (Container $container) {
+        $container['layout/factory'] = function(Container $container) {
 
             $layoutFactory = new LayoutFactory();
             return $layoutFactory;
@@ -42,7 +42,7 @@ 
          * @param Container $container A Pimple DI container.
          * @return LayoutBuilder
          */
-        $container['layout/builder'] = function (Container $container) {
+        $container['layout/builder'] = function(Container $container) {
             $layoutFactory = $container['layout/factory'];
             $layoutBuilder = new LayoutBuilder($layoutFactory, $container);
             return $layoutBuilder;

src/Charcoal/Ui/Layout/LayoutInterface.php

Indentation +5 added lines, -5 removed lines

@@ -33,11 +33,11 @@
      */
     public function structure();
 
-     /**
-      * Get the total number of rows
-      *
-      * @return integer
-      */
+        /**
+         * Get the total number of rows
+         *
+         * @return integer
+         */
     public function numRows();
 
     /**

src/Charcoal/Ui/Menu/AbstractMenu.php

Doc Comments +3 added lines, -3 removed lines

@@ -40,7 +40,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)
     {
@@ -74,7 +74,7 @@ 
     /**
      * @param array|MenuItemInterface $item A menu item structure or object.
      * @throws InvalidArgumentException If the item argument is not a structure or object.
-     * @return MenuItem Chainable
+     * @return AbstractMenu Chainable
      */
     public function addItem($item)
     {
@@ -97,7 +97,7 @@ 
      * Menu Item generator.
      *
      * @param callable $itemCallback Optional. Item callback.
-     * @return MenuItemInterface[]
+     * @return \Generator
      */
     public function items(callable $itemCallback = null)
     {

src/Charcoal/Ui/Dashboard/DashboardTrait.php

Spacing +1 added lines, -1 removed lines

@@ -99,7 +99,7 @@
     public function widgets(callable $widgetCallback = null)
     {
         $widgets = $this->widgets;
-        uasort($widgets, [ $this, 'sortWidgetsByPriority' ]);
+        uasort($widgets, [$this, 'sortWidgetsByPriority']);
 
         $widgetCallback = isset($widgetCallback) ? $widgetCallback : $this->widgetCallback;
         foreach ($widgets as $widget) {

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/Layout/LayoutTrait.php

Spacing +3 added lines, -3 removed lines

@@ -57,7 +57,7 @@ 
         foreach ($layouts as $l) {
             $loop = isset($l['loop']) ? (int)$l['loop'] : 1;
             unset($l['loop']);
-            for ($i=0; $i<$loop; $i++) {
+            for ($i = 0; $i < $loop; $i++) {
                 $computedLayouts[] = $l;
             }
         }
@@ -221,7 +221,7 @@ 
         }
         $first = $this->rowFirstCellIndex($position);
 
-        return ($position - $first);
+        return ($position-$first);
     }
 
     /**
@@ -262,7 +262,7 @@ 
      */
     public function cellSpanBy12($position = null)
     {
-        $numColumns =  $this->rowNumColumns($position);
+        $numColumns = $this->rowNumColumns($position);
         if (!$numColumns) {
             return null;
         }

src/Charcoal/Ui/ServiceProvider/DashboardServiceProvider.php

Spacing +2 added lines, -2 removed lines

@@ -35,7 +35,7 @@ 
          * @param Container $container A Pimple DI container.
          * @return LayoutFactory
          */
-        $container['dashboard/factory'] = function (Container $container) {
+        $container['dashboard/factory'] = function(Container $container) {
             return new Factory([
                 'base_class'         => DashboardInterface::class,
                 'default_class'      => GenericDashboard::class,
@@ -55,7 +55,7 @@ 
          * @param Container $container A Pimple DI container.
          * @return LayoutBuilder
          */
-        $container['dashboard/builder'] = function (Container $container) {
+        $container['dashboard/builder'] = function(Container $container) {
             $dashboardFactory = $container['dashboard/factory'];
             $dashboardBuilder = new DashboardBuilder($dashboardFactory, $container);
             return $dashboardBuilder;

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/Form/FormTrait.php

Doc Comments +11 added lines, -11 removed lines

@@ -82,7 +82,7 @@ 
 
     /**
      * @param FactoryInterface $factory A factory, to create customized form gorup objects.
-     * @return FormInterface Chainable
+     * @return FormTrait Chainable
      */
     public function setFormGroupFactory(FactoryInterface $factory)
     {
@@ -108,7 +108,7 @@ 
 
     /**
      * @param callable $cb The group callback.
-     * @return FormInterface Chainable
+     * @return FormTrait Chainable
      */
     public function setGroupCallback(callable $cb)
     {
@@ -120,7 +120,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)
     {
@@ -147,7 +147,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)
     {
@@ -172,7 +172,7 @@ 
 
     /**
      * @param string $mode The l10n mode.
-     * @return FormInterface Chainable
+     * @return FormTrait Chainable
      */
     public function setL10nMode($mode)
     {
@@ -193,7 +193,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)
     {
@@ -212,7 +212,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)
     {
@@ -315,7 +315,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)
     {
@@ -399,7 +399,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)
     {
@@ -440,7 +440,7 @@ 
 
     /**
      * @param array $formData The (pre-populated) form data, as [$key=>$val] array.
-     * @return FormInterface Chainable
+     * @return FormTrait Chainable
      */
     public function setFormData(array $formData)
     {
@@ -453,7 +453,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)
     {