PHP Class Contao\Module

Parent class for front end modules.
Inheritance: extends Frontend
Mostrar archivo Open project: contao/core-bundle Class Usage Examples

Protected Properties

Property Type Description
$arrData array Current record
$arrStyle array Style array
$objModel ModuleModel Model
$strColumn string Column
$strTemplate string Template

Public Methods

Method Description
__construct ( ModuleModel $objModule, string $strColumn = 'main' ) Initialize the object
__get ( string $strKey ) : mixed Return an object property
__isset ( string $strKey ) : boolean Check whether a property is set
__set ( string $strKey, mixed $varValue ) Set an object property
findClass ( string $strName ) : string Find a front end module in the FE_MOD array and return the class name
generate ( ) : string Parse the template
getModel ( ) : Model Return the model

Protected Methods

Method Description
compile ( ) Compile the current element
renderNavigation ( integer $pid, integer $level = 1, string $host = null, string $language = null ) : string Recursively compile the navigation menu and return it as HTML string

Method Details

__construct() public method

Initialize the object
public __construct ( ModuleModel $objModule, string $strColumn = 'main' )
$objModule ModuleModel
$strColumn string

__get() public method

Return an object property
public __get ( string $strKey ) : mixed
$strKey string
return mixed

__isset() public method

Check whether a property is set
public __isset ( string $strKey ) : boolean
$strKey string
return boolean

__set() public method

Set an object property
public __set ( string $strKey, mixed $varValue )
$strKey string
$varValue mixed

compile() abstract protected method

Compile the current element
abstract protected compile ( )

findClass() public static method

Find a front end module in the FE_MOD array and return the class name
public static findClass ( string $strName ) : string
$strName string The front end module name
return string The class name

generate() public method

Parse the template
public generate ( ) : string
return string

getModel() public method

Return the model
public getModel ( ) : Model
return Model

renderNavigation() protected method

Recursively compile the navigation menu and return it as HTML string
protected renderNavigation ( integer $pid, integer $level = 1, string $host = null, string $language = null ) : string
$pid integer
$level integer
$host string
$language string
return string

Property Details

$arrData protected_oe property

Current record
protected array $arrData
return array

$arrStyle protected_oe property

Style array
protected array $arrStyle
return array

$objModel protected_oe property

Model
protected ModuleModel,contao $objModel
return ModuleModel

$strColumn protected_oe property

Column
protected string $strColumn
return string

$strTemplate protected_oe property

Template
protected string $strTemplate
return string