PHP Класс WPDKUIAlert

### Create an Alert To create and display an alert just coding: $alert = new WPDKUIAlert( 'my-alert', 'Hello World!' ); $alert->display(); OR class myAlert extends WPDKUIAlert { Internal construct public function __construct() { parent::__construct( $id, false, $type, $title ); } Override content public function content() { echo 'Hello...'; } }
С версии: 1.4.21
Автор: =undo= ([email protected])
Наследование: extends WPDKHTMLTag
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$block boolean Set TRUE for alert-block class style
$content string The HTML content of alert.
$dismissButton boolean Set TRUE to display dismiss [x] button. Default TRUE.
$dismissButtonGlyph string Used to get/set the glyph icon used like dismiss button.
$dismissPermanent boolean If TRUE this alert is permanent dismiss by a logged in user
$dismissToolTip string This is the tooltip (for more detail) display on dismiss button.
$dismiss_button_glyph string Glyph used like dismiss button
$dismissable boolean Add alert-dismissable class in HTML markup.
$permanent_dismiss boolean If TRUE this alert is permanet dismiss by a logged in user
$title string Title of the alter.
$type string The alert type change the left border color. Use the constants in WPDKUIAlertType class.
$wpautop boolean If TRUE the WordPress wpautop() on content.

Защищенные свойства (Protected)

Свойство Тип Описание
$dismissed array Internal use only.

Открытые методы

Метод Описание
__construct ( string $id = false, string $content = '', string $type = WPDKUIAlertType::INFORMATION, string $title = '' ) : WPDKUIAlert Create an instance of WPDKUIAlert class.
alert ( $echo = true )
content ( ) : string Content
html ( ) : string Return the HTML markup for alert
title ( ) : string Title
toControl ( ) : array Return an array item description in Control Layout Array format

Приватные методы

Метод Описание
_content ( ) : string Return a formatted content
_dismissButton ( ) : string Return the HTML markup button for dismiss
_title ( ) : string Return the title
alert_block ( ) : string Return alert-block class style

Описание методов

__construct() публичный Метод

Create an instance of WPDKUIAlert class.
public __construct ( string $id = false, string $content = '', string $type = WPDKUIAlertType::INFORMATION, string $title = '' ) : WPDKUIAlert
$id string Optional. This alert id. If FALSE a unique id is create in order to avoid potential alert display missing.
$content string Optional. An HTML content for this alert
$type string Optional. See WPDKUIAlertType. Default WPDKUIAlertType::INFORMATION
$title string Optional. Title of alert
Результат WPDKUIAlert

alert() публичный Метод

Устаревший: Use display() or html() instead
public alert ( $echo = true )

content() публичный Метод

Content
public content ( ) : string
Результат string

html() публичный Метод

Return the HTML markup for alert
public html ( ) : string
Результат string

title() публичный Метод

Title
public title ( ) : string
Результат string

toControl() публичный Метод

Return an array item description in Control Layout Array format
С версии: 1.0.0
public toControl ( ) : array
Результат array

Описание свойств

$block публичное свойство

Set TRUE for alert-block class style
Устаревший: Since WPDK 1.3.1 and Bootstrap 3.0.0
public bool $block
Результат boolean

$content публичное свойство

The HTML content of alert.
public string $content
Результат string

$dismissButton публичное свойство

Set TRUE to display dismiss [x] button. Default TRUE.
public bool $dismissButton
Результат boolean

$dismissButtonGlyph публичное свойство

Used to get/set the glyph icon used like dismiss button.
С версии: 1.5.6
public string $dismissButtonGlyph
Результат string

$dismissPermanent публичное свойство

If TRUE this alert is permanent dismiss by a logged in user
С версии: 1.5.6
public bool $dismissPermanent
Результат boolean

$dismissToolTip публичное свойство

This is the tooltip (for more detail) display on dismiss button.
С версии: 1.4.8
public string $dismissToolTip
Результат string

$dismiss_button_glyph публичное свойство

Glyph used like dismiss button
Устаревший: since 1.5.6 Use $dismissButtonGlyph instead
public string $dismiss_button_glyph
Результат string

$dismissable публичное свойство

Add alert-dismissable class in HTML markup.
С версии: 1.3.1
public bool $dismissable
Результат boolean

$dismissed защищенное свойство

Internal use only.
protected array $dismissed
Результат array

$permanent_dismiss публичное свойство

If TRUE this alert is permanet dismiss by a logged in user
Устаревший: 1.5.6 Use $dismissPermanent
С версии: 1.4.21
public bool $permanent_dismiss
Результат boolean

$title публичное свойство

Title of the alter.
public string $title
Результат string

$type публичное свойство

The alert type change the left border color. Use the constants in WPDKUIAlertType class.
public string $type
Результат string

$wpautop публичное свойство

If TRUE the WordPress wpautop() on content.
С версии: 1.6.1
public bool $wpautop
Результат boolean