Components/ComponentHelpers.php « Appzio Documentation

NAMESPACE: Bootstrap/Components

Components/ComponentHelpers.php

uses

public properties

$model	namespace	The model instance. Models are responsible for querying and storing data. They also provide variable, session and validation functionality as well as other useful utility methods.
$actionid	var	Users own action (playaction)
$action_id		Action id for the config object (action itself)

public function configureDefaults($obj)

variable

$obj

public function addParam($name,$params,$default)

variable

$name

$params

$default

public function getImageFileName($image,$params)

Returns the image file name. This method is used in places in which we cannot write the image name. Example usecase is setting the background image of a component

parameters

$params

param array $params isvar, width, height, crop, defaultimage, debug

variable

$image

$params

public function getParsedContent($content,$styles)

variable

$content

$styles

public function getRichTextLayout($tag,$element,$input,$args)

variable

$tag

$element

$input

$args

public function getNodeParams($node)

variable

$node

public function getNodeStyles($node)

variable

$node

public function extractTags($html,$tag,$selfclosing,$return_the_entire_tag,$charset)

extractTags() Extract specific HTML tags and their attributes from a string.

You can either specify one tag, an array of tag names, or a regular expression that matches the tag name(s). If multiple tags are specified you must also set the $selfclosing parameter and it must be the same for all specified tags (so you can’t extract both normal and self-closing tags in one go).

The function returns a numerically indexed array of extracted tags. Each entry is an associative array with these keys : tag_name – the name of the extracted tag, e.g. “a” or “img”. offset – the numberic offset of the first character of the tag within the HTML source. contents – the inner HTML of the tag. This is always empty for self-closing tags. attributes – a name -> value array of the tag’s attributes, or an empty array if the tag has none. full_tag – the entire matched tag, e.g. ‘example.com‘. This key will only be present if you set $return_the_entire_tag to true.

parameters

$html	param string $html The HTML code to search for tags.
$tag	param string\|array $tag The tag(s) to extract.
$selfclosing	param bool $selfclosing Whether the tag is self-closing or not. Setting it to null will force the script to try and make an educated guess.
$return_the_entire_tag	param bool $return_the_entire_tag Return the entire matched tag in 'full_tag' key of the results array.
$charset	param string $charset The character set of the HTML code. Defaults to ISO-8859-1.

variable

$html

$tag

$selfclosing

$return_the_entire_tag

$charset

public function getComponentsMap()

public function getNestedContentOutput($content)

variable

$content

public function getEntryParams($entry)

variable

$entry