class views_object
Provides the basic object definitions used by plugins and handlers.
Hierarchy
- class \views_object
Expanded class hierarchy of views_object
File
-
includes/
base.inc, line 11
View source
class views_object {
/**
* Except for displays, options for the object will be held here.
*/
public $options = array();
/**
* The top object of a view.
*
* @var view
*/
public $view = NULL;
/**
* Handler's definition.
*
* @var array
*/
public $definition;
/**
* Information about options for all kinds of purposes will be held here.
*
* @code
* 'option_name' => array(
* - 'default' => default value,
* - 'translatable' => (optional) TRUE/FALSE (wrap in t() on export if true),
* - 'contains' => (optional) array of items this contains, with its own
* defaults, etc. If contains is set, the default will be ignored and
* assumed to be array().
* - 'bool' => (optional) TRUE/FALSE Is the value a boolean value. This will
* change the export format to TRUE/FALSE instead of 1/0.
* - 'export' => (optional) FALSE or a callback for special export handling
* if necessary.
* - 'unpack_translatable' => (optional) callback for special handling for
* translating data within the option, if necessary.
* ),
* @endcode
*
* @return array
* Returns the options of this handler/plugin.
*
* @see views_object::export_option()
* @see views_object::export_option_always()
* @see views_object::unpack_translatable()
*/
public function option_definition() {
return array();
}
/**
* Collect this handler's option definition and alter them, ready for use.
*
* @return array
* Returns the options of this handler/plugin after allowing for alters.
*
* @see hook_views_plugin_option_definition_alter()
* @see hook_views_handler_option_definition_alter()
*/
public function altered_option_definition() {
$definition = $this->option_definition();
if (!empty($this->is_plugin)) {
// Trigger hook_views_plugin_option_definition_alter().
drupal_alter('views_plugin_option_definition', $definition, $this);
}
else {
// Trigger hook_views_handler_option_definition_alter().
drupal_alter('views_handler_option_definition', $definition, $this);
}
return $definition;
}
/**
* Views handlers use a special construct function.
*
* Allows it to more easily construct them with variable arguments.
*/
public function construct() {
$this->set_default_options();
}
/**
* Set default options on this object.
*
* Called by the constructor in a complex chain to deal with backward
* compatibility.
*
* @deprecated since views2
*/
public function options(&$options) {
}
/**
* Set default options.
*
* For backward compatibility, it sends the options array; this is a feature
* that will likely disappear at some point.
*/
public function set_default_options() {
$this->_set_option_defaults($this->options, $this->altered_option_definition());
// Retained for complex defaults plus backward compatibility.
$this->options($this->options);
}
/**
*
*/
public function _set_option_defaults(&$storage, $options, $level = 0) {
foreach ($options as $option => $definition) {
if (isset($definition['contains']) && is_array($definition['contains'])) {
$storage[$option] = array();
$this->_set_option_defaults($storage[$option], $definition['contains'], $level++);
}
elseif (!empty($definition['translatable']) && !empty($definition['default'])) {
$storage[$option] = t($definition['default']);
}
else {
$storage[$option] = isset($definition['default']) ? $definition['default'] : NULL;
}
}
}
/**
* Unpack options over our existing defaults, drilling down into arrays so
* that defaults don't get totally blown away.
*/
public function unpack_options(&$storage, $options, $definition = NULL, $all = TRUE, $check = TRUE, $localization_keys = array()) {
if ($check && !is_array($options)) {
return;
}
if (!isset($definition)) {
$definition = $this->altered_option_definition();
}
if (!empty($this->view)) {
// Ensure we have a localization plugin.
$this->view
->init_localization();
// Set up default localization keys. Handlers and such set this for us.
if (empty($localization_keys) && isset($this->localization_keys)) {
$localization_keys = $this->localization_keys;
}
elseif (!empty($this->is_plugin) && empty($localization_keys)) {
if ($this->plugin_type != 'display') {
$localization_keys = array(
$this->view->current_display,
);
$localization_keys[] = $this->plugin_type;
}
}
}
foreach ($options as $key => $value) {
if (is_array($value)) {
// Ignore arrays with no definition.
if (!$all && empty($definition[$key])) {
continue;
}
if (!isset($storage[$key]) || !is_array($storage[$key])) {
$storage[$key] = array();
}
// If we're just unpacking our known options, and we're dropping an
// unknown array (as might happen for a dependent plugin fields) go
// ahead and drop that in.
if (!$all && isset($definition[$key]) && !isset($definition[$key]['contains'])) {
$storage[$key] = $value;
continue;
}
$this->unpack_options($storage[$key], $value, isset($definition[$key]['contains']) ? $definition[$key]['contains'] : array(), $all, FALSE, array_merge($localization_keys, array(
$key,
)));
}
elseif (empty($this->view->editing) && !empty($definition[$key]['translatable']) && !empty($value) || !empty($definition['contains'][$key]['translatable']) && !empty($value)) {
if (!empty($this->view) && $this->view
->is_translatable()) {
// Allow other modules to make changes to the string before it's
// sent for translation.
// The $keys array is built from the view name, any localization keys
// sent in, and the name of the property being processed.
$format = NULL;
if (isset($definition[$key]['format_key']) && isset($options[$definition[$key]['format_key']])) {
$format = $options[$definition[$key]['format_key']];
}
$translation_data = array(
'value' => $value,
'format' => $format,
'keys' => array_merge(array(
$this->view->name,
), $localization_keys, array(
$key,
)),
);
$storage[$key] = $this->view->localization_plugin
->translate($translation_data);
}
else {
$storage[$key] = t($value);
}
}
elseif ($all || !empty($definition[$key])) {
$storage[$key] = $value;
}
}
}
/**
* Let the handler know what its full definition is.
*/
public function set_definition($definition) {
$this->definition = $definition;
if (isset($definition['field'])) {
$this->real_field = $definition['field'];
}
}
/**
* Destructor.
*/
public function destroy() {
if (isset($this->view)) {
unset($this->view);
}
if (isset($this->display)) {
unset($this->display);
}
if (isset($this->query)) {
unset($this->query);
}
}
/**
*
*/
public function export_options($indent, $prefix) {
$output = '';
foreach ($this->altered_option_definition() as $option => $definition) {
$output .= $this->export_option($indent, $prefix, $this->options, $option, $definition, array());
}
return $output;
}
/**
*
*/
public function export_option($indent, $prefix, $storage, $option, $definition, $parents) {
// Do not export options for which we have no settings.
if (!isset($storage[$option])) {
return;
}
if (isset($definition['export'])) {
if ($definition['export'] === FALSE) {
return;
}
// Special handling for some items.
if (method_exists($this, $definition['export'])) {
return $this->{$definition['export']}($indent, $prefix, $storage, $option, $definition, $parents);
}
}
// Add the current option to the parents tree.
$parents[] = $option;
$output = '';
// If it has child items, export those separately.
if (isset($definition['contains'])) {
foreach ($definition['contains'] as $sub_option => $sub_definition) {
$output .= $this->export_option($indent, $prefix, $storage[$option], $sub_option, $sub_definition, $parents);
}
}
else {
$default = isset($definition['default']) ? $definition['default'] : NULL;
$value = $storage[$option];
if (isset($definition['bool'])) {
$value = (bool) $value;
}
if ($value !== $default) {
$output .= $indent . $prefix . "['" . implode("']['", $parents) . "'] = ";
if (isset($definition['bool'])) {
$output .= empty($storage[$option]) ? 'FALSE' : 'TRUE';
}
else {
$output .= views_var_export($storage[$option], $indent);
}
$output .= ";\n";
}
}
return $output;
}
/**
* Always exports the option, regardless of the default value.
*/
public function export_option_always($indent, $prefix, $storage, $option, $definition, $parents) {
// If there is no default, the option will always be exported.
unset($definition['default']);
// Unset our export method to prevent recursion.
unset($definition['export']);
return $this->export_option($indent, $prefix, $storage, $option, $definition, $parents);
}
/**
* Unpacks each handler to store translatable texts.
*/
public function unpack_translatables(&$translatable, $parents = array()) {
foreach ($this->altered_option_definition() as $option => $definition) {
$this->unpack_translatable($translatable, $this->options, $option, $definition, $parents, array());
}
}
/**
* Unpack a single option definition.
*
* This function run's through all suboptions recursive.
*
* @param array $translatable
* Stores all available translatable items.
* @param array $storage
* @param string $option
* @param string $definition
* @param array $parents
* @param array $keys
*/
public function unpack_translatable(&$translatable, $storage, $option, $definition, $parents, $keys = array()) {
// Do not export options for which we have no settings.
if (!isset($storage[$option])) {
return;
}
// Special handling for some items.
if (isset($definition['unpack_translatable']) && method_exists($this, $definition['unpack_translatable'])) {
return $this->{$definition['unpack_translatable']}($translatable, $storage, $option, $definition, $parents, $keys);
}
if (isset($definition['translatable'])) {
if ($definition['translatable'] === FALSE) {
return;
}
}
// Add the current option to the parents tree.
$parents[] = $option;
// If it has child items, unpack those separately.
if (isset($definition['contains'])) {
foreach ($definition['contains'] as $sub_option => $sub_definition) {
$translation_keys = array_merge($keys, array(
$sub_option,
));
$this->unpack_translatable($translatable, $storage[$option], $sub_option, $sub_definition, $parents, $translation_keys);
}
}
// @todo Figure out this double definition stuff.
$options = $storage[$option];
if (is_array($options)) {
foreach ($options as $key => $value) {
$translation_keys = array_merge($keys, array(
$key,
));
if (is_array($value)) {
$this->unpack_translatable($translatable, $options, $key, $definition, $parents, $translation_keys);
}
elseif (!empty($definition[$key]['translatable']) && !empty($value)) {
// Build source data and add to the array.
$format = NULL;
if (isset($definition['format_key']) && isset($options[$definition['format_key']])) {
$format = $options[$definition['format_key']];
}
$translatable[] = array(
'value' => $value,
'keys' => $translation_keys,
'format' => $format,
);
}
}
}
elseif (!empty($definition['translatable']) && !empty($options)) {
$value = $options;
// Build source data and add to the array.
$format = NULL;
if (isset($definition['format_key']) && isset($storage[$definition['format_key']])) {
$format = $storage[$definition['format_key']];
}
$translatable[] = array(
'value' => $value,
'keys' => isset($translation_keys) ? $translation_keys : $parents,
'format' => $format,
);
}
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|---|
views_object::$definition | public | property | Handler's definition. | ||
views_object::$options | public | property | Except for displays, options for the object will be held here. | 1 | |
views_object::$view | public | property | The top object of a view. | 2 | |
views_object::altered_option_definition | public | function | Collect this handler's option definition and alter them, ready for use. | ||
views_object::construct | public | function | Views handlers use a special construct function. | 4 | |
views_object::destroy | public | function | Destructor. | 2 | |
views_object::export_option | public | function | 1 | ||
views_object::export_options | public | function | |||
views_object::export_option_always | public | function | Always exports the option, regardless of the default value. | ||
views_object::options | Deprecated | public | function | Set default options on this object. | 1 |
views_object::option_definition | public | function | Information about options for all kinds of purposes will be held here. | 13 | |
views_object::set_default_options | public | function | Set default options. | ||
views_object::set_definition | public | function | Let the handler know what its full definition is. | ||
views_object::unpack_options | public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. |
||
views_object::unpack_translatable | public | function | Unpack a single option definition. | ||
views_object::unpack_translatables | public | function | Unpacks each handler to store translatable texts. | ||
views_object::_set_option_defaults | public | function |