@@ -33,11 +33,11 @@ |
||
| 33 | 33 | */ |
| 34 | 34 | public function structure(); |
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * Get the total number of rows |
|
| 38 | - * |
|
| 39 | - * @return integer |
|
| 40 | - */ |
|
| 36 | + /** |
|
| 37 | + * Get the total number of rows |
|
| 38 | + * |
|
| 39 | + * @return integer |
|
| 40 | + */ |
|
| 41 | 41 | public function numRows(); |
| 42 | 42 | |
| 43 | 43 | /** |
@@ -74,7 +74,7 @@ discard block |
||
| 74 | 74 | |
| 75 | 75 | /** |
| 76 | 76 | * @param FormInputBuilder $builder The builder, to create customized form input objects. |
| 77 | - * @return FormGroupInterface Chainable |
|
| 77 | + * @return FormGroupTrait Chainable |
|
| 78 | 78 | */ |
| 79 | 79 | protected function setFormInputBuilder(FormInputBuilder $builder) |
| 80 | 80 | { |
@@ -84,7 +84,7 @@ discard block |
||
| 84 | 84 | |
| 85 | 85 | /** |
| 86 | 86 | * @param callable $cb The input callback. |
| 87 | - * @return FormGroupInterface Chainable |
|
| 87 | + * @return FormGroupTrait Chainable |
|
| 88 | 88 | */ |
| 89 | 89 | public function setInputCallback(callable $cb) |
| 90 | 90 | { |
@@ -94,7 +94,7 @@ discard block |
||
| 94 | 94 | |
| 95 | 95 | /** |
| 96 | 96 | * @param FormInterface $form The parent form object. |
| 97 | - * @return FormGroupInterface Chainable |
|
| 97 | + * @return FormGroupTrait Chainable |
|
| 98 | 98 | */ |
| 99 | 99 | public function setForm(FormInterface $form) |
| 100 | 100 | { |
@@ -112,7 +112,7 @@ discard block |
||
| 112 | 112 | |
| 113 | 113 | /** |
| 114 | 114 | * @param string $mode The l10n mode. |
| 115 | - * @return FormGroupInterface Chainable |
|
| 115 | + * @return FormGroupTrait Chainable |
|
| 116 | 116 | */ |
| 117 | 117 | public function setL10nMode($mode) |
| 118 | 118 | { |
@@ -130,7 +130,7 @@ discard block |
||
| 130 | 130 | |
| 131 | 131 | /** |
| 132 | 132 | * @param array $inputs The group inputs. |
| 133 | - * @return FormGroupInterface Chainable |
|
| 133 | + * @return FormGroupTrait Chainable |
|
| 134 | 134 | */ |
| 135 | 135 | public function setInputs(array $inputs) |
| 136 | 136 | { |
@@ -145,7 +145,7 @@ discard block |
||
| 145 | 145 | * @param string $inputIdent The input identifier. |
| 146 | 146 | * @param array|FormInputInterface $input The input object or structure. |
| 147 | 147 | * @throws InvalidArgumentException If the ident argument is not a string or if the input is not valid. |
| 148 | - * @return FormGroupInterface Chainable |
|
| 148 | + * @return FormGroupTrait Chainable |
|
| 149 | 149 | */ |
| 150 | 150 | public function addInput($inputIdent, $input) |
| 151 | 151 | { |
@@ -175,7 +175,7 @@ discard block |
||
| 175 | 175 | * Form Input generator. |
| 176 | 176 | * |
| 177 | 177 | * @param callable $inputCallback Optional. Input callback. |
| 178 | - * @return FormGroupInterface[]|Generator |
|
| 178 | + * @return \Generator |
|
| 179 | 179 | */ |
| 180 | 180 | public function inputs(callable $inputCallback = null) |
| 181 | 181 | { |
@@ -195,7 +195,7 @@ |
||
| 195 | 195 | public function inputs(callable $inputCallback = null) |
| 196 | 196 | { |
| 197 | 197 | $groups = $this->groups; |
| 198 | - uasort($groups, [ $this, 'sortItemsByPriority' ]); |
|
| 198 | + uasort($groups, [$this, 'sortItemsByPriority']); |
|
| 199 | 199 | |
| 200 | 200 | $inputCallback = isset($inputCallback) ? $inputCallback : $this->inputCallback; |
| 201 | 201 | foreach ($inputs as $input) { |
@@ -57,7 +57,7 @@ discard block |
||
| 57 | 57 | foreach ($layouts as $l) { |
| 58 | 58 | $loop = isset($l['loop']) ? (int)$l['loop'] : 1; |
| 59 | 59 | unset($l['loop']); |
| 60 | - for ($i=0; $i<$loop; $i++) { |
|
| 60 | + for ($i = 0; $i < $loop; $i++) { |
|
| 61 | 61 | $computedLayouts[] = $l; |
| 62 | 62 | } |
| 63 | 63 | } |
@@ -221,7 +221,7 @@ discard block |
||
| 221 | 221 | } |
| 222 | 222 | $first = $this->rowFirstCellIndex($position); |
| 223 | 223 | |
| 224 | - return ($position - $first); |
|
| 224 | + return ($position-$first); |
|
| 225 | 225 | } |
| 226 | 226 | |
| 227 | 227 | /** |
@@ -262,7 +262,7 @@ discard block |
||
| 262 | 262 | */ |
| 263 | 263 | public function cellSpanBy12($position = null) |
| 264 | 264 | { |
| 265 | - $numColumns = $this->rowNumColumns($position); |
|
| 265 | + $numColumns = $this->rowNumColumns($position); |
|
| 266 | 266 | if (!$numColumns) { |
| 267 | 267 | return null; |
| 268 | 268 | } |
@@ -35,7 +35,7 @@ discard block |
||
| 35 | 35 | * @param Container $container A Pimple DI container. |
| 36 | 36 | * @return LayoutFactory |
| 37 | 37 | */ |
| 38 | - $container['dashboard/factory'] = function (Container $container) { |
|
| 38 | + $container['dashboard/factory'] = function(Container $container) { |
|
| 39 | 39 | return new Factory([ |
| 40 | 40 | 'base_class' => DashboardInterface::class, |
| 41 | 41 | 'default_class' => GenericDashboard::class, |
@@ -55,7 +55,7 @@ discard block |
||
| 55 | 55 | * @param Container $container A Pimple DI container. |
| 56 | 56 | * @return LayoutBuilder |
| 57 | 57 | */ |
| 58 | - $container['dashboard/builder'] = function (Container $container) { |
|
| 58 | + $container['dashboard/builder'] = function(Container $container) { |
|
| 59 | 59 | $dashboardFactory = $container['dashboard/factory']; |
| 60 | 60 | $dashboardBuilder = new DashboardBuilder($dashboardFactory, $container); |
| 61 | 61 | return $dashboardBuilder; |
@@ -4,9 +4,7 @@ |
||
| 4 | 4 | |
| 5 | 5 | use Pimple\Container; |
| 6 | 6 | use Pimple\ServiceProviderInterface; |
| 7 | - |
|
| 8 | 7 | use Charcoal\Factory\GenericFactory as Factory; |
| 9 | - |
|
| 10 | 8 | use Charcoal\Ui\Dashboard\DashboardBuilder; |
| 11 | 9 | use Charcoal\Ui\Dashboard\DashboardInterface; |
| 12 | 10 | use Charcoal\Ui\Dashboard\GenericDashboard; |
@@ -93,7 +93,7 @@ discard block |
||
| 93 | 93 | /** |
| 94 | 94 | * @param string $ident The menu item identifier. |
| 95 | 95 | * @throws InvalidArgumentException If the identifier argument is not a string. |
| 96 | - * @return MenuItem Chainable |
|
| 96 | + * @return AbstractMenuItem Chainable |
|
| 97 | 97 | */ |
| 98 | 98 | public function setIdent($ident) |
| 99 | 99 | { |
@@ -116,7 +116,7 @@ discard block |
||
| 116 | 116 | |
| 117 | 117 | /** |
| 118 | 118 | * @param mixed $label The menu item label. |
| 119 | - * @return MenuItem Chainable |
|
| 119 | + * @return AbstractMenuItem Chainable |
|
| 120 | 120 | */ |
| 121 | 121 | public function setLabel($label) |
| 122 | 122 | { |
@@ -125,7 +125,7 @@ discard block |
||
| 125 | 125 | } |
| 126 | 126 | |
| 127 | 127 | /** |
| 128 | - * @return string |
|
| 128 | + * @return \Charcoal\Translator\Translation|null |
|
| 129 | 129 | */ |
| 130 | 130 | public function label() |
| 131 | 131 | { |
@@ -134,7 +134,7 @@ discard block |
||
| 134 | 134 | |
| 135 | 135 | /** |
| 136 | 136 | * @param string $url The menu item URL. |
| 137 | - * @return MenuItem Chainable |
|
| 137 | + * @return AbstractMenuItem Chainable |
|
| 138 | 138 | */ |
| 139 | 139 | public function setUrl($url) |
| 140 | 140 | { |
@@ -160,7 +160,7 @@ discard block |
||
| 160 | 160 | |
| 161 | 161 | /** |
| 162 | 162 | * @param array $children The menu item children items structure. |
| 163 | - * @return MenuItem Chainable |
|
| 163 | + * @return AbstractMenuItem Chainable |
|
| 164 | 164 | */ |
| 165 | 165 | public function setChildren(array $children) |
| 166 | 166 | { |
@@ -174,7 +174,7 @@ discard block |
||
| 174 | 174 | /** |
| 175 | 175 | * @param array|MenuItem $child The child menu structure or object. |
| 176 | 176 | * @throws InvalidArgumentException If the child is not a menu object or structure. |
| 177 | - * @return MenuItem Chainable |
|
| 177 | + * @return AbstractMenuItem Chainable |
|
| 178 | 178 | */ |
| 179 | 179 | public function addChild($child) |
| 180 | 180 | { |
@@ -196,7 +196,7 @@ discard block |
||
| 196 | 196 | * Children (menu item) generator |
| 197 | 197 | * |
| 198 | 198 | * @param callable $childCallback Optional callback. |
| 199 | - * @return MenuItemInterface[] |
|
| 199 | + * @return \Generator |
|
| 200 | 200 | */ |
| 201 | 201 | public function children(callable $childCallback = null) |
| 202 | 202 | { |
@@ -82,7 +82,7 @@ discard block |
||
| 82 | 82 | |
| 83 | 83 | /** |
| 84 | 84 | * @param FactoryInterface $factory A factory, to create customized form gorup objects. |
| 85 | - * @return FormInterface Chainable |
|
| 85 | + * @return FormTrait Chainable |
|
| 86 | 86 | */ |
| 87 | 87 | public function setFormGroupFactory(FactoryInterface $factory) |
| 88 | 88 | { |
@@ -108,7 +108,7 @@ discard block |
||
| 108 | 108 | |
| 109 | 109 | /** |
| 110 | 110 | * @param callable $cb The group callback. |
| 111 | - * @return FormInterface Chainable |
|
| 111 | + * @return FormTrait Chainable |
|
| 112 | 112 | */ |
| 113 | 113 | public function setGroupCallback(callable $cb) |
| 114 | 114 | { |
@@ -120,7 +120,7 @@ discard block |
||
| 120 | 120 | /** |
| 121 | 121 | * @param string $action The "action" value, typically a URL. |
| 122 | 122 | * @throws InvalidArgumentException If the action argument is not a string. |
| 123 | - * @return FormInterface Chainable |
|
| 123 | + * @return FormTrait Chainable |
|
| 124 | 124 | */ |
| 125 | 125 | public function setAction($action) |
| 126 | 126 | { |
@@ -147,7 +147,7 @@ discard block |
||
| 147 | 147 | * |
| 148 | 148 | * @param string $method Either "post" or "get". |
| 149 | 149 | * @throws InvalidArgumentException If the method is not post or get. |
| 150 | - * @return FormInterface Chainable |
|
| 150 | + * @return FormTrait Chainable |
|
| 151 | 151 | */ |
| 152 | 152 | public function setMethod($method) |
| 153 | 153 | { |
@@ -172,7 +172,7 @@ discard block |
||
| 172 | 172 | |
| 173 | 173 | /** |
| 174 | 174 | * @param string $mode The l10n mode. |
| 175 | - * @return FormInterface Chainable |
|
| 175 | + * @return FormTrait Chainable |
|
| 176 | 176 | */ |
| 177 | 177 | public function setL10nMode($mode) |
| 178 | 178 | { |
@@ -193,7 +193,7 @@ discard block |
||
| 193 | 193 | * Set the object's form groups. |
| 194 | 194 | * |
| 195 | 195 | * @param array $groups A collection of group structures. |
| 196 | - * @return FormInterface Chainable |
|
| 196 | + * @return FormTrait Chainable |
|
| 197 | 197 | */ |
| 198 | 198 | public function setGroups(array $groups) |
| 199 | 199 | { |
@@ -212,7 +212,7 @@ discard block |
||
| 212 | 212 | * @param string $groupIdent The group identifier. |
| 213 | 213 | * @param array|FormGroupInterface $group The group object or structure. |
| 214 | 214 | * @throws InvalidArgumentException If the identifier is not a string or the group is invalid. |
| 215 | - * @return FormInterface Chainable |
|
| 215 | + * @return FormTrait Chainable |
|
| 216 | 216 | */ |
| 217 | 217 | public function addGroup($groupIdent, $group) |
| 218 | 218 | { |
@@ -315,7 +315,7 @@ discard block |
||
| 315 | 315 | * Retrieve the form groups. |
| 316 | 316 | * |
| 317 | 317 | * @param callable $groupCallback Optional callback applied to each form group. |
| 318 | - * @return FormGroupInterface[]|Generator |
|
| 318 | + * @return \Generator |
|
| 319 | 319 | */ |
| 320 | 320 | public function groups(callable $groupCallback = null) |
| 321 | 321 | { |
@@ -399,7 +399,7 @@ discard block |
||
| 399 | 399 | * |
| 400 | 400 | * @param string $mode Group display mode. |
| 401 | 401 | * @throws InvalidArgumentException If the display mode is not a string. |
| 402 | - * @return ObjectFormWidget Chainable. |
|
| 402 | + * @return FormTrait Chainable. |
|
| 403 | 403 | */ |
| 404 | 404 | public function setGroupDisplayMode($mode) |
| 405 | 405 | { |
@@ -440,7 +440,7 @@ discard block |
||
| 440 | 440 | |
| 441 | 441 | /** |
| 442 | 442 | * @param array $formData The (pre-populated) form data, as [$key=>$val] array. |
| 443 | - * @return FormInterface Chainable |
|
| 443 | + * @return FormTrait Chainable |
|
| 444 | 444 | */ |
| 445 | 445 | public function setFormData(array $formData) |
| 446 | 446 | { |
@@ -453,7 +453,7 @@ discard block |
||
| 453 | 453 | * @param string $key The form data key, or poperty identifier. |
| 454 | 454 | * @param mixed $val The form data value, for a given key. |
| 455 | 455 | * @throws InvalidArgumentException If the key argument is not a string. |
| 456 | - * @return FormInterface Chainable |
|
| 456 | + * @return FormTrait Chainable |
|
| 457 | 457 | */ |
| 458 | 458 | public function addFormData($key, $val) |
| 459 | 459 | { |
@@ -347,7 +347,7 @@ |
||
| 347 | 347 | public function groups(callable $groupCallback = null) |
| 348 | 348 | { |
| 349 | 349 | $groups = $this->groups; |
| 350 | - uasort($groups, [ $this, 'sortItemsByPriority' ]); |
|
| 350 | + uasort($groups, [$this, 'sortItemsByPriority']); |
|
| 351 | 351 | |
| 352 | 352 | $groupCallback = (isset($groupCallback) ? $groupCallback : $this->groupCallback); |
| 353 | 353 | |
@@ -2,8 +2,6 @@ |
||
| 2 | 2 | |
| 3 | 3 | namespace Charcoal\Ui\Dashboard; |
| 4 | 4 | |
| 5 | -use InvalidArgumentException; |
|
| 6 | - |
|
| 7 | 5 | // Intra-module (`charcoal-ui`) dependencies |
| 8 | 6 | use Charcoal\Ui\AbstractUiItem; |
| 9 | 7 | use Charcoal\Ui\Dashboard\DashboardInterface; |
@@ -152,7 +152,7 @@ |
||
| 152 | 152 | public function widgets(callable $widgetCallback = null) |
| 153 | 153 | { |
| 154 | 154 | $widgets = $this->widgets; |
| 155 | - uasort($widgets, [ $this, 'sortItemsByPriority' ]); |
|
| 155 | + uasort($widgets, [$this, 'sortItemsByPriority']); |
|
| 156 | 156 | |
| 157 | 157 | $widgetCallback = isset($widgetCallback) ? $widgetCallback : $this->widgetCallback; |
| 158 | 158 | foreach ($widgets as $widget) { |
@@ -13,7 +13,6 @@ |
||
| 13 | 13 | use Charcoal\Ui\Form\FormBuilder; |
| 14 | 14 | use Charcoal\Ui\Form\FormInterface; |
| 15 | 15 | use Charcoal\Ui\Form\GenericForm; |
| 16 | -use Charcoal\Ui\FormGroup\FormGroupBuilder; |
|
| 17 | 16 | use Charcoal\Ui\FormGroup\FormGroupInterface; |
| 18 | 17 | use Charcoal\Ui\FormGroup\GenericFormGroup; |
| 19 | 18 | use Charcoal\Ui\FormInput\FormInputBuilder; |