class metatag_handler_field_serialized in Metatag 7
Hierarchy
- class \views_object
- class \views_handler
- class \views_handler_field
- class \views_handler
Expanded class hierarchy of metatag_handler_field_serialized
1 string reference to 'metatag_handler_field_serialized'
- metatag_views_data in ./
metatag.views.inc - Implements hook_views_data().
File
- views/
metatag_handler_field_serialized.inc, line 11
View source
class metatag_handler_field_serialized extends metatag_handler_field_entity {
/**
* @var bool
*/
public $uses_default;
/**
* The raw value for this field.
*
* @var string
*/
public $raw_value;
/**
* {@inheritdoc}
*/
public function option_definition() {
$options = parent::option_definition();
$options['metatag'] = array(
'contains' => array(
'use_default' => array(
'default' => FALSE,
'bool' => TRUE,
),
'replace_tokens' => array(
'default' => FALSE,
'bool' => TRUE,
),
),
);
return $options;
}
/**
* {@inheritdoc}
*/
public function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
$form['metatag'] = array(
'#type' => 'fieldset',
'#title' => 'Metatag',
'#collapsible' => TRUE,
);
$form['metatag']['use_default'] = array(
'#type' => 'checkbox',
'#title' => 'Use default metatag value',
'#description' => 'Display default value if no value has been defined on entity.',
'#default_value' => $this->options['metatag']['use_default'],
);
$form['metatag']['replace_tokens'] = array(
'#type' => 'checkbox',
'#title' => 'Replace tokens',
'#description' => 'Attempt to replace all tokens with their (entity) values. Note: Tokens in metatags will be replaced before Views tokens.',
'#default_value' => $this->options['metatag']['replace_tokens'],
);
}
/**
* {@inheritdoc}
*/
public function get_value($values, $field = NULL) {
$value = parent::get_value($values);
if (!is_null($value)) {
$value = @unserialize($value);
$value = $this
->get_nested_value($value, $this->definition['path']);
}
$this->uses_default = FALSE;
if (is_null($value) && !empty($this->options['metatag']['use_default'])) {
$value = $this
->get_default_value($values);
$this->uses_default = TRUE;
}
$this->raw_value = $value;
return $value;
}
/**
* {@inheritdoc}
*/
public function get_default_value($values) {
$entity_type = $this
->get_entity_type($values);
$instance = $entity_type;
$entity = $this
->get_entity($values);
list(, , $bundle) = entity_extract_ids($entity_type, $entity);
if (!is_null($bundle)) {
$instance .= ":{$bundle}";
}
$defaults = metatag_config_load_with_defaults($instance);
return $this
->get_nested_value($defaults, $this->definition['path']);
}
/**
* {@inheritdoc}
*/
public function replace_tokens($value, $values) {
$entity_type = $this
->get_entity_type($values);
$entity = $this
->get_entity($values);
// Reload the entity object from cache as it may have been altered.
$token_type = token_get_entity_mapping('entity', $entity_type);
$options['token data'][$token_type] = $entity;
$options['entity'] = $entity;
$value = metatag_get_value($this->definition['metatag'], array(
'value' => $value,
), $options);
return $value;
}
/**
* Retrieves a nested value from an array.
*
* @param array $value
* An array of meta tag values.
* @param string $path
* The path to search for.
*
* @return string|null
* The matching string, otherwise NULL.
*/
public function get_nested_value(array $value, $path) {
foreach ($path as $index) {
if (!isset($value[$index])) {
return NULL;
}
$value = $value[$index];
}
return $value;
}
/**
* {@inheritdoc}
*/
public function render($values) {
$value = (string) $this
->get_value($values);
if (strlen($value) && !empty($this->options['metatag']['replace_tokens'])) {
$value = $this
->replace_tokens($value, $values);
}
return $this
->sanitize_value($value);
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
metatag_handler_field_entity:: |
public | property | ||
metatag_handler_field_entity:: |
public | property | ||
metatag_handler_field_entity:: |
public | function | Set the base_table and base_table_alias. | |
metatag_handler_field_entity:: |
public | function | ||
metatag_handler_field_entity:: |
public | function | ||
metatag_handler_field_entity:: |
public | function |
Heavily modified code from views_hander_field_field::query(). Overrides views_handler_field:: |
|
metatag_handler_field_serialized:: |
public | property | The raw value for this field. | |
metatag_handler_field_serialized:: |
public | property | ||
metatag_handler_field_serialized:: |
public | function | ||
metatag_handler_field_serialized:: |
public | function | Retrieves a nested value from an array. | |
metatag_handler_field_serialized:: |
public | function |
Get the value that's supposed to be rendered. Overrides views_handler_field:: |
|
metatag_handler_field_serialized:: |
public | function |
Default options form provides the label widget that all fields should have. Overrides views_handler_field:: |
1 |
metatag_handler_field_serialized:: |
public | function |
Information about options for all kinds of purposes will be held here. Overrides views_handler_field:: |
1 |
metatag_handler_field_serialized:: |
public | function |
Render the field. Overrides views_handler_field:: |
1 |
metatag_handler_field_serialized:: |
public | function | ||
views_handler:: |
public | property | The type of the handler, for example filter/footer/field. | |
views_handler:: |
public | property | Where the $query object will reside:. | 1 |
views_handler:: |
public | property | The actual field in the database table, maybe different on other kind of query plugins/special handlers. | |
views_handler:: |
public | property | The relationship used for this field. | |
views_handler:: |
public | property | The alias of the table of this handler which is used in the query. | |
views_handler:: |
public | property |
The top object of a view. Overrides views_object:: |
|
views_handler:: |
public | function | Take input from exposed handlers and assign to this handler, if necessary. | 1 |
views_handler:: |
public | function | Check whether current user has access to this handler. | 10 |
views_handler:: |
public | function | Determine if the handler is considered 'broken'. | 6 |
views_handler:: |
public | function | Determine if a handler can be exposed. | 2 |
views_handler:: |
public | function | Transform a string by a certain method. | |
views_handler:: |
public | function | Ensure the main table for this handler is in the query. This is used a lot. | 8 |
views_handler:: |
public | function | Render our chunk of the exposed handler form when selecting. | 1 |
views_handler:: |
public | function | Get information about the exposed form for the form renderer. | 1 |
views_handler:: |
public | function | Submit the exposed handler form. | |
views_handler:: |
public | function | Validate the exposed handler form. | 4 |
views_handler:: |
public | function | Form for exposed handler options. | 2 |
views_handler:: |
public | function | Set new exposed option defaults when exposed setting is flipped on. | 2 |
views_handler:: |
public | function | Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data. | |
views_handler:: |
public | function | Validate the options form. | 1 |
views_handler:: |
public | function | Provide defaults for the handler. | |
views_handler:: |
public | function | Provide a form for setting options. | 1 |
views_handler:: |
public | function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. | |
views_handler:: |
public | function | Validate the options form. | |
views_handler:: |
public | function | Shortcut to get a handler's raw field value. | |
views_handler:: |
public | function | Get the join object that should be used for this handler. | |
views_handler:: |
public | function | Provide a form for aggregation settings. | 1 |
views_handler:: |
public | function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. | 1 |
views_handler:: |
public | function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | 1 |
views_handler:: |
public | function | Returns TRUE if the exposed filter works like a grouped filter. | 1 |
views_handler:: |
public | function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
views_handler:: |
public | function | Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets. | 1 |
views_handler:: |
public | function | Determine if the argument needs a style plugin. | 1 |
views_handler:: |
public | function | Validate the options form. | 4 |
views_handler:: |
public | function | Provides a unique placeholders for handlers. | |
views_handler:: |
public | function | Run after the view is executed, before the result is cached. | 1 |
views_handler:: |
public | function | Run before the view is built. | 1 |
views_handler:: |
public | function | Sanitize the value for output. | |
views_handler:: |
public | function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
views_handler:: |
public | function | Shortcut to display the expose/hide button. | 2 |
views_handler:: |
public | function | Shortcut to display the exposed options form. | |
views_handler:: |
public | function | If set to remember exposed input in the session, store it there. | 1 |
views_handler:: |
public | function | Provides the handler some groupby. | 2 |
views_handler:: |
public | function | Validates the handler against the complete View. | 1 |
views_handler_field:: |
public | property | Stores additional fields which get added to the query. The generated aliases are stored in $aliases. | |
views_handler_field:: |
public | property | ||
views_handler_field:: |
public | property | ||
views_handler_field:: |
protected | property | Keeps track of the last render index. | |
views_handler_field:: |
public | property | The field value prior to any rewriting. | |
views_handler_field:: |
public | function | Add 'additional' fields to the query. | |
views_handler_field:: |
public | function | Add any special tokens this field might use for itself. | 4 |
views_handler_field:: |
public | function |
Provide extra data to the administration form Overrides views_handler:: |
|
views_handler_field:: |
public | function | Render a field using advanced settings. | |
views_handler_field:: |
public | function | Determine if this field can allow advanced rendering. | 1 |
views_handler_field:: |
public | function | Called to determine what to tell the clicksorter. | 1 |
views_handler_field:: |
public | function | Determine if this field is click sortable. | 1 |
views_handler_field:: |
public | function |
Construct a new field handler. Overrides views_object:: |
17 |
views_handler_field:: |
public | function | Document any special tokens this field might use for itself. | 4 |
views_handler_field:: |
public | function | Return the class of the field. | |
views_handler_field:: |
public | function | Return the class of the field's label. | |
views_handler_field:: |
public | function | Return an HTML element for the label based upon the field's element type. | |
views_handler_field:: |
public | function | Return an HTML element based upon the field's element type. | 2 |
views_handler_field:: |
public | function | Return the class of the field's wrapper. | |
views_handler_field:: |
public | function | Return an HTML element for the wrapper based upon the field's element type. | |
views_handler_field:: |
public | function | Provide a list of elements valid for field HTML. | |
views_handler_field:: |
public | function | Get the 'render' tokens to use for advanced rendering. | |
views_handler_field:: |
public | function | Recursive function to add replacements for nested query string parameters. | |
views_handler_field:: |
public | function |
Init the handler with necessary data. Overrides views_handler:: |
11 |
views_handler_field:: |
public | function | Checks if a field value is empty. | |
views_handler_field:: |
public | function | Get this field's label. | |
views_handler_field:: |
public | function |
Performs some cleanup tasks on the options array before saving it. Overrides views_handler:: |
1 |
views_handler_field:: |
public | function | Run before any fields are rendered. | 8 |
views_handler_field:: |
public | function | Render this field as altered text, from a fieldset set by the user. | |
views_handler_field:: |
public | function | Render this field as a link, with info from a fieldset set by the user. | |
views_handler_field:: |
public | function | Perform an advanced text render for the item. | |
views_handler_field:: |
public | function | Trim the field down to the specified length. | |
views_handler_field:: |
public | function | Call out to the theme() function. | |
views_handler_field:: |
public | function | Build a list of suitable theme functions for this view. | |
views_handler_field:: |
public | function | Replace a value with tokens from the last field. | |
views_handler_field:: |
public | function |
Return a string representing this handler's name in the UI. Overrides views_handler:: |
1 |
views_handler_field:: |
public | function | Determines if this field will be available as an option to group the result by in the style settings. | |
views_object:: |
public | property | Handler's definition. | |
views_object:: |
public | property | Except for displays, options for the object will be held here. | 1 |
views_object:: |
function | Collect this handler's option definition and alter them, ready for use. | ||
views_object:: |
public | function | Destructor. | 2 |
views_object:: |
public | function | 1 | |
views_object:: |
public | function | ||
views_object:: |
public | function | Always exports the option, regardless of the default value. | |
views_object:: |
public | function | Set default options on this object. | 1 |
views_object:: |
public | function | Set default options. | |
views_object:: |
public | function | Let the handler know what its full definition is. | |
views_object:: |
public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
views_object:: |
public | function | Unpack a single option definition. | |
views_object:: |
public | function | Unpacks each handler to store translatable texts. | |
views_object:: |
public | function |