Skip to content

Commit

Permalink
Rename FormHelper methods to be less confusing.
Browse files Browse the repository at this point in the history 
input() => control()
inputs() => controls()
allInputs() => allControls()
  • Loading branch information
@ADmad
ADmad committed Dec 30, 2016
1 parent 358b255 commit 12de85e
Show file tree
Hide file tree
Showing 2 changed files with 371 additions and 316 deletions.
103 changes: 79 additions & 24 deletions src/View/Helper/FormHelper.php
View file
Expand Up @@ -857,20 +857,20 @@ public function label($fieldName, $text = null, array $options = [])
}

/**
* Generate a set of inputs for `$fields`. If $fields is empty the fields of current model
* will be used.
* Generate a set of controls for `$fields`. If $fields is empty the fields
* of current model will be used.
*
* You can customize individual inputs through `$fields`.
* You can customize individual controls through `$fields`.
* ```
* $this->Form->allInputs([
* $this->Form->allControls([
* 'name' => ['label' => 'custom label']
* ]);
* ```
*
* You can exclude fields by specifying them as false:
* You can exclude fields by specifying them as `false`:
*
* ```
* $this->Form->allInputs(['title' => false]);
* $this->Form->allControls(['title' => false]);
* ```
*
* In the above example, no field would be generated for the title field.
Expand All @@ -881,12 +881,12 @@ public function label($fieldName, $text = null, array $options = [])
* - `fieldset` Set to false to disable the fieldset. You can also pass an array of params to be
* applied as HTML attributes to the fieldset tag. If you pass an empty array, the fieldset will
* be enabled
* - `legend` Set to false to disable the legend for the generated input set. Or supply a string
* - `legend` Set to false to disable the legend for the generated control set. Or supply a string
* to customize the legend text.
* @return string Completed form inputs.
* @return string Completed form controls.
* @link http://book.cakephp.org/3.0/en/views/helpers/form.html#generating-entire-forms
*/
public function allInputs(array $fields = [], array $options = [])
public function allControls(array $fields = [], array $options = [])
{
$context = $this->_getContext();

Expand All @@ -897,32 +897,53 @@ public function allInputs(array $fields = [], array $options = [])
Hash::normalize($fields)
);

return $this->inputs($fields, $options);
return $this->controls($fields, $options);
}

/**
* Generate a set of inputs for `$fields` wrapped in a fieldset element.
* Generate a set of controls for `$fields`. If $fields is empty the fields
* of current model will be used.
*
* You can customize individual inputs through `$fields`.
* @param array $fields An array of customizations for the fields that will be
* generated. This array allows you to set custom types, labels, or other options.
* @param array $options Options array. Valid keys are:
* - `fieldset` Set to false to disable the fieldset. You can also pass an array of params to be
* applied as HTML attributes to the fieldset tag. If you pass an empty array, the fieldset will
* be enabled
* - `legend` Set to false to disable the legend for the generated control set. Or supply a string
* to customize the legend text.
* @return string Completed form controls.
* @link http://book.cakephp.org/3.0/en/views/helpers/form.html#generating-entire-forms
* @deprecated 3.4.0 Use FormHelper::allControls() instead.
*/
public function allInputs(array $fields = [], array $options = [])
{
return $this->allControls($fields, $options);
}

/**
* Generate a set of controls for `$fields` wrapped in a fieldset element.
*
* You can customize individual controls through `$fields`.
* ```
* $this->Form->inputs([
* $this->Form->controls([
* 'name' => ['label' => 'custom label'],
* 'email'
* ]);
* ```
*
* @param array $fields An array of the fields to generate. This array allows you to set custom
* types, labels, or other options.
* @param array $fields An array of the fields to generate. This array allows
* you to set custom types, labels, or other options.
* @param array $options Options array. Valid keys are:
* - `fieldset` Set to false to disable the fieldset. You can also pass an array of params to be
* applied as HTML attributes to the fieldset tag. If you pass an empty array, the fieldset will
* be enabled
* - `legend` Set to false to disable the legend for the generated input set. Or supply a string
* to customize the legend text.
* - `fieldset` Set to false to disable the fieldset. You can also pass an
* array of params to be applied as HTML attributes to the fieldset tag.
* If you pass an empty array, the fieldset will be enabled.
* - `legend` Set to false to disable the legend for the generated input set.
* Or supply a string to customize the legend text.
* @return string Completed form inputs.
* @link http://book.cakephp.org/3.0/en/views/helpers/form.html#generating-entire-forms
*/
public function inputs(array $fields, array $options = [])
public function controls(array $fields, array $options = [])
{
$fields = Hash::normalize($fields);

Expand All @@ -932,12 +953,32 @@ public function inputs(array $fields, array $options = [])
continue;
}

$out .= $this->input($name, (array)$opts);
$out .= $this->control($name, (array)$opts);
}

return $this->fieldset($out, $options);
}

/**
* Generate a set of controls for `$fields` wrapped in a fieldset element.
*
* @param array $fields An array of the fields to generate. This array allows
* you to set custom types, labels, or other options.
* @param array $options Options array. Valid keys are:
* - `fieldset` Set to false to disable the fieldset. You can also pass an
* array of params to be applied as HTML attributes to the fieldset tag.
* If you pass an empty array, the fieldset will be enabled.
* - `legend` Set to false to disable the legend for the generated input set.
* Or supply a string to customize the legend text.
* @return string Completed form inputs.
* @link http://book.cakephp.org/3.0/en/views/helpers/form.html#generating-entire-forms
* @deprecated 3.4.0 Use FormHelper::controls() instead.
*/
public function inputs(array $fields, array $options = [])
{
return $this->controls($fields, $options);
}

/**
* Wrap a set of inputs in a fieldset
*
Expand Down Expand Up @@ -989,7 +1030,7 @@ public function fieldset($fields = '', array $options = [])
}

/**
* Generates a form input element complete with label and wrapper div
* Generates a form control element complete with label and wrapper div.
*
* ### Options
*
Expand All @@ -1016,7 +1057,7 @@ public function fieldset($fields = '', array $options = [])
* @return string Completed form widget.
* @link http://book.cakephp.org/3.0/en/views/helpers/form.html#creating-form-inputs
*/
public function input($fieldName, array $options = [])
public function control($fieldName, array $options = [])
{
$options += [
'type' => null,
Expand Down Expand Up @@ -1090,6 +1131,20 @@ public function input($fieldName, array $options = [])
return $result;
}

/**
* Generates a form control element complete with label and wrapper div.
*
* @param string $fieldName This should be "modelname.fieldname"
* @param array $options Each type of input takes different options.
* @return string Completed form widget.
* @link http://book.cakephp.org/3.0/en/views/helpers/form.html#creating-form-inputs
* @deprecated 3.4.0 Use FormHelper::control() instead.
*/
public function input($fieldName, array $options = [])
{
return $this->control($fieldName, $options);
}

/**
* Generates an group template element
*
Expand Down

0 comments on commit 12de85e

Please sign in to comment.