Fuman
\

\app_core_form_radiogroup

Represents a radio-button list.

Summary

Methods
Properties
Constants
__construct()
setFilterAppliance()
hasItems()
setItems()
getItems()
createItem()
addItem()
addItemObject()
setItemActive()
setItemsActive()
setFormValue()
multipleEnabled()
enableMultiple()
orderItems()
setId()
getId()
setName()
getName()
getFormValue()
hasFormValue()
getValue()
hasValue()
setValue()
setAttribute()
setReadOnly()
removeReadOnly()
__clone()
setAttributes()
setDataAttribute()
hasAttribute()
hasDataAttribute()
getAttribute()
getAttributeValue()
getDataAttribute()
removeAttribute()
removeDataAttribute()
createAttribute()
prepareAttribute()
setFrontend()
isFrontend()
addCssFile()
addCssFiles()
getCssFiles()
hasCssFiles()
addJsFile()
addJsFiles()
setJsFiles()
getJsFiles()
hasJsFiles()
addJsClass()
addJsClasses()
hasJSClasses()
getJsClasses()
setJsClasses()
addJsProperty()
getJsProperties()
hasJsProperties()
addLockId()
hasLockIds()
getLockIds()
getTemplatePath()
hasTemplatePath()
setTemplatePath()
getData()
setData()
hasData()
__set()
__get()
__isset()
toObject()
prepareAndGetItemsForRendering()
createValueList()
transformRequestValue()
No public properties found
SELECTED
ORDER_TYPE_VALUE
ORDER_TYPE_TEXT
DATA_PREFIX
JAVASCIPT_LOAD_TYPE_DEFAULT
JAVASCIPT_LOAD_TYPE_EXTERNAL
JAVASCIPT_LOAD_TYPE_EXTERNAL_ASYNC
CHECKED
_getTemplatePath()
_setInactive()
_setActive()
_enableMultiple()
_disableMultiple()
_compareByValue()
_compareByText()
_compareCssFiles()
_compareJsFiles()
$_multipleEnabled
$_disabledAttributes
$_javascriptOptions
$_value
$_data
$_templatePath
$_jsFiles
$_jsProperties
$_cssFiles
$_jsClasses
$_lockIds
$_isFrontend
N/A
No private methods found
No private properties found
N/A

Constants

SELECTED

SELECTED

ORDER_TYPE_VALUE

ORDER_TYPE_VALUE

ORDER_TYPE_TEXT

ORDER_TYPE_TEXT

DATA_PREFIX

DATA_PREFIX

JAVASCIPT_LOAD_TYPE_DEFAULT

JAVASCIPT_LOAD_TYPE_DEFAULT

JAVASCIPT_LOAD_TYPE_EXTERNAL

JAVASCIPT_LOAD_TYPE_EXTERNAL

JAVASCIPT_LOAD_TYPE_EXTERNAL_ASYNC

JAVASCIPT_LOAD_TYPE_EXTERNAL_ASYNC

CHECKED

CHECKED

Properties

$_multipleEnabled

$_multipleEnabled : boolean

Type

boolean

$_disabledAttributes

$_disabledAttributes : array

Disabled Attributes for setAttribute()

Type

array

$_javascriptOptions

$_javascriptOptions : array

Holds the options form the component js classes

Type

array

$_value

$_value : mixed

Type

mixed

$_data

$_data : \stdClass

Data for template

Type

\stdClass

$_templatePath

$_templatePath : string

Path to the template file (*.phtml, .

..)

Type

string

$_jsFiles

$_jsFiles : array

List of required JS files

Type

array

$_jsProperties

$_jsProperties : array

List of JS properties

Type

array

$_cssFiles

$_cssFiles : array

List of required CSS files

Type

array

$_jsClasses

$_jsClasses : array

List of required JS classes

Type

array

$_lockIds

$_lockIds : array

List of lock ids

Type

array

$_isFrontend

$_isFrontend : boolean

Is this response used for frontend

Type

boolean

Methods

__construct()

__construct(string  $name, null|string  $value = null, array|null  $items = null) : \Fuman_Form_List_Abstract

Constructor

Parameters

string $name
null|string $value
array|null $items

Returns

\Fuman_Form_List_Abstract

setFilterAppliance()

setFilterAppliance()

Set Filter Appliance

hasItems()

hasItems() : boolean

Has items

Returns

boolean

setItems()

setItems(array  $items)

Sets items

Parameters

array $items

getItems()

getItems() : mixed

Returns

mixed

createItem()

createItem(string  $value, string  $text, array  $attributes = array()) : \stdClass

Create item

Parameters

string $value
string $text
array $attributes

Returns

\stdClass

addItem()

addItem(string  $value, string  $text, boolean  $setActive = false) : \stdClass

Add item

Parameters

string $value
string $text
boolean $setActive

Returns

\stdClass

addItemObject()

addItemObject(\stdClass  $item, boolean  $setActive = false) : \stdClass

Adds item object

Parameters

\stdClass $item
boolean $setActive

Returns

\stdClass

setItemActive()

setItemActive(\stdClass  $item, boolean  $setOthersInactive = false) : void

Set item active

Parameters

\stdClass $item
boolean $setOthersInactive

setItemsActive()

setItemsActive(array  $items, boolean  $setOthersInactive = false) : void

Set multiple items active

Parameters

array $items
boolean $setOthersInactive

setFormValue()

setFormValue(string  $value)

Parameters

string $value

multipleEnabled()

multipleEnabled() : boolean

Is multi select enabled

Returns

boolean

enableMultiple()

enableMultiple(boolean  $enable = true) : void

Enable multiple select

Parameters

boolean $enable

orderItems()

orderItems(string  $type) : void

Order items by type

Parameters

string $type

setId()

setId(integer|null  $id) : void

Sets id

Parameters

integer|null $id

getId()

getId() : integer

Gets id

Returns

integer

setName()

setName(string  $name) : void

Sets name

Parameters

string $name

getName()

getName() : string

Gets name

Returns

string

getFormValue()

getFormValue() : string

Get value of form field

Returns

string

hasFormValue()

hasFormValue() : boolean

Returns true if value is set.

Returns

boolean

getValue()

getValue(string  $key) : object|string

Gets value

Parameters

string $key

Returns

object|string

hasValue()

hasValue(string  $key) : boolean

Has value

Parameters

string $key

Returns

boolean

setValue()

setValue(string  $key, mixed|object  $value) : void

Sets value

Parameters

string $key
mixed|object $value

setAttribute()

setAttribute(string  $key, string  $value, boolean  $appendValue = true, string  $appendSpacer = ' ') : void

Sets an attribute. If $appendValue is true, the value is going to be appended with the $appendSpacer argument.

Parameters

string $key
string $value
boolean $appendValue
string $appendSpacer

setReadOnly()

setReadOnly() : void

Adds readOnly to attribute list

removeReadOnly()

removeReadOnly() : void

Removes readOnly from attribute list

__clone()

__clone() : void

Clone Method

setAttributes()

setAttributes(array  $attributes, boolean  $appendValue = true, string  $appendSpacer = ' ')

Sets an array of attributes. If $appendValue is true, the value is going to be appended with the $appendSpacer argument.

Parameters

array $attributes
boolean $appendValue
string $appendSpacer

setDataAttribute()

setDataAttribute(string  $key, string  $value) : void

Sets a data attribute. Data attributes will always be overwritten.

Parameters

string $key
string $value

hasAttribute()

hasAttribute(string  $key) : boolean

Returns true if attribute is set.

Parameters

string $key

Returns

boolean

hasDataAttribute()

hasDataAttribute(string  $key) : boolean

Returns true if data attribute is set.

Parameters

string $key

Returns

boolean

getAttribute()

getAttribute(string  $key) : string|object

Returns attribute.

Parameters

string $key

Returns

string|object

getAttributeValue()

getAttributeValue(  $key) : string|null

Returns attribute value

Parameters

$key

Returns

string|null

getDataAttribute()

getDataAttribute(string  $key) : string

Returns data attribute.

Parameters

string $key

Returns

string

removeAttribute()

removeAttribute(string  $key) : void

Removes an attribute.

Parameters

string $key

removeDataAttribute()

removeDataAttribute(string  $key) : void

Removes a data attribute.

Parameters

string $key

createAttribute()

createAttribute(string  $key, string  $value) : \stdClass

Returns an attribute object.

Parameters

string $key
string $value

Returns

\stdClass

prepareAttribute()

prepareAttribute(string  $value) : string

Prepares an attribute (strips double quotes)

Parameters

string $value

Returns

string

setFrontend()

setFrontend(boolean  $flag)

Sets frontend flag for object If already set, method call will be ignored

Parameters

boolean $flag

isFrontend()

isFrontend() : boolean

Is object for a frontend request

Returns

boolean

addCssFile()

addCssFile(string  $path, string  $media = 'all', string|null  $packageName = null) : \Fuman_Response_Data

Add a CSS file

Parameters

string $path
string $media
string|null $packageName

Used for pack.php

Returns

\Fuman_Response_Data

addCssFiles()

addCssFiles(array  $cssFiles) : void

Adds an array of cssFiles the files will be internally added to the root response data object

Parameters

array $cssFiles

getCssFiles()

getCssFiles() : array

Returns all CSS files

Returns

array

hasCssFiles()

hasCssFiles() : boolean

Returns true when more than 0 css files are set

Returns

boolean

addJsFile()

addJsFile(string  $path, integer  $javaScriptLoadType, string|null  $packageName = null) : \Fuman_Response_Data

Add a Js file

Parameters

string $path
integer $javaScriptLoadType
string|null $packageName

Used for pack.php

Returns

\Fuman_Response_Data

addJsFiles()

addJsFiles(array  $jsFiles, boolean  $toTop = false) : void

Adds an array of jsFiles the files will be internally added to the root response data object

Parameters

array $jsFiles
boolean $toTop

setJsFiles()

setJsFiles(array  $jsFiles)

Set js files

Parameters

array $jsFiles

getJsFiles()

getJsFiles() : array

Returns all js files

Returns

array

hasJsFiles()

hasJsFiles() : boolean

Does the object contains js files

Returns

boolean

addJsClass()

addJsClass(string  $jsClassName, null|\stdClass  $options = null) : void

Adds an array of jsFiles the files will be internally added to the root response data object

Parameters

string $jsClassName
null|\stdClass $options

addJsClasses()

addJsClasses(array  $jsClasses) : void

Adds js classes

Parameters

array $jsClasses

hasJSClasses()

hasJSClasses() : boolean

Has javascript class

Returns

boolean

getJsClasses()

getJsClasses() : array

Get javascript classes

Returns

array

setJsClasses()

setJsClasses(array  $jsClasses)

Set javascript classes

Parameters

array $jsClasses

addJsProperty()

addJsProperty(string  $key, \stdClass|string  $value) : void

Adds JS properties the properties will be internally added to the root response data object

Parameters

string $key
\stdClass|string $value

getJsProperties()

getJsProperties() : array

Returns all js properties

Returns

array

hasJsProperties()

hasJsProperties() : boolean

Does the object contains js properties

Returns

boolean

addLockId()

addLockId(integer  $lockId) : void

Add lock id

Parameters

integer $lockId

hasLockIds()

hasLockIds() : boolean

Has lock ids

Returns

boolean

getLockIds()

getLockIds() : \array[int]

Get lock ids

Returns

\array[int]

getTemplatePath()

getTemplatePath() : string

Gets the script path

Returns

string

hasTemplatePath()

hasTemplatePath() : boolean

Has script path

Returns

boolean

setTemplatePath()

setTemplatePath(string  $templatePath) : \Fuman_Response_Data

Sets script path

Parameters

string $templatePath

Returns

\Fuman_Response_Data

getData()

getData() : null|\stdClass

Gets data object

Returns

null|\stdClass

setData()

setData(\stdClass  $data) : void

Sets data object

Parameters

\stdClass $data

hasData()

hasData() : boolean

Has data object

Returns

boolean

__set()

__set(string  $key, object  $value) : void

Sets value on data

Parameters

string $key
object $value

__get()

__get(string  $key) : null

Gets value from data

Parameters

string $key

Returns

null

__isset()

__isset(string  $key) : boolean

Is set key on data

Parameters

string $key

Returns

boolean

toObject()

toObject() : \stdClass

Creates stdClass/object ot data object

Returns

\stdClass

prepareAndGetItemsForRendering()

prepareAndGetItemsForRendering() : array

Returns

array

createValueList()

createValueList(array  $values) : array

Converts the request value in normal, everyday used format

Parameters

array $values

Returns

array

transformRequestValue()

transformRequestValue(  $value) : mixed

Check if it should transform the value from the request

Parameters

$value

Returns

mixed —

if possible, the transformed value

_getTemplatePath()

_getTemplatePath() : string

Returns template path.

Returns

string

_setInactive()

_setInactive(\stdClass  $item) : void

Set item inactive.

Parameters

\stdClass $item

_setActive()

_setActive(\stdClass  $item) : void

Set item active.

Parameters

\stdClass $item

_enableMultiple()

_enableMultiple() : void

Adds the multiple attribute.

_disableMultiple()

_disableMultiple() : void

Removes the multiple attribute.

_compareByValue()

_compareByValue(\stdClass  $a, \stdClass  $b) : integer

Sorts list by value

Parameters

\stdClass $a
\stdClass $b

Returns

integer

_compareByText()

_compareByText(\stdClass  $a, \stdClass  $b) : integer

Sorts list by text

Parameters

\stdClass $a
\stdClass $b

Returns

integer

_compareCssFiles()

_compareCssFiles(\stdClass  $a, \stdClass  $b) : integer

Compares css files

Parameters

\stdClass $a
\stdClass $b

Returns

integer

_compareJsFiles()

_compareJsFiles(\stdClass  $a, \stdClass  $b) : integer

Compares JS files

Parameters

\stdClass $a
\stdClass $b

Returns

integer