PHP Class Redaxscript\Breadcrumb

Since: 2.1.0
Author: Henry Ruhs
Author: Gary Aylward
Exibir arquivo Open project: redaxmedia/redaxscript Class Usage Examples

Protected Properties

Property Type Description
$_breadcrumbArray array array of the breadcrumb
$_language object instance of the language class
$_optionArray array options of the breadcrumb
$_registry object instance of the registry class

Public Methods

Method Description
__construct ( Registry $registry, Language $language ) constructor of the class
__toString ( ) : string stringify the breadcrumb
getArray ( ) : array get the breadcrumb array
init ( array $optionArray = [] ) init the class
render ( ) : string render the breadcrumb trail as an unordered list

Protected Methods

Method Description
_create ( integer $key ) create the breadcrumb array
_createAdmin ( integer $key ) create the breadcrumb array for current administration
_createContent ( integer $key ) create the breadcrumb array for current content

Method Details

__construct() public method

constructor of the class
Since: 2.4.0
public __construct ( Registry $registry, Language $language )
$registry Registry instance of the registry class
$language Language instance of the language class

__toString() public method

stringify the breadcrumb
Since: 3.0.0
public __toString ( ) : string
return string

_create() protected method

create the breadcrumb array
Since: 2.1.0
protected _create ( integer $key )
$key integer key of the item

_createAdmin() protected method

create the breadcrumb array for current administration
Since: 2.1.0
protected _createAdmin ( integer $key )
$key integer key of the item

_createContent() protected method

create the breadcrumb array for current content
Since: 2.1.0
protected _createContent ( integer $key )
$key integer

getArray() public method

get the breadcrumb array
Since: 2.1.0
public getArray ( ) : array
return array

init() public method

init the class
Since: 2.6.0
public init ( array $optionArray = [] )
$optionArray array options of the breadcrumb

render() public method

render the breadcrumb trail as an unordered list
Since: 2.1.0
public render ( ) : string
return string

Property Details

$_breadcrumbArray protected_oe property

array of the breadcrumb
protected array $_breadcrumbArray
return array

$_language protected_oe property

instance of the language class
protected object $_language
return object

$_optionArray protected_oe property

options of the breadcrumb
protected array $_optionArray
return array

$_registry protected_oe property

instance of the registry class
protected object $_registry
return object