TYPO3  7.6
Public Member Functions | Protected Attributes | List of all members
CheckboxViewHelper Class Reference
Inheritance diagram for CheckboxViewHelper:
AbstractFormFieldViewHelper AbstractFormViewHelper AbstractTagBasedViewHelper AbstractViewHelper

Public Member Functions

 initializeArguments ()
 
 render ($checked=null, $multiple=null)
 
- Public Member Functions inherited from AbstractFormFieldViewHelper
 initializeArguments ()
 
 getRespectSubmittedDataValue ()
 
 setRespectSubmittedDataValue ($respectSubmittedDataValue)
 

Protected Attributes

 $tagName = 'input'
 
- Protected Attributes inherited from AbstractFormFieldViewHelper
 $configurationManager
 
 $respectSubmittedDataValue = false
 
- Protected Attributes inherited from AbstractFormViewHelper
 $persistenceManager
 
- Protected Attributes inherited from AbstractTagBasedViewHelper
 $tag = null
 
 $tagName = 'div'
 
- Protected Attributes inherited from AbstractViewHelper
 $arguments
 
 $templateVariableContainer
 
 $controllerContext
 
 $renderingContext
 
 $renderChildrenClosure = null
 
 $viewHelperVariableContainer
 
 $objectManager
 
 $escapingInterceptorEnabled = true
 

Additional Inherited Members

- Static Public Member Functions inherited from AbstractViewHelper
static renderStatic (array $arguments,\Closure $renderChildrenClosure,\TYPO3\CMS\Fluid\Core\Rendering\RenderingContextInterface $renderingContext)
 
- Protected Member Functions inherited from AbstractFormFieldViewHelper
 getName ()
 
 getRequest ()
 
 getNameWithoutPrefix ()
 
 getValue ($convertObjects=true)
 
 getValueAttribute ()
 
 getValueFromSubmittedFormData ($value)
 
 convertToPlainValue ($value)
 
 hasMappingErrorOccurred ()
 
 getLastSubmittedFormData ()
 
 addAdditionalIdentityPropertiesIfNeeded ()
 
 getPropertyValue ()
 
 isObjectAccessorMode ()
 
 setErrorClassAttribute ()
 
 getMappingResultsForProperty ()
 
 renderHiddenFieldForEmptyValue ()
 

Detailed Description

View Helper which creates a simple checkbox (<input type="checkbox">).

= Examples =

<f:form.checkbox name="myCheckBox" value="someValue" /> <output> <input type="checkbox" name="myCheckBox" value="someValue"> </output>

<f:form.checkbox name="myCheckBox" value="someValue" checked="{object.value} == 5" /> <output> <input type="checkbox" name="myCheckBox" value="someValue" checked="checked"> (depending on $object) </output>

<f:form.checkbox property="interests" value="TYPO3" /> <output> <input type="checkbox" name="user[interests][]" value="TYPO3" checked="checked"> (depending on property "interests") </output>

Definition at line 45 of file CheckboxViewHelper.php.

Member Function Documentation

initializeArguments ( )
render (   $checked = null,
  $multiple = null 
)

Renders the checkbox.

Parameters
bool$checkedSpecifies that the input element should be preselected
bool$multipleSpecifies whether this checkbox belongs to a multivalue (is part of a checkbox group)
Exceptions
\TYPO3\CMS\Fluid\Core\ViewHelper\Exception
Returns
string

Definition at line 80 of file CheckboxViewHelper.php.

References elseif, AbstractFormFieldViewHelper\getLastSubmittedFormData(), AbstractFormFieldViewHelper\getName(), AbstractFormFieldViewHelper\getPropertyValue(), AbstractFormFieldViewHelper\getValueAttribute(), AbstractFormFieldViewHelper\hasMappingErrorOccurred(), AbstractFormViewHelper\registerFieldNameForFormTokenGeneration(), AbstractFormFieldViewHelper\renderHiddenFieldForEmptyValue(), and AbstractFormFieldViewHelper\setErrorClassAttribute().

Member Data Documentation

$tagName = 'input'
protected

Definition at line 50 of file CheckboxViewHelper.php.