PHP Class WPDKPointer

Author: =undo= ([email protected])

Public Properties

Property	Type	Description
$align	string	The box model alignment of pointer, default is top
$buttonClose	array	This is the dismiss/close button. For default this button perform an Ajax call and write in option that this pointer is no longer to display.
$buttonPrimary	array	This is a custom primary button shows on the left of dismiss button
$content	string	The HTML markup of pointer content. This can be a simple string without markup. In this case a p tag is added.
$edge	string	The pointer edge arrow, default is left
$id	string	Pointer ID
$nextPage	string	This is the next page slug for automatic tour
$selector	string	A jQuery selector HTML tag.
$title	string	The pointer title

Method	Description
__construct ( string $id, string $selector, string $title, string $content, string $edge = 'left', string $align = 'top' ) : WPDKPointer	Create an instance of WPDKPointer class
display ( )	Print the javascript for WP Pointer

Method	Description
_buttonClose ( ) : string	Return the HTML markup for close button
_buttonPrimary ( ) : string	Return the HTML markup for secondary button
_content ( ) : string	Return the right HTML markup for the pointer content. If the content has not a markup then a tag p is added.
_title ( ) : string	Return the right HTML markup for the pointer title. If the title has not a markup then a tag h3 is added.

Create an instance of WPDKPointer class

public __construct ( string $id, string $selector, string $title, string $content, string $edge = 'left', string $align = 'top' ) : WPDKPointer
$id	string	Uniq id for this Pointer
$selector	string	jQuery selector
$title	string	Title
$content	string	HTML markup content
$edge	string	Edge, default `left`
$align	string	Alignment, default `top`
return	WPDKPointer

Print the javascript for WP Pointer

public display ( )

The box model alignment of pointer, default is top

public string $align
return	string

This is the dismiss/close button. For default this button perform an Ajax call and write in option that this pointer is no longer to display.

public array $buttonClose
return	array

This is a custom primary button shows on the left of dismiss button

public array $buttonPrimary
return	array

The HTML markup of pointer content. This can be a simple string without markup. In this case a p tag is added.

public string $content
return	string

The pointer edge arrow, default is left

public string $edge
return	string

Pointer ID

public string $id
return	string

This is the next page slug for automatic tour

public string $nextPage
return	string

A jQuery selector HTML tag.

public string $selector
return	string

The pointer title

public string $title
return	string