UIX Documentation
  • Namespace
  • Class
  • Tree

Namespaces

  • None
  • uix
    • data
    • ui
      • control

Classes

  • box
  • control
  • footer
  • grid
  • header
  • help
  • metabox
  • modal
  • notice
  • page
  • panel
  • post_type
  • repeat
  • section
  • uix

Class control

Base UIX Control class.

uix\ui\uix
Extended by uix\data\data
Extended by uix\ui\control

Direct known subclasses

uix\ui\control\email, uix\ui\control\file, uix\ui\control\textarea, uix\ui\control\toggle, uix\ui\control\hidden, uix\ui\control\number, uix\ui\control\post_relation, uix\ui\control\radio, uix\ui\control\select, uix\ui\control\separator, uix\ui\control\template, uix\ui\control\text

Indirect known subclasses

uix\ui\control\autocomplete, uix\ui\control\button, uix\ui\control\checkbox, uix\ui\control\color, uix\ui\control\editor, uix\ui\control\slider

Namespace: uix\ui
Since: 1.0.0
Located at classes/uix/ui/control.php

Methods summary

public static object|uix()
# register( string $slug, array $object, $parent = null )

Register the UIX objects

Register the UIX objects

Parameters

$slug
Object slug
$object
object structure array
$parent

Returns

object|uix()
object instance

Since

1.0.0

Overrides

uix\ui\uix::register
public
# setup( )

Sets the controls data

Sets the controls data

Since

1.0.0

See

\uix\uix

Overrides

uix\data\data::setup
public
# set_config( )

Handy method for setting data-* attributes using the setup parameter

Handy method for setting data-* attributes using the setup parameter

Since

1.0.0
public array
# set_attributes( )

Gets the attributes for the control.

Gets the attributes for the control.

Returns

array
Attributes for the input field

Since

1.0.0

Overrides

uix\ui\uix::set_attributes
public
# set_assets( )

Define core page styles

Define core page styles

Since

1.0.0

Overrides

uix\ui\uix::set_assets
public string
# name( )

Create and Return the control's input name

Create and Return the control's input name

Returns

string
The control name

Since

1.0.0
public mixed
# get_value( )

get this controls value

get this controls value

Returns

mixed
the controls value

Since

1.0.0
public array
# classes( )

Gets the classes for the control input

Gets the classes for the control input

Returns

array

Since

1.0.0
public string
# input( )

Returns the main input field for rendering

Returns the main input field for rendering

Returns

string
Input field HTML striung

Since

1.0.0

See

uix\ui\uix
public string
# label( )

Returns the label for the control

Returns the label for the control

Returns

string
label of control

Since

1.0.0
public string
# description( )

Returns the description for the control

Returns the description for the control

Returns

string
description string

Since

1.0.0
public string
# render( )

Render the Control

Render the Control

Returns

string
HTML of rendered control

Since

1.0.0

See

uix\ui\uix
public
# is_active( )

checks if the current control is active

checks if the current control is active

Since

1.0.0

Overrides

uix\ui\uix::is_active

Methods inherited from uix\data\data

get_data(), set_data()

Methods inherited from uix\ui\uix

__call(), __construct(), actions(), base_color(), build_attributes(), enqueue_active_assets(), enqueue_core(), id(), init(), process_child(), process_children(), render_children(), set_url()

Properties summary

public string $type

The type of object

The type of object

Since

1.0.0
# 'control'

Properties inherited from uix\data\data

$data

Properties inherited from uix\ui\uix

$assets, $attributes, $child, $parent, $scripts, $slug, $struct, $styles, $url

UIX Documentation API documentation generated by ApiGen