interface of all ViewHelpers.

package salt\view

 Methods

Return a text for a column

column(\salt\Field $field, string $format = NULL) : string

Parameters

$field

\salt\Field

the field to display

$format

string

format to use for change the output

Returns

stringHTML escaped text for describe $field in $format

Return a full form tag for edit the value

edit(\salt\Base $object, \salt\Field $field, mixed $value, string $format, array<mixed,mixed> $params) : string

Parameters

$object

\salt\Base

object that contains the value

$field

\salt\Field

the field

$value

mixed

the value to edit

$format

string

format to use

$params

array<mixed,mixed>

parameter passed to Base->FORM or Base->VIEW method

Returns

stringa full HTML form tag (input, select, etc...) for editing the value

Get the Base object who called the ViewHelper

getObject() : \salt\Base

Returns

\salt\Basethe objet to work on

Return a value to display with HTML escaping

show(\salt\Base $object, \salt\Field $field, mixed $value, string $format, array<mixed,mixed> $params) : string

Parameters

$object

\salt\Base

object that contains the value

$field

\salt\Field

the field

$value

mixed

the value to display

$format

string

format to use

$params

array<mixed,mixed>

parameter passed to Base->FORM or Base->VIEW method

Returns

stringa HTML escaped value

Return a value to display without HTML escaping

text(\salt\Base $object, \salt\Field $field, mixed $value, string $format, array<mixed,mixed> $params) : string

Parameters

$object

\salt\Base

object that contains the value

$field

\salt\Field

the field

$value

mixed

the value to display

$format

string

format to use

$params

array<mixed,mixed>

parameter passed to Base->FORM or Base->VIEW method

Returns

stringa non-HTML escaped value

 Constants

 

FORMAT_KEY

FORMAT_KEY = 'format' 
 

Raw format

RAW = 'raw'