\Fluent_Page

Fluent_Page can be used on its own or supplied to the Fluent_Options class as a dependancy for page rendering

Summary

Methods
Properties
Constants
__construct()
_register_page()
_page_html()
_enqueue()
_load_page()
$version
$page
$domain
$url
$args
No constants found
parse_args()
provide()
random_string()
guid()
No protected properties found
N/A
default_args()
No private properties found
N/A

Properties

$version

$version : string

Type

string — Class version.

$page

$page : string

Type

string — will be set as the unique page id when using add_**_page functions.

$domain

$domain : string

Type

string — Class text domain.

$url

$url : string

Type

string — fluent url.

$args

$args : array

Type

array — Class args to be run attached after <code>parse_args</code>.

Methods

__construct()

__construct(array $args) : \none

__construct() parse arguments supplied, fire page creation action, and add callback to the render action if supplied.

Parameters

array $args

class setup arguments. Used to change some base settings for the class.

Returns

\none

_register_page()

_register_page() : \none

Registers the page in the WordPress Admin. Attach methods to the load and enqueue actions for registered page.

Returns

\none

_page_html()

_page_html()

Allows the use of actions to render the page html based on the <code>$args['slug']</code> suppplied on creation.

_enqueue()

_enqueue()

Allows the use of actions to enqueue on the page based on the <code>$args['slug']</code> suppplied on creation.

_load_page()

_load_page()

Allows the use of actions on the page load action based on the <code>$args['slug']</code> suppplied on creation.

parse_args()

parse_args(array $a, array $b, string $filter) : array

Recursive array merging from a default and supplied array.

Very similar function to wp_parse_args except it filters through the whole array tree.

Parameters

array $a

supplied value array.

array $b

default value array.

string $filter

optionally run the array through apply_filters before returning.

Returns

array

provide()

provide(string $key) : array

The provide function is just a shorthand wrapper for suppling a class object and method as array in WordPress actions and filters.

Parameters

string $key

the method name to be added to the array: array( &$this, $key ).

Returns

array

random_string()

random_string(string $length) : string

Helper function used inside the <code>guid()</code> function to generate random strings.

Parameters

string $length

the number of characters to return.

Returns

string

guid()

guid() : string

Guid function used to reformat array index values before sedning them to the fields.

Simply replicates the behaviour found in framework javascript.

Returns

string

default_args()

default_args() : array

Function used across extended classes used in conjunction with <code>parse_args</code> to format supplied arrays and ensure all keys are supplied.

Returns

array