Class Fieldmanager_Datasource

Datasource base class to populate autocomplete and option fields.

Datasources provide data to populate autocomplete and option fields.

This class can be used as an arbitrary data source for static options, or it can be extended to provide custom data sources.

Direct known subclasses

Fieldmanager_Datasource_Post, Fieldmanager_Datasource_Term, Fieldmanager_Datasource_User

Package: Fieldmanager\Datasource
Located at datasource/class-fieldmanager-datasource.php

Methods summary

`public`	# `__construct( mixed $options = array() )` Constructor Constructor
`public string`	# `get_value( integer $id )` Get the value of an item; most clearly used by Post and Term, which take database IDs and return user-friendly titles. Get the value of an item; most clearly used by Post and Term, which take database IDs and return user-friendly titles. Parameters `$id` `integer` $id Returns `string` value
`public array,`	# `get_items( string $fragment = Null )` Get available options, optionally filtering by a fragment (e.g. for Autocomplete) Get available options, optionally filtering by a fragment (e.g. for Autocomplete) Parameters `$fragment` `string` $fragment optional fragment to filter by Returns `array,` key => value of available options
`public string`	# `get_ajax_action( )` Get an action to register by hashing (non cryptographically for speed) the options that make this datasource unique. Get an action to register by hashing (non cryptographically for speed) the options that make this datasource unique. Returns `string` ajax action
`public`	# `get_items_for_ajax( string\|null $fragment = null )` Format items for use in AJAX. Format items for use in AJAX. Parameters `$fragment` `string\|null` $fragment to search
`public void,`	# `autocomplete_search( )` AJAX callback to find posts AJAX callback to find posts Returns `void,` causes process to exit.
`public string`	# `presave_alter_values( Fieldmanager_Field $field, string\|integer $values, string\|integer\|null $current_values )` Trigger to handle actions needed before saving data Trigger to handle actions needed before saving data Parameters `$field` `Fieldmanager_Field` $field `$values` `string\|integer` $value `$current_values` `string\|integer\|null` $current_value Returns `string` cleaned value
`public array`	# `preload_alter_values( Fieldmanager_Field $field, array $values )` Modify values before rendering editor Modify values before rendering editor Parameters `$field` `Fieldmanager_Field` $field `$values` `array` $values Returns `array` $values loaded up, if applicable.
`public string`	# `presave( Fieldmanager_Field $field, string\|integer $value, string\|integer\|null $current_value )` Datasource handles sanitization and validation Datasource handles sanitization and validation Parameters `$field` `Fieldmanager_Field` $field `$value` `string\|integer` $value `$current_value` `string\|integer\|null` $current_value Returns `string` cleaned value
`public string`	# `get_view_link( integer\|string $value )` Get view link, not used here but meant for override Get view link, not used here but meant for override Parameters `$value` `integer\|string` $value Returns `string`
`public string`	# `get_edit_link( integer\|string $value )` Get edit link, not used here but meant for override Get edit link, not used here but meant for override Parameters `$value` `integer\|string` $value Returns `string`

Magic methods summary

Properties summary

`public array`	`$options`	#
`public boolean`	`$options_callback`	#
`public boolean`	`$use_ajax`	#
`public boolean`	`$allow_optgroups`	#
`public string`	`$ajax_action`	#
`public static integer`	`$counter`	# Counter to create uniquely named AJAX actions. Counter to create uniquely named AJAX actions.
`public boolean`	`$grouped`	# If true, group elements If true, group elements

Packages

Classes

Class Fieldmanager_Datasource

Direct known subclasses

Methods summary

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Magic methods summary

Properties summary