Properties

$_component

$_component : string

The name of the component, e.g. net.nehmer.static. Should be used whenever the component's name is required instead of hardcoding it.

Type

string

$results_per_page

$results_per_page : 

Type

$display_pages

$display_pages : 

Type

$string_next

$string_next : 

Type

$string_previous

$string_previous : 

Type

$_i18n

$_i18n : \midcom_services_i18n

A handle to the i18n service.

Type

\midcom_services_i18n

$_l10n

$_l10n : \midcom_services_i18n_l10n

The components' L10n string database.

Type

\midcom_services_i18n_l10n

$_l10n_midcom

$_l10n_midcom : \midcom_services_i18n_l10n

The global MidCOM string database.

Type

\midcom_services_i18n_l10n

$_config

$_config : \midcom_helper_configuration

The current configuration.

Type

\midcom_helper_configuration

$_midcom_qb

$_midcom_qb : 

Type

$_midcom_qb_count

$_midcom_qb_count : 

Type

$_pager_id

$_pager_id : 

Type

$_prefix

$_prefix : 

Type

$_services

$_services : array

Array that holds the already instantiated services

Type

array

$_offset

$_offset : 

Type

$count

$count : 

Type

$_count_mode

$_count_mode : 

Type

$_current_page

$_current_page : 

Type

Methods

__construct()

__construct(  $classname,   $pager_id) 

Parameters

$classname
$pager_id

__get()

__get(  $field) 

Parameters

$field

__isset()

__isset(  $field) 

Parameters

$field

set_active_leaf()

set_active_leaf(  $leaf_id) 

Parameters

$leaf_id

add_stylesheet()

add_stylesheet(string  $url, string  $media = false) 

Convenience shortcut for adding CSS files

Parameters

string $url

The stylesheet URL

string $media

The media type(s) for the stylesheet, if any

get_workflow()

get_workflow(string  $identifier, array  $options = array()) : \midcom\workflow\dialog

Parameters

string $identifier
array $options

Returns

\midcom\workflow\dialog

get_current_page()

get_current_page() 

Get the current page number

show_previousnext()

show_previousnext(  $acl_checks = false) 

Displays previous/next selector

Parameters

$acl_checks

get_pages()

get_pages(  $acl_checks = false) 

Parameters

$acl_checks

show_pages()

show_pages(  $acl_checks = false) 

Displays page selector

Parameters

$acl_checks

show_pages_as_list()

show_pages_as_list(  $acl_checks = false) 

Displays page selector as list

Parameters

$acl_checks

execute()

execute() 

execute_unchecked()

execute_unchecked() 

count_pages()

count_pages(  $acl_checks = false) 

Returns number of total pages for query

By default returns a number of pages without any ACL checks, checked count is available but is much slower.

Parameters

$acl_checks

add_constraint()

add_constraint(  $param,   $op,   $val) 

Parameters

$param
$op
$val

add_order()

add_order(  $param,   $sort = 'ASC') 

Parameters

$param
$sort

begin_group()

begin_group(  $type) 

Parameters

$type

end_group()

end_group() 

include_deleted()

include_deleted() 

count()

count() 

count_unchecked()

count_unchecked() 

_prepare_qbs()

_prepare_qbs(  $classname) 

Parameters

$classname

_sanity_check()

_sanity_check() 

Makes sure we have some absolutely required things properly set

_qb_limits()

_qb_limits(  $qb) 

sets LIMIT and OFFSET for requested page

Parameters

$qb

_check_page_vars()

_check_page_vars() 

Check $_REQUEST for variables and sets internal status accordingly

_get_query_string()

_get_query_string(  $page_var,   $page_number) 

Fetch all $_GET variables

Parameters

$page_var
$page_number

show()

show(  $name,   $data) 

Parameters

$name
$data