PHP Class Contao\Module

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

Protected Properties

Свойство Type Description
$arrData array Current record
$arrStyle array Style array
$objModel ModuleModel Model
$strColumn string Column
$strTemplate string Template

Méthodes publiques

Méthode 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

Méthodes protégées

Méthode 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 méthode

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

__get() public méthode

Return an object property
public __get ( string $strKey ) : mixed
$strKey string
Résultat mixed

__isset() public méthode

Check whether a property is set
public __isset ( string $strKey ) : boolean
$strKey string
Résultat boolean

__set() public méthode

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

compile() abstract protected méthode

Compile the current element
abstract protected compile ( )

findClass() public static méthode

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
Résultat string The class name

generate() public méthode

Parse the template
public generate ( ) : string
Résultat string

getModel() public méthode

Return the model
public getModel ( ) : Model
Résultat Model

renderNavigation() protected méthode

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
Résultat string

Property Details

$arrData protected_oe property

Current record
protected array $arrData
Résultat array

$arrStyle protected_oe property

Style array
protected array $arrStyle
Résultat array

$objModel protected_oe property

Model
protected ModuleModel,contao $objModel
Résultat ModuleModel

$strColumn protected_oe property

Column
protected string $strColumn
Résultat string

$strTemplate protected_oe property

Template
protected string $strTemplate
Résultat string