PHP Class Bootstrap\View\Helper\BootstrapPanelHelper

Inheritance: extends Cake\View\Helper, use trait BootstrapTrait
Datei anzeigen Open project: holt59/cakephp3-bootstrap3-helpers

Public Properties

Property Type Description
$_defaultConfig
$current
$helpers

Protected Properties

Property Type Description
$_autoCloseOnCreate
$_bodyId
$_collapsible
$_groupCount * Protected attribute used to generate group ID.
$_groupId
$_groupInGroup * Attribute set to true when in group.
$_groupPanelCount
$_groupPanelOpen
$_headId
$_lastPanelClosed
$_panelCount * Protected attributes used to generate ID for collapsible panels.

Public Methods

Method Description
body ( array | string $info = null, array $options = [] ) Create / Start the body. If $info is not null, it is used as the body content, otherwize start the body div.
create ( array | string $title = null, array $options = [] ) Create a Twitter Bootstrap like panel.
end ( $title = null, array $options = [] ) End a panel. If $title is not null, the PanelHelper::footer functions is called with $title and $options arguments.
endGroup ( )
footer ( string $text = null, array $options = [] ) Create / Start the footer. If $buttons is specified as an associative arrays or as null, start the footer, otherwize create the footer with the specified text.
header ( array | string $info = null, array $options = [] ) Create / Start the header. If $info is specified as a string, create and return the whole header, otherwize only open the header.
startGroup ( $options = [] )

Protected Methods

Method Description
_cleanCurrent ( )
_createBody ( $text = null, $options = [] )
_createFooter ( $text = null, $options = [] )
_createHeader ( $title, $options = [], $titleOptions = [] )
_isAssociativeArray ( $array )
_isOpen ( ) : true Return true if the current panel should be open (only for collapsible).

Method Details

_cleanCurrent() protected method

protected _cleanCurrent ( )

_createBody() protected method

protected _createBody ( $text = null, $options = [] )

_createFooter() protected method

protected _createFooter ( $text = null, $options = [] )

_createHeader() protected method

protected _createHeader ( $title, $options = [], $titleOptions = [] )

_isAssociativeArray() protected method

protected _isAssociativeArray ( $array )

_isOpen() protected method

Return true if the current panel should be open (only for collapsible).
protected _isOpen ( ) : true
return true if the current panel should be open, false otherwize.

body() public method

Create / Start the body. If $info is not null, it is used as the body content, otherwize start the body div.
public body ( array | string $info = null, array $options = [] )
$info array | string If string, use as the body content, otherwize works as $options.
$options array Options for the footer div.

create() public method

Create a Twitter Bootstrap like panel.
public create ( array | string $title = null, array $options = [] )
$title array | string If array, works as $options, otherwize used as the panel title.
$options array Options for the main div of the panel. Extra options (useless if $title not specified) : - no-body: Do not open the body after the create (default false)

end() public method

End a panel. If $title is not null, the PanelHelper::footer functions is called with $title and $options arguments.
public end ( $title = null, array $options = [] )
$options array

endGroup() public method

public endGroup ( )

header() public method

Create / Start the header. If $info is specified as a string, create and return the whole header, otherwize only open the header.
public header ( array | string $info = null, array $options = [] )
$info array | string If string, use as the panel title, otherwize works as $options.
$options array Options for the header div. Special option (if $info is string): - close: Add the 'close' button in the header (default true).

startGroup() public method

public startGroup ( $options = [] )

Property Details

$_autoCloseOnCreate protected_oe property

protected $_autoCloseOnCreate

$_bodyId protected_oe property

protected $_bodyId

$_collapsible protected_oe property

protected $_collapsible

$_defaultConfig public_oe property

public $_defaultConfig

$_groupCount protected_oe property

* Protected attribute used to generate group ID.
protected $_groupCount

$_groupId protected_oe property

protected $_groupId

$_groupInGroup protected_oe property

* Attribute set to true when in group.
protected $_groupInGroup

$_groupPanelCount protected_oe property

protected $_groupPanelCount

$_groupPanelOpen protected_oe property

protected $_groupPanelOpen

$_headId protected_oe property

protected $_headId

$_lastPanelClosed protected_oe property

protected $_lastPanelClosed

$_panelCount protected_oe property

* Protected attributes used to generate ID for collapsible panels.
protected $_panelCount

$current public_oe property

public $current

$helpers public_oe property

public $helpers