Properties

$_entity_factory

$_entity_factory : object

Holds an object of the entity factory, used for instantiating entities (obviously) Loaded by __construct() - so all descendants of RoxModelBase has access to it

Type

object — RoxEntityFactory

$_parameters

$_parameters

$_cache

$_cache

$_prepared

$_prepared

$_items_cached

$_items_cached

Methods

render()

render()

please implement! render() method does the output.

__call()

__call( $key,  $args)

Parameters

$key
$args

__construct()

__construct()

getStylesheets()

getStylesheets()

getScriptfiles()

getScriptfiles()

__get()

__get( $key)

Parameters

$key

__set()

__set( $key,  $value)

Parameters

$key
$value

refresh_get()

refresh_get( $key)

Parameters

$key

__toString()

__toString()

needsPagination()

needsPagination()

showPagination()

showPagination()

showItems()

showItems()

showItems_table()

showItems_table()

showItems_float()

showItems_float()

showItems_list()

showItems_list()

showBetweenListItems()

showBetweenListItems( $prev_item,  $item,  $i_row)

Parameters

$prev_item
$item
$i_row

showListItem()

showListItem(\unknown_type $item,  $i_row)

Override this method to get a different presentation

Parameters

\unknown_type $item
  • the item for this row of the list
$i_row

getItems()

getItems()

hideColumnTitles()

hideColumnTitles()

createEntity()

createEntity() : object

calls the entity factory to create an entity, passes along any arguments

Returns

object

set_layoutkit()

set_layoutkit(\unknown_type $layoutkit)

called by the framework, to inject some essential values.

.

Parameters

\unknown_type $layoutkit

getTemplatePrefix()

getTemplatePrefix( $classname)

Parameters

$classname

getAppname()

getAppname( $classname)

Parameters

$classname

get()

get( $key)

Parameters

$key

getValues()

getValues()

getWords()

getWords() : object

returns an instance of the MOD_words class

Returns

object

logWrite()

logWrite(string $string, string $type)

wrapper for calls to MOD_log::get->write()

Parameters

string $string
string $type

getLog()

getLog() : object

wrapper function for MOD_log::get()

Returns

object

getVersionInfo()

getVersionInfo() : string

returns the revision number saved in revision.txt

Returns

string

prepare()

prepare()

numberOfPages()

numberOfPages()

getItemsForPage()

getItemsForPage( $k_page)

Parameters

$k_page

itemsTotalBegin()

itemsTotalBegin()

showPageLink()

showPageLink( $i_page)

Parameters

$i_page

showActivePageLink()

showActivePageLink( $i_page)

Parameters

$i_page

getItemsInRange()

getItemsInRange(int $begin,  $count) : array

Get all items with $begin <= $index < $end.

Parameters

int $begin
$count

Returns

array —

items in range

itemsTotalCount()

itemsTotalCount() : int

Returns

int —

number of items on all pages together

getAllItems_cached()

getAllItems_cached()