FRED™  3.0
FRED™: Framework for Rapid and Easy Development
Builder Class Reference
Inheritance diagram for Builder:
Thing Format Table

Public Member Functions

 __construct ($view)
 
 build ($ids)
 
- 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)
 

Static Public Member Functions

static row ($ids, $row, $index=null)
 Add a row. More...
 

Data Fields

const RENDER_CAPTION = '~'
 ID prefix indicating to render only the caption. More...
 
const RENDER_WIDGET = '$'
 ID prefix indicating to render only the widget. More...
 
const RENDER_BOTH = '%'
 ID prefix indicating to render both caption and widget (explicitly). More...
 
const RENDER_WILD = '*'
 Render all (between previous and next id). 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

 trim ($id)
 
 next ($ids)
 
 expand ($ids, &$done=[])
 
 renderCaption ($id)
 
 renderWidget ($id)
 
 getHtml ()
 
- 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...
 

Protected Attributes

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

Detailed Description

Definition at line 5 of file Builder.php.

Constructor & Destructor Documentation

◆ __construct()

__construct (   $view)

Definition at line 14 of file Builder.php.

Member Function Documentation

◆ build()

build (   $ids)

Definition at line 70 of file Builder.php.

◆ expand()

expand (   $ids,
$done = [] 
)
protected

Definition at line 49 of file Builder.php.

◆ getHtml()

getHtml ( )
protected

Definition at line 78 of file Builder.php.

◆ next()

next (   $ids)
protected

Definition at line 41 of file Builder.php.

◆ renderCaption()

renderCaption (   $id)
protected

Definition at line 62 of file Builder.php.

◆ renderWidget()

renderWidget (   $id)
protected

Definition at line 66 of file Builder.php.

◆ row()

static row (   $ids,
  $row,
  $index = null 
)
static

Add a row.

Parameters
array$idsCurrent set of widget ID's.
array$rowWidget ID's for the row.
string$indexPosition to insert the row (before; empty to add on end).
Returns
array Widget ID's with the row added (duplicate ID's are removed from the original set).

Definition at line 24 of file Builder.php.

◆ trim()

trim (   $id)
protected

Definition at line 37 of file Builder.php.

Field Documentation

◆ $_view

$_view
protected

Definition at line 12 of file Builder.php.

◆ RENDER_BOTH

const RENDER_BOTH = '%'

ID prefix indicating to render both caption and widget (explicitly).

Definition at line 9 of file Builder.php.

◆ RENDER_CAPTION

const RENDER_CAPTION = '~'

ID prefix indicating to render only the caption.

Definition at line 7 of file Builder.php.

◆ RENDER_WIDGET

const RENDER_WIDGET = '$'

ID prefix indicating to render only the widget.

Definition at line 8 of file Builder.php.

◆ RENDER_WILD

const RENDER_WILD = '*'

Render all (between previous and next id).

Definition at line 10 of file Builder.php.


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