WPDKUI Class Reference

Static Public Member Functions
static	buttonsUpdateReset ()
	Button Update and Reset. More...
static	submit ($args=array())
	Button submit. More...
static	button ($label= '', $args=array())
	Simple button. More...
static	badged ($count=0, $classes= '', $tooltip= '', $placement= '')
static	badge ($count=0, $classes= '', $tooltip= '', $placement= '')
	Badge. More...
static	view ($id, $title, $icon_class, $content)
static	inputNonce ($id)
	Input nonce. More...
static	labelTruncate ($value, $size= 'small')
	Enhancer string truncate. More...

Detailed Description

This class describe a WPDK UI Control. A WPDK UI Control is as a set of simple HTML tag. For example a WPDK UI Control of type input is compose by:

[control label][control input][extra]

In detail a WPDK ui control has the follow structure:

[before]
  [before_label]
    [label control]
  [after_label]
    [prepend]
     [main control][extra]
  [append]
[after]

However every control class has its drawing method to manage different output.

Overview

This class allow to make simple display button and common UI.

Author

=undo= info@.nosp@m.wpxt.nosp@m.re.me

Copyright

Copyright (C) 2012-2013 wpXtreme Inc. All Rights Reserved.

Date

2013-10-29

Version

1.0.0

UI Helper for general purpose

Overview

This class allow to make simple display button and common UI.

Author

=undo= info@.nosp@m.wpxt.nosp@m.re.me

Copyright

Copyright (C) 2012-2013 wpXtreme Inc. All Rights Reserved.

Date

2014-02-08

Version

1.0.0

Definition at line 16 of file wpdk-ui.php.

Member Function Documentation

static badge (   $count = 0,   $classes = '',   $tooltip = '',   $placement = ''  )

static

Badge.

Return the HTML markup for a simple badge.

Parameters

int	$count	Optional. Number to display in the badge
string	$classes	Optional. Additional class for this badge
string	$tooltip	Optional. Tooltip to display when mouse over
string	$placement	Optional. Tooltip placement, default bottom

Returns

string

Definition at line 171 of file wpdk-ui.php.

static badged (   $count = 0,   $classes = '',   $tooltip = '',   $placement = ''  )

static

Deprecated:

Since 1.0.0.b3 use badge() instead

Definition at line 153 of file wpdk-ui.php.

static button (   $label = '',   $args = array()  )

static

Simple button.

Return HTML markup for a input type

Parameters

string	$label	Optional. Button label. If empty default is 'Update'
array	$args	Optional. A keys value array for additional settings 'type' => 'submit', 'name' => 'button-update', 'classes' => ' button-primary', 'additional_classes' => '', 'data' => ''

Returns

string HTML input type submit

Definition at line 80 of file wpdk-ui.php.

static buttonsUpdateReset ( )

static

Button Update and Reset.

Return the HTML markup for standard [Update] and [Reset to default] button

Definition at line 27 of file wpdk-ui.php.

static inputNonce (   $id )

static

Input nonce.

Return the HTML markup for an input type hidden with a nonce value.

Since

1.0.0.b4

Parameters

string

$id

ID used for nonce code

Returns

string

Definition at line 237 of file wpdk-ui.php.

static labelTruncate (   $value,   $size = 'small'  )

static

Enhancer string truncate.

Return a new truncate well string. The result string is wrap into a special HTML markup.

Note

Prototype

Parameters

string	$value	String to truncate
string	$size	Number of character

Returns

string

Definition at line 258 of file wpdk-ui.php.

static submit (   $args = array() )

static

Button submit.

Utility that return the HTML markup for a submit button

Parameters

array

$args

Optional. Item description

Returns

string

Definition at line 46 of file wpdk-ui.php.

static view (   $id,   $title,   $icon_class,   $content  )

static

Return a standard HTML markup view for WordPress backend, with wrap, icon, title and main container

Parameters

string	$id	Class to add to main content container
string	$title	Head title
string	$icon_class	Icon class
string	$content	HTML content

Deprecated:

Use WPDKView and WPDKViewController

Returns

string

Definition at line 209 of file wpdk-ui.php.

---

The documentation for this class was generated from the following file:

• classes/ui/wpdk-ui.php