adminGenericFilterV2 Class Reference

Inheritance diagram for adminGenericFilterV2:

Public Member Functions
	__construct (string $type)
	userOptions (?string $option=null)
	values (bool $escape=false, bool $ui_only=false)
	value (string $id, ?string $undefined=null)
	__get (string $id)
	add ($filter=null, $value=null)
	remove (string $id)
	params ()
	show (bool $set=false)
	js (string $reset_url='')
	display ($adminurl, string $extra='')

Protected Member Functions
	parseOptions ()

Protected Attributes
	$type
	$filters = []
	$show = false
	$has_user_pref = false

Constructor & Destructor Documentation

__construct()

__construct

(

string

$type

)

Constructs a new instance.

Parameters

string

$type

The filter form main id

Reimplemented in adminMediaFilter.

References $type, and parseOptions().

Member Function Documentation

userOptions()

userOptions

(

?string

$option = null

)

Get user defined filter options (sortby, order, nb)

Parameters

string

$option

The option

Returns

mixed User option

References adminUserPref\getUserFilters().

Referenced by parseOptions().

parseOptions()

parseOptions ( )

protected

Parse _GET user pref options (sortby, order, nb)

References dcAdminCombos\getOrderCombo(), adminUserPref\getUserFilters(), show(), and userOptions().

Referenced by __construct().

values()

values	(	bool	$escape = false,
		bool	$ui_only = false
	)

Get filters key/value pairs

Parameters

boolean	$escape	Escape widlcard %
boolean	$ui_only	Limit to filters with ui

Returns

array The filters

Referenced by adminMediaPage\breadcrumb(), adminMediaFilter\legacyBehavior(), adminMediaList\mediaLine(), and params().

value()

value	(	string	$id,
		?string	$undefined = null
	)

Get a filter value

Parameters

string	$id	The filter id
null | string	$undefined	The filter value if not exists

Returns

mixed The filter value

Referenced by __get(), and display().

__get()

__get

(

string

$id

)

Magic get filter value

Parameters

string

$id

The filter id

Returns

mixed The filter value

References value().

add()

add	(		$filter = null,
			$value = null
	)

Add filter(s)

Parameters

array | string | dcAdminFilter | null	$filter	The filter(s) array or id or object
mixed	$value	The filter value if $filter is id

Returns

mixed The filter value

References add(), and show().

Referenced by adminCommentFilter\__construct(), adminUserFilter\__construct(), adminBlogFilter\__construct(), adminMediaFilter\__construct(), adminPostFilter\__construct(), add(), and adminMediaFilter\legacyBehavior().

remove()

remove

(

string

$id

)

Remove a filter

Parameters

string

$id

The filter id

Returns

boolean The success

params()

params

(

)

Get list query params

Returns

array The query params

References $filters, and values().

show()

show

(

bool

$set = false

)

Show foldable filters form

Parameters

boolean

$set

Force to show filter form

Returns

boolean Show filter form

References $show, and show().

Referenced by add(), adminMediaList\display(), js(), parseOptions(), and show().

js()

js

(

string

$reset_url = ''

)

Get js filters foldable form control

Parameters

string

$reset_url

The filter reset url

References dcPage\jsFilterControl(), dcPage\jsJson(), and show().

display()

display	(		$adminurl,
		string	$extra = ''
	)

Echo filter form

Parameters

array | string	$adminurl	The registered adminurl
string	$extra	The extra contents

References dcCore\app(), form\hidden(), formLabel\INSIDE_TEXT_AFTER, formLabel\OUTSIDE_LABEL_BEFORE, and value().

Field Documentation

$type

$type

protected

Referenced by adminGenericFilter\__construct(), __construct(), adminMediaFilter\__construct(), adminPostFilter\__construct(), and adminMediaPage\getDirs().

$filters

$filters = []

protected

Referenced by adminCommentFilter\__construct(), adminUserFilter\__construct(), adminBlogFilter\__construct(), adminMediaFilter\__construct(), adminPostFilter\__construct(), and params().

$show

$show = false

protected

Referenced by show().

$has_user_pref

$has_user_pref = false

protected

---

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

• inc/admin/lib.adminfilters.php