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

$pager_strategy

$pager_strategy

$page_url

$page_url

$page_url_marker

$page_url_marker

$page_method

$page_method

$items_total

$items_total

$items_per_page

$items_per_page

$active_page

$active_page

Methods

__construct()

__construct(object $params_object)

Parameters

object $params_object
  • standard object filled with vars

render()

render() : void

outputs a list of list links, to reflect paging

getStylesheets()

getStylesheets()

getScriptfiles()

getScriptfiles()

__call()

__call( $key,  $args)

Parameters

$key
$args

__get()

__get( $var)

Parameters

$var

__set()

__set( $key,  $value)

Parameters

$key
$value

refresh_get()

refresh_get( $key)

Parameters

$key

__toString()

__toString()

getHtml()

getHtml() : string

returns rather than renders the pager

Returns

string

needsPagination()

needsPagination() : bool

a check of whether number of items exceeds items per page

Returns

bool

outputLink()

outputLink(int $page, string $text, string $title) : string

returns a link based on page number, supplied text and title

Parameters

int $page
string $text
string $title

Returns

string

getActivePageMarker()

getActivePageMarker() : string

returns a string formatted for the active page i.e. for GET: $page_url_marker=$active_page you can then stick this in links or urls as needed

Returns

string

getActiveSubset()

getActiveSubset(array $set) : array

returns the subset of an array that represents the currently active page of the pager in case of arrays that are too small, it returns the start of the array

Parameters

array $set
  • array of items to page

Returns

array

getActiveStart()

getActiveStart() : int

returns the first item number (zero-based)

Returns

int

getActiveLength()

getActiveLength() : int

returns the length of the active subset

Returns

int

getTotalCount()

getTotalCount() : int

returns number of items to page

Returns

int

getOffset()

getOffset() : int

returns the offset of the first item in the active subset

Returns

int

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()

makes sure that all needed vars are initialised also makes sure that all vars are passed to the strategy

numberOfPages()

numberOfPages() : int

returns total number of pages the pager will show

Returns

int

cleanPageUrl()

cleanPageUrl()

removes previous page marker if present updates $this->page_url

checkRequestForPageNumber()

checkRequestForPageNumber(object $req) : int|bool

checks the request uri, post and get vars for page url marker, depending upon the settings for $page_method

Parameters

object $req
  • request and arguments object

Returns

int|bool