locomotivemtl / charcoal-ui

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

Spacing +1 added lines, -1 removed lines

@@ -195,7 +195,7 @@
     public function inputs(callable $inputCallback = null)
     {
         $groups = $this->groups;
-        uasort($groups, [ $this, 'sortItemsByPriority' ]);
+        uasort($groups, [$this, 'sortItemsByPriority']);
 
         $inputCallback = isset($inputCallback) ? $inputCallback : $this->inputCallback;
         foreach ($inputs as $input) {

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;

Unused Use Statements -2 removed lines

@@ -4,9 +4,7 @@
 
 use Pimple\Container;
 use Pimple\ServiceProviderInterface;
-
 use Charcoal\Factory\GenericFactory as Factory;
-
 use Charcoal\Ui\Dashboard\DashboardBuilder;
 use Charcoal\Ui\Dashboard\DashboardInterface;
 use Charcoal\Ui\Dashboard\GenericDashboard;

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/Dashboard/DashboardTrait.php

Spacing +1 added lines, -1 removed lines

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

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/ServiceProvider/FormServiceProvider.php

Unused Use Statements -1 removed lines

@@ -13,7 +13,6 @@
 use Charcoal\Ui\Form\FormBuilder;
 use Charcoal\Ui\Form\FormInterface;
 use Charcoal\Ui\Form\GenericForm;
-use Charcoal\Ui\FormGroup\FormGroupBuilder;
 use Charcoal\Ui\FormGroup\FormGroupInterface;
 use Charcoal\Ui\FormGroup\GenericFormGroup;
 use Charcoal\Ui\FormInput\FormInputBuilder;

src/Charcoal/Ui/ServiceProvider/LayoutServiceProvider.php

Spacing +2 added lines, -2 removed lines

@@ -34,7 +34,7 @@ 
          * @param Container $container A Pimple DI container.
          * @return LayoutFactory
          */
-        $container['layout/factory'] = function () {
+        $container['layout/factory'] = function() {
 
             $layoutFactory = new LayoutFactory();
             return $layoutFactory;
@@ -44,7 +44,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/Menu/AbstractMenu.php

Spacing +1 added lines, -1 removed lines

@@ -125,7 +125,7 @@
     public function items(callable $itemCallback = null)
     {
         $items = $this->items;
-        uasort($items, [ $this, 'sortItemsByPriority' ]);
+        uasort($items, [$this, 'sortItemsByPriority']);
 
         $itemCallback = isset($itemCallback) ? $itemCallback : $this->itemCallback;
         foreach ($items as $item) {

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

Unused Use Statements -1 removed lines

@@ -9,7 +9,6 @@
 use Charcoal\Ui\Menu\MenuInterface;
 use Charcoal\Ui\MenuItem\MenuItemInterface;
 use Charcoal\Ui\MenuItem\MenuItemBuilder;
-use Charcoal\Ui\UiItemInterface;
 
 /**
  * A Basic Menu