Hint Class Reference

Inheritance diagram for Hint:

Public Member Functions
	clientConfig ()
	add ($id, $selector, $from=0, $limit=null, $config=null)
	Add a hint. More...
	trans ($id, $count=null)
	Translate a hint. More...
Public Member Functions inherited from Component
	__construct ($fred, $config=null)
	__destruct ()
	clientConfig ()
	Public configuration. More...
	config ($key, $default=null)
	Retrieve a config value. More...
	ping ()
	Ping function. More...
	filemtime ($filename)
	Filemtime with session cache. More...
	component ($name)
	Get a component (local or default). More...
	components (... $names)
	Get multiple components in an array. 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
	$transId = 'hint-*'
	An asterisk will be replaced with the widget ID or type. More...
	$closeCaption = null
	Caption for the close button (will be translated). More...
	$ignore = []
	ID's of hints to ignore (do not show - anymore). More...
	$ignoreAll = false
	Set to true to ignore all hints. More...
	$counts = []
Data Fields inherited from Component
	$filemtimeTtl = 0
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 Attributes
	$_hints = []
Protected Attributes inherited from Component
	$_fred = null
	$_config = null
	$_name = null
	$_components = []
	Local components (key = component name, value = component). More...
	$_session = null
Protected Attributes inherited from Thing
	$_published = []
	Published properties (key = name of property, value = visibility). More...

Additional Inherited Members
Protected Member Functions inherited from Component
	init ()
	done ()
	getSession ()
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...

Detailed Description

Definition at line 5 of file Hint.php.

Member Function Documentation

add()

add	(		$id,
			$selector,
			$from = 0,
			$limit = null,
			$config = null
	)

Add a hint.

Parameters

string	$id	Unique ID for the hint.
string	$selector	Selector for the hint (e.g. CSS selector for HTML view).
int	$from	Show this hint from this presentation onwards (1 = do not show hint first time).
int	$limit	Show this hint only for this amount of times (empty = no limit).
array	$config	Extra config for the hint.

Definition at line 30 of file Hint.php.

clientConfig()

clientConfig

(

)

Definition at line 15 of file Hint.php.

trans()

trans	(		$id,
			$count = null
	)

Translate a hint.

Parameters

string	$id	Hint ID.
int	$count	Presentation counter (0 on first presentation).

Returns

string Translated hint.

Definition at line 40 of file Hint.php.

Field Documentation

$_hints

$_hints = []

protected

Definition at line 13 of file Hint.php.

$closeCaption

$closeCaption = null

Caption for the close button (will be translated).

Definition at line 8 of file Hint.php.

$counts

$counts = []

Definition at line 11 of file Hint.php.

$ignore

$ignore = []

ID's of hints to ignore (do not show - anymore).

Definition at line 9 of file Hint.php.

$ignoreAll

$ignoreAll = false

Set to true to ignore all hints.

Definition at line 10 of file Hint.php.

$transId

$transId = 'hint-*'

An asterisk will be replaced with the widget ID or type.

Definition at line 7 of file Hint.php.

---

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

• /var/www/fred.local/vendor/rsi/fred/src/Rsi/Fred/Hint.php