PHP Class PodsUI, pods

显示文件 Open project: pods-framework/pods Class Usage Examples

Public Properties

Property Type Description
$action string
$action_after array
$action_bulk string
$action_links array
$actions_bulk array
$actions_custom array
$actions_disabled array
$actions_hidden array
$allowed used in var_update
$bulk array
$css boolean
$data boolean | array
$data_full boolean | array
$data_keys array
$default_none boolean
$do boolean
$excluded array
$export array
$extra array
$fields array
$filters array
$filters_enhanced boolean
$header boolean
$heading boolean
$help array
$icon boolean
$id integer
$item boolean
$items boolean
$label boolean
$limit integer
$num string
$orderby boolean
$orderby_dir string
$page integer
$pagination boolean
$pagination_total boolean
$params array
$pod array | boolean | mixed | null | Pods
$reorder array
$restrict array
$row array
$save boolean
$screen_options array
$search boolean
$search_across boolean
$search_across_picks boolean
$searchable boolean
$session array
$sortable boolean
$sql array
$style string
$total integer
$total_found integer
$user array
$view string
$views array
$where array
$wpcss boolean
$x base

Public Methods

Method Description
__construct ( mixed $options, boolean $deprecated = false ) : PodsUI Generate UI for Data Management
add ( ) : mixed
callback ( ) : boolean | mixed Check for a custom action callback and run it
callback_action ( ) : boolean | mixed Check for a custom action callback and run it (deprecated reverse arg order)
callback_bulk ( ) : boolean | mixed Check for a bulk action callback and run it
delete ( null $id = null ) : boolean | mixed
delete_bulk ( ) : boolean | mixed
deprecated_filters ( )
do_magic_tags ( $tag ) : string
do_template ( $code, boolean | array $row = false ) : mixed
edit ( boolean $duplicate = false ) : mixed
error ( $msg ) : boolean
exclusion ( ) : array
export ( )
filters ( )
filters_popup ( )
form ( boolean $create = false, boolean $duplicate = false ) : boolean | mixed
get_data ( $params = null ) : boolean
get_field ( $field ) : array | boolean | mixed | null
get_params ( null | array $params = null, null | string $action = null ) Get find() params based on current UI action
get_row ( &$counter, $method = null ) : array
go ( ) : mixed
hidden_vars ( boolean | array $exclude = false, boolean | array $array = false )
limit ( boolean $options = false ) : mixed
manage ( boolean $reorder = false ) : mixed | null
message ( $msg, boolean $error = false )
pagination ( boolean $header = false ) : mixed
reorder ( ) Reorder data
restricted ( $action = 'edit', $row = null )
save ( boolean $insert = false ) : mixed
screen_meta ( )
setup ( $options ) : array | boolean | mixed | null | PodsArray
setup_deprecated ( $deprecated_options ) : array
setup_fields ( null $fields = null, string $which = 'fields' ) : array | boolean | mixed | null
sort_data ( ) Sort out data alphabetically by a key
table ( boolean $reorder = false ) : boolean | mixed
view ( ) : boolean | mixed

Private Methods

Method Description
do_hook ( ) : array | boolean | mixed | null

Method Details

__construct() public method

Generate UI for Data Management
Since: 2.0
public __construct ( mixed $options, boolean $deprecated = false ) : PodsUI
$options mixed Object, Array, or String containing Pod or Options to be used
$deprecated boolean Set to true to support old options array from Pods UI plugin
return PodsUI

add() public method

public add ( ) : mixed
return mixed

callback() public method

Check for a custom action callback and run it
public callback ( ) : boolean | mixed
return boolean | mixed

callback_action() public method

Check for a custom action callback and run it (deprecated reverse arg order)
public callback_action ( ) : boolean | mixed
return boolean | mixed

callback_bulk() public method

Check for a bulk action callback and run it
public callback_bulk ( ) : boolean | mixed
return boolean | mixed Callback result

delete() public method

public delete ( null $id = null ) : boolean | mixed
$id null
return boolean | mixed

delete_bulk() public method

public delete_bulk ( ) : boolean | mixed
return boolean | mixed

deprecated_filters() public method

public deprecated_filters ( )

do_magic_tags() public method

public do_magic_tags ( $tag ) : string
$tag
return string

do_template() public method

public do_template ( $code, boolean | array $row = false ) : mixed
$code
$row boolean | array
return mixed

edit() public method

public edit ( boolean $duplicate = false ) : mixed
$duplicate boolean
return mixed

error() public method

public error ( $msg ) : boolean
$msg
return boolean

exclusion() public method

public exclusion ( ) : array
return array

export() public method

public export ( )

filters() public method

public filters ( )

filters_popup() public method

public filters_popup ( )

form() public method

public form ( boolean $create = false, boolean $duplicate = false ) : boolean | mixed
$create boolean
$duplicate boolean
return boolean | mixed

get_data() public method

public get_data ( $params = null ) : boolean
return boolean

get_field() public method

public get_field ( $field ) : array | boolean | mixed | null
$field
return array | boolean | mixed | null

get_params() public method

Get find() params based on current UI action
public get_params ( null | array $params = null, null | string $action = null )
$params null | array
$action null | string

get_row() public method

public get_row ( &$counter, $method = null ) : array
return array

go() public method

public go ( ) : mixed
return mixed

hidden_vars() public method

public hidden_vars ( boolean | array $exclude = false, boolean | array $array = false )
$exclude boolean | array
$array boolean | array

limit() public method

public limit ( boolean $options = false ) : mixed
$options boolean
return mixed

manage() public method

public manage ( boolean $reorder = false ) : mixed | null
$reorder boolean
return mixed | null

message() public method

public message ( $msg, boolean $error = false )
$msg
$error boolean

pagination() public method

public pagination ( boolean $header = false ) : mixed
$header boolean
return mixed

reorder() public method

Reorder data
public reorder ( )

restricted() public method

public restricted ( $action = 'edit', $row = null )

save() public method

public save ( boolean $insert = false ) : mixed
$insert boolean
return mixed

screen_meta() public method

public screen_meta ( )

setup() public method

public setup ( $options ) : array | boolean | mixed | null | PodsArray
$options
return array | boolean | mixed | null | PodsArray

setup_deprecated() public method

public setup_deprecated ( $deprecated_options ) : array
$deprecated_options
return array

setup_fields() public method

public setup_fields ( null $fields = null, string $which = 'fields' ) : array | boolean | mixed | null
$fields null
$which string
return array | boolean | mixed | null

sort_data() public method

Sort out data alphabetically by a key
public sort_data ( )

table() public method

public table ( boolean $reorder = false ) : boolean | mixed
$reorder boolean
return boolean | mixed

view() public method

Since: 2.3.10
public view ( ) : boolean | mixed
return boolean | mixed

Property Details

$action public_oe property

public string $action
return string

$action_after public_oe property

public array $action_after
return array

$action_bulk public_oe property

public string $action_bulk
return string

$actions_bulk public_oe property

public array $actions_bulk
return array

$actions_custom public_oe property

public array $actions_custom
return array

$actions_disabled public_oe property

public array $actions_disabled
return array

$actions_hidden public_oe property

public array $actions_hidden
return array

$allowed static_oe public_oe property

used in var_update
static public $allowed

$bulk public_oe property

public array $bulk
return array

$css public_oe property

public bool $css
return boolean

$data public_oe property

public bool|array $data
return boolean | array

$data_full public_oe property

public bool|array $data_full
return boolean | array

$data_keys public_oe property

public array $data_keys
return array

$default_none public_oe property

public bool $default_none
return boolean

$do public_oe property

public bool $do
return boolean

$excluded static_oe public_oe property

static public array $excluded
return array

$export public_oe property

public array $export
return array

$extra public_oe property

public array $extra
return array

$fields public_oe property

public array $fields
return array

$filters public_oe property

public array $filters
return array

$filters_enhanced public_oe property

public bool $filters_enhanced
return boolean

$header public_oe property

public bool $header
return boolean

$heading public_oe property

public bool $heading
return boolean

$help public_oe property

public array $help
return array

$icon public_oe property

public bool $icon
return boolean

$id public_oe property

public int $id
return integer

$item public_oe property

public bool $item
return boolean

$items public_oe property

public bool $items
return boolean

$label public_oe property

public bool $label
return boolean

$limit public_oe property

public int $limit
return integer

$num public_oe property

public string $num
return string

$orderby public_oe property

public bool $orderby
return boolean

$orderby_dir public_oe property

public string $orderby_dir
return string

$page public_oe property

public int $page
return integer

$pagination public_oe property

public bool $pagination
return boolean

$pagination_total public_oe property

public bool $pagination_total
return boolean

$params public_oe property

public array $params
return array

$pod public_oe property

public array|bool|mixed|null|Pods $pod
return array | boolean | mixed | null | Pods

$reorder public_oe property

public array $reorder
return array

$restrict public_oe property

public array $restrict
return array

$row public_oe property

public array $row
return array

$save public_oe property

public bool $save
return boolean

$screen_options public_oe property

public array $screen_options
return array

$search_across public_oe property

public bool $search_across
return boolean

$search_across_picks public_oe property

public bool $search_across_picks
return boolean

$searchable public_oe property

public bool $searchable
return boolean

$session public_oe property

public array $session
return array

$sortable public_oe property

public bool $sortable
return boolean

$sql public_oe property

public array $sql
return array

$style public_oe property

public string $style
return string

$total public_oe property

public int $total
return integer

$total_found public_oe property

public int $total_found
return integer

$user public_oe property

public array $user
return array

$view public_oe property

public string $view
return string

$views public_oe property

public array $views
return array

$where public_oe property

public array $where
return array

$wpcss public_oe property

public bool $wpcss
return boolean

$x public_oe property

base
public $x