\org_openpsa_httplib_helpers

Helpers for HTTP content fetching and handling

Note, that the request data, for ease of use, already contains the L10n Databases of the Component and MidCOM itself located in this class. They are stored as 'l10n' and 'l10n_midcom'. Also available as 'config' is the current component configuration.

Summary

Methods

Properties

Constants

__construct()
__get()
__isset()
set_active_leaf()
add_stylesheet()
get_workflow()
get_meta_value()
get_link_values()
get_anchor_values()

$_component
$_i18n
$_l10n
$_l10n_midcom
$_config

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

$_services

N/A

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

$_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

$_services

$_services : array

Array that holds the already instantiated services

Type

array

Methods

__construct()

__construct()

Initialize all member variables, remember to set $_component before calling this constructor from your derived classes.

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

get_meta_value(string  $html, string  $name) : string

Get value of a meta tag in HTML page.

Parameters

string	$html	HTML to parse
string	$name	Name of the meta tag to fetch

Returns

string —

Content of the meta tag

get_link_values()

get_link_values(string  $html, string  $relation, string  $type = null) : array

Get value(s) of a link tag(s) in HTML page.

Parameters

string	$html	HTML to parse
string	$relation	Relation (rel) or reverse relation (rev) of the link tag to fetch
string	$type	Type (type) of the link tag to fetch (defaults to null, meaning all types of the link relation)

Returns

array —

Links matching given criteria as arrays containing keys title, href and optionally hreflang

get_anchor_values()

get_anchor_values(string  $html, string  $relation) : array

Get value(s) of an anchor tag(s) in HTML page.

Parameters

string	$html	HTML to parse
string	$relation	Relation (rel) of the anchor to fetch

Returns

array —

Links matching given criteria as arrays containing keys title, href and value