Inheritance diagram for Char:

Public Member Functions
	clientConfig ()

	formatTag ($value)

Public Member Functions inherited from Widget
	__construct ($config=null)

	update ($config)
	Update the widget configuration. More...

	clientConfig ()
	Public configuration. More...

	caption ($id=null)

	hint ($id=null)

	convert ($value)
	Convert a value from user format to standard, internal format. More...

	clientConvert ($value)
	Convert a value from client format to standard, internal format. More...

	dataConvert ($value)
	Convert an internal value before it is stored in the request data. More...

	format ($value)
	Format a value from standard, internal format to user format. More...

	clientFormat ($value)
	Format a value from standard, internal format to client format. More...

	formatTag ($value)
	Format a tag value. More...

	purge ($value)
	Purge a value. More...

	expect ($action)
	Note if an action is expected. More...

	execute ()
	Execute an action on this widget. More...

	nothing ($value)
	Check if a value is empty. More...

	check ($value, $index=null)
	Check a value. More...

Public Member Functions inherited from Thing
	propertyExists ($property)
	Check if a property exists (public or published). More...

	constants ($prefix=null)
	Return all constants. More...

	get ($key)
	Get one or more properties. More...

	set ($key, $value=null)
	Set one or more properties. More...

	__get ($key)

	__set ($key, $value)

Data Fields
const	SIZE = 'size'
	Size of field. More...

const	PLACEHOLDER = 'placeholder'

const	SUGGEST = 'suggest'
	Suggestion optiones. This can be an assoc.array, a callback function (called with all extra. More...

const	NOTATION = 'notation'
	Regular expression describing the prefered notation style (e.g. '/^[A-z]/' = start with a. More...

const	TRANSFORM = 'transform'
	Transform the value (see \Rsi\Str::TRANSFORM_* constants). More...

const	TRIM = 'trim'
	Strip these characters from the beginning and end of the value (true for regular whitespace). More...

const	REGEX = 'regex'

	$regex = null

	$size = null

	$placeholder = null

	$suggest = null

	$suggestLimit = 10

	$notation = null

	$transform = null

	$trim = null

Data Fields inherited from Widget
const	CHILD_ID_SEPARATOR = '__'

const	CAPTION = 'caption'

const	DEFAULT_VALUE = 'defaultValue'

const	DISPLAY = 'display'
	Display type (see DISPLAY_* constants). More...

const	HELP = 'help'
	Help string (translated). More...

const	HINT = 'hint'
	Hint string (translated). More...

const	PARAMS = 'params'
	Extra parameters (prefix the key with a '@' to point to the value of another widget). More...

const	RIGHT = 'right'
	Optional different right with respect to the controller. If the user has the right, then (s)he. More...

const	TRAILER = 'trailer'
	Trailer string (translated). More...

const	TAGS = 'tags'
	Extra tags for help, hint, and trailer. More...

const	WIDGET_HELP = 'widgetHelp'
	General widget help (translated). More...

const	CLASS_NAME = 'className'

const	MIN = 'min'
	Minimum value. More...

const	MAX = 'max'
	Maximum value. More...

const	REQUIRED = 'required'
	True for required. Set to self::VALID_FUNC to let the validation function handle this. Use. More...

const	VALID_FUNC = 'validFunc'
	Specific validation function (called with value and index; returns true if OK). More...

const	WIDGETS = 'widgets'
	Optional child widgets (key = name, value = widget object). More...

const	SECURITY_CHECKS_IGNORE = 'securityChecksIgnore'
	Security checks to ignore (array with checks to ignore, true =. More...

const	DISPLAY_HIDDEN = 'h'
	Do not show (only hidden) More...

const	DISPLAY_MINIMAL = 'm'
	Show only value (without input element(s)). More...

const	DISPLAY_READABLE = 'r'
	Show input element(s), but read-only. More...

const	DISPLAY_WRITEABLE = 'w'
	Show editable input element(s). More...

const	EVENT_ACTION_PREFIX = 'controller:widget:action:'

	$defaultValue = null

	$help = null

	$min = null

	$max = null

	$required = null

	$trailer = null

	$widgetHelp = null

	$validFunc = null

	$parent = null
	Optional parent widget. More...

Data Fields inherited from Thing
const	HIDDEN = 0
	Property is hidden. More...

const	READABLE = 1
	Property is readable. More...

const	WRITEABLE = 2
	Property is writeable. More...

const	READWRITE = 3
	Property is readable and writeable. More...

Protected Member Functions
	purgeBase ($value)

	purgeTransform ($value)

	purgeTrim ($value)

	checkMin ($value, $index=null)

	checkMax ($value, $index=null)

	checkRegex ($value, $index=null)

	actionSuggest ()

	getParams ()

Protected Member Functions inherited from Widget
	init ()

	config ($key, $default=null)
	Get single configuration value. More...

	purgeBase ($value)
	Purge function that will be called first. More...

	executeChild ($id)
	Execute an action on a child widget. More...

	checkMin ($value, $index=null)

	checkMax ($value, $index=null)

	checkRequired ($value, $index=null)
	Required check. More...

	checkValidFunc ($value, $index=null)

	actionHelp ()

	setController ($value)

	getDisplay ()

	getFred ()

	getId ()

	getParams ()

	getReadable ()

	getRight ()

	getTags ()

	getWidgets ()

	getWriteable ()

	_get ($key)

Protected Member Functions inherited from Thing
	publish ($property, $visibility=self::READABLE)
	Publish a property (or hide it again). More...

	configure ($config)
	Configure the object. More...

	_get ($key)
	Default getter if no specific setter is defined, and the property is also not published (readable). More...

	_set ($key, $value)
	Default setter if no specific setter is defined, and the property is also not published (writeable). More...

Additional Inherited Members
Protected Attributes inherited from Widget
	$_controller = null

	$_id = null

	$_widgets = null
	Optional child widgets. More...

	$_securityChecksIgnore = []
	Security checks to ignore. More...

	$_config = []
	Widget configuration (see constants). More...

	$_display = null

	$_params = null

	$_right = null

	$_tags = null

Protected Attributes inherited from Thing
	$_published = []
	Published properties (key = name of property, value = visibility). More...

Detailed Description

Definition at line 5 of file Char.php.

Member Function Documentation

◆ actionSuggest()

actionSuggest ( )

protected

Definition at line 64 of file Char.php.

◆ checkMax()

checkMax	(	$value,
		$index = `null`
	)

protected

Definition at line 56 of file Char.php.

◆ checkMin()

checkMin	(	$value,
		$index = `null`
	)

protected

Definition at line 52 of file Char.php.

◆ checkRegex()

checkRegex	(	$value,
		$index = `null`
	)

protected

Definition at line 60 of file Char.php.

◆ clientConfig()

clientConfig ( )

Definition at line 30 of file Char.php.

◆ formatTag()

formatTag ( $value )

Definition at line 36 of file Char.php.

◆ getParams()

getParams ( )

protected

Definition at line 88 of file Char.php.

◆ purgeBase()

purgeBase ( $value )

protected

Definition at line 40 of file Char.php.

◆ purgeTransform()

purgeTransform ( $value )

protected

Definition at line 44 of file Char.php.

◆ purgeTrim()

purgeTrim ( $value )

protected

Definition at line 48 of file Char.php.

Field Documentation

◆ $notation

$notation = null

Definition at line 26 of file Char.php.

◆ $placeholder

$placeholder = null

Definition at line 23 of file Char.php.

◆ $regex

$regex = null

Definition at line 21 of file Char.php.

◆ $size

$size = null

Definition at line 22 of file Char.php.

◆ $suggest

$suggest = null

Definition at line 24 of file Char.php.

◆ $suggestLimit

$suggestLimit = 10

Definition at line 25 of file Char.php.

◆ $transform

$transform = null

Definition at line 27 of file Char.php.

◆ $trim

$trim = null

Definition at line 28 of file Char.php.

◆ NOTATION

const NOTATION = 'notation'

Regular expression describing the prefered notation style (e.g. '/^[A-z]/' = start with a.

Definition at line 13 of file Char.php.

◆ PLACEHOLDER

const PLACEHOLDER = 'placeholder'

Definition at line 9 of file Char.php.

◆ REGEX

const REGEX = 'regex'

Definition at line 19 of file Char.php.

◆ SIZE

const SIZE = 'size'

Size of field.

Definition at line 8 of file Char.php.

◆ SUGGEST

const SUGGEST = 'suggest'

Suggestion optiones. This can be an assoc.array, a callback function (called with all extra.

Definition at line 10 of file Char.php.

◆ TRANSFORM

const TRANSFORM = 'transform'

Transform the value (see \Rsi\Str::TRANSFORM_* constants).

Definition at line 15 of file Char.php.

◆ TRIM

const TRIM = 'trim'

Strip these characters from the beginning and end of the value (true for regular whitespace).

Definition at line 16 of file Char.php.

The documentation for this class was generated from the following file:

/var/www/fred.local/vendor/rsi/fred/src/Rsi/Fred/Controller/Widget/Char.php

Public Member Functions

Data Fields

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ actionSuggest()

◆ checkMax()

◆ checkMin()

◆ checkRegex()

◆ clientConfig()

◆ formatTag()

◆ getParams()

◆ purgeBase()

◆ purgeTransform()

◆ purgeTrim()

Field Documentation

◆ $notation

◆ $placeholder

◆ $regex

◆ $size

◆ $suggest

◆ $suggestLimit

◆ $transform

◆ $trim

◆ NOTATION

◆ PLACEHOLDER

◆ REGEX

◆ SIZE

◆ SUGGEST

◆ TRANSFORM

◆ TRIM