PHP 클래스 WPDKUIModalDialog

## Overview You can create in a simple way a standard dialog. ### Create a simple modal dialog For do this just instance this class like: $modal = new WPDKUIModalDialog( 'myDialog', 'Dialog title', 'The content' ); $modal->addButton( 'close', 'Close dialog' ); $modal->modal(); That's all, or since 1.4.9 you can extends this class class MyDialog extends WPDKUIModalDialog { Internal construct public function __construct() { parent::__construct( $id, $title ); } Override buttons public function buttons() { $buttons = array( 'button_id' = array( 'label' => __( 'No, Thanks' ), 'dismiss' => true, ); ); return $buttons; // Filtrable? } Override content public function content() { echo 'Hello...'; } }
부터: 1.4.21
저자: =undo= ([email protected])
상속: extends WPDKHTMLTag
파일 보기 프로젝트 열기: wpxtreme/wpdk 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$__version string Override version
$backdrop boolean Includes a modal-backdrop element. Alternatively, specify static for a backdrop which doesn't close the modal on click.
$buttons array List of buttons to display in footer
$close_button boolean True for dismiss button [x] on top right
$content string HTML content
$dismissButton boolean True for dismiss button [x] on top right
$dismiss_button_glyph string Glyph used like dismiss button
$height integer Height
$keyboard boolean Closes the modal when escape key is pressed
$permanent_dismiss boolean If TRUE this modal is permanet dismiss by a logged in user
$static boolean Render as static. Default is FALSE
$title string Title of modal (window)
$width integer Width

보호된 프로퍼티들

프로퍼티 타입 설명
$dismissed array List of permanent dismissed dialog id

공개 메소드들

메소드 설명
__construct ( string $id, string $title, string $content = '' ) : WPDKUIModalDialog Create an instance of WPDKUIModalDialog class
addButton ( string $id, string $label, boolean $dismiss = true, string $class = '', string $href = '' ) Add a footer button
add_buttons ( $id, $label, $dismiss = true, $class = '' )
add_data ( $key, $value )
buttonOpenModal ( string $label, string $class = '' ) : string Return the HTML markup for button tag to open this modal dialog
button_open_modal ( $label, $class = '' )
buttons ( ) : array Return a list of button
content ( ) : string Content
footer ( ) : string Content of the footer of dialog. You can override this method.
hide ( ) Hide immediately
html ( ) : string Return the HTML markup for modal dialog
is_dismissed ( ) : boolean Return TRUE if this modal dialog is dismissed. FALSE otherwise.
modal ( $echo = true )
open ( ) Display and open dialog
print_footer_scripts ( ) Prints any scripts and data queued for the footer.
show ( ) Display immediately
toggle ( ) Toggle modal

비공개 메소드들

메소드 설명
_buttons ( ) : string Return the HTML markup for footer buttons
_footer ( ) : string Return the footer content.
aria_title ( ) : string Return the HTML aria title format
dismissButton ( ) : string Return the HTML markup for top right dismiss button [x]
height ( ) : string Return the computate style for height to use in main content div of dialog.
width ( ) : string Return the computate style for width to use in main div of dialog.

메소드 상세

__construct() 공개 메소드

Create an instance of WPDKUIModalDialog class
public __construct ( string $id, string $title, string $content = '' ) : WPDKUIModalDialog
$id string ID for this modal
$title string The modal title
$content string Optional. An HTML content for dialog
리턴 WPDKUIModalDialog

addButton() 공개 메소드

Add a footer button
public addButton ( string $id, string $label, boolean $dismiss = true, string $class = '', string $href = '' )
$id string Unique id for button
$label string Text label
$dismiss boolean Optional. True for data-dismiss
$class string Optional. Addition CSS class
$href string Optional. If set use a TAG A instead BUTTON.

add_buttons() 공개 메소드

사용 중단: Sice 1.0.0.b4 - Use addButton() instead
public add_buttons ( $id, $label, $dismiss = true, $class = '' )

add_data() 공개 메소드

사용 중단: Sice 1.0.0.b4 - Use addData() instead
public add_data ( $key, $value )

buttonOpenModal() 공개 메소드

Return the HTML markup for button tag to open this modal dialog
public buttonOpenModal ( string $label, string $class = '' ) : string
$label string Text button label
$class string Optional. Additional class
리턴 string

button_open_modal() 공개 메소드

사용 중단: Since 1.0.0.b4 - Use buttonOpenModal() instead
public button_open_modal ( $label, $class = '' )

buttons() 공개 메소드

Return a list of button
public buttons ( ) : array
리턴 array

content() 공개 메소드

Content
public content ( ) : string
리턴 string

hide() 공개 메소드

Hide immediately
public hide ( )

html() 공개 메소드

Return the HTML markup for modal dialog
public html ( ) : string
리턴 string

is_dismissed() 공개 메소드

Return TRUE if this modal dialog is dismissed. FALSE otherwise.
public is_dismissed ( ) : boolean
리턴 boolean

modal() 공개 메소드

사용 중단: Use display() or html() instead
public modal ( $echo = true )

open() 공개 메소드

Display and open dialog
부터: 1.4.9
public open ( )

show() 공개 메소드

Display immediately
public show ( )

toggle() 공개 메소드

Toggle modal
public toggle ( )

프로퍼티 상세

$__version 공개적으로 프로퍼티

Override version
public string $__version
리턴 string

$backdrop 공개적으로 프로퍼티

Includes a modal-backdrop element. Alternatively, specify static for a backdrop which doesn't close the modal on click.
public bool $backdrop
리턴 boolean

$buttons 공개적으로 프로퍼티

List of buttons to display in footer
public array $buttons
리턴 array

$close_button 공개적으로 프로퍼티

True for dismiss button [x] on top right
사용 중단: Since 1.0.0.b4 - Use dismissButton instead
public bool $close_button
리턴 boolean

$content 공개적으로 프로퍼티

HTML content
public string $content
리턴 string

$dismissButton 공개적으로 프로퍼티

True for dismiss button [x] on top right
public bool $dismissButton
리턴 boolean

$dismiss_button_glyph 공개적으로 프로퍼티

Glyph used like dismiss button
부터: 1.4.22
public string $dismiss_button_glyph
리턴 string

$dismissed 보호되어 있는 프로퍼티

List of permanent dismissed dialog id
protected array $dismissed
리턴 array

$height 공개적으로 프로퍼티

Height
public int $height
리턴 integer

$keyboard 공개적으로 프로퍼티

Closes the modal when escape key is pressed
public bool $keyboard
리턴 boolean

$permanent_dismiss 공개적으로 프로퍼티

If TRUE this modal is permanet dismiss by a logged in user
부터: 1.5.6
public bool $permanent_dismiss
리턴 boolean

$static 공개적으로 프로퍼티

Render as static. Default is FALSE
public bool $static
리턴 boolean

$title 공개적으로 프로퍼티

Title of modal (window)
public string $title
리턴 string

$width 공개적으로 프로퍼티

Width
public int $width
리턴 integer