class image_gallery_handler_field_gallery_cover in Image 7
Same name and namespace in other branches
- 6 contrib/image_gallery/views/image_gallery_handler_field_gallery_cover.inc \image_gallery_handler_field_gallery_cover
Parent class for field handlers that gives us a gallery cover.
This takes care of defining the descendant and depth options, getting and storing a query, and running the query to get the cover nid.
There are several ways to use this class:
- Define the ordering in the field definition, with an 'order clause' key. This gets tacked onto the fairly simple node query defined in this handler.
- Define your own query in the field definition with a 'basic query' key.
- Subclass this handler and create your own query by overriding get_cover_node_nid_query(). This allows some pretty complex stuff, such as grabbing the query from another view.
Hierarchy
- class \views_object
- class \views_handler
Expanded class hierarchy of image_gallery_handler_field_gallery_cover
1 string reference to 'image_gallery_handler_field_gallery_cover'
- image_gallery_views_handlers in contrib/
image_gallery/ views/ image_gallery.views.inc - Implementation of hook_views_handlers().
File
- contrib/
image_gallery/ views/ image_gallery_handler_field_gallery_cover.inc, line 17
View source
class image_gallery_handler_field_gallery_cover extends views_handler_field_taxonomy {
/**
* Constructor to provide additional fields to add.
*/
function construct() {
parent::construct();
$this->additional_fields['tid'] = 'tid';
}
function init(&$view, $options) {
parent::init($view, $options);
// Store the image gallery vocabulary ID.
$this->vid = _image_gallery_get_vid();
// The name of a key that is safe to use in $values to stash our nid.
// This is just a dummy that should be overridden.
// Groups of handlers that use the same query (eg, latest image and last
// update time) should override this to a safe key that they can share.
// This avoids running the query/ies to get the cover nid multiple times for
// each row of the view.
// TODO: doesn't work and probably can't ever, because if the user adds more
// than one cover image, we can't reliably create a unique key here that
// another field can know to find.
/*
if ($this->definition['cover group']) {
$this->cover_stash = $this->definition['cover group'];
}
else {
$this->cover_stash = 'image_gallery_cover';
}
*/
}
function option_definition() {
$options = parent::option_definition();
$options['depth'] = array(
'default' => 0,
);
$options['descendants'] = array(
'default' => 'single',
);
return $options;
}
function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
$form['descendants'] = array(
'#type' => 'radios',
'#title' => t('Descendant handling'),
// Child handlers should replace this text with something more relevant
// to what they do.
'#description' => theme('advanced_help_topic', 'image_gallery', 'descendants') . t('How to get data from subgalleries: either only select from this gallery itself, or consider subgalleries all together, or recurse into subgalleries if the gallery itself is empty.'),
'#options' => array(
'single' => t('Only select from this gallery'),
'flat' => t('Consider subgalleries, flattened.'),
'recurse' => t('Consider subgalleries, recursively. (Warning: this can produce many queries per row if your parent galleries are empty!).'),
),
'#default_value' => $this->options['descendants'],
);
$form['depth'] = array(
'#type' => 'select',
'#title' => t('Depth'),
'#options' => array_merge(range(0, 10), array(
'all' => 'Unlimited',
)),
'#default_value' => $this->options['depth'],
'#description' => t('How deeply to go into subgalleries if one of the descendant options is selected above.'),
);
}
/**
* Get the cover nid for the current tid.
*
* This makes up our query from the field definition and handler functions,
* and then runs it according to the descendant and depth options given
* for the field.
*/
function get_cover_node_nid($values) {
// The term id of the current gallery.
// This comes straight from the database row so should be safe for
// inclusion in a query.
$tid = $values->tid;
// Get the basic query but only once for all rows of the view.
// This can be set in the handler definition, or in the handler class's
// get_cover_node_nid_query function for more complex cases.
// The handler definition takes priority over the function.
// This is stored in the handler object so we only have to get it
// once for the whole view.
if (!isset($this->basic_query)) {
if (isset($this->definition['basic query'])) {
$this->basic_query = $this->definition['basic query'];
}
else {
$this->basic_query = $this
->get_cover_node_nid_query();
}
}
// If we don't have a query, return NULL now to prevent SQL errors.
if (is_null($this->basic_query)) {
return NULL;
}
// Add the definition's ORDER clause, if there is one.
if ($this->definition['order clause']) {
$this->basic_query = str_replace('***ORDER_CLAUSE***', $this->definition['order clause'], $this->basic_query);
}
// Look at the options set for this handler.
$depth = $this->options['depth'];
$descendants_method = $this->options['descendants'];
// Depth of 0 is the same as 'single'.
if ($depth === 0) {
$descendants_method = 'single';
}
// Add our WHERE clause.
switch ($descendants_method) {
// Plain: only consider this gallery.
// Recursive: only consider this gallery (we'll recurse later).
case 'single':
case 'recurse':
$where_clause = "tn.tid = {$tid} ";
$query = str_replace('***WHERE_CLAUSE***', $where_clause, $this->basic_query);
break;
// Flat: all descendant galleries considered for the cover query.
case 'flat':
if ($depth == 'all') {
$tree = taxonomy_get_tree($this->vid, $tid);
}
else {
$tree = taxonomy_get_tree($this->vid, $tid, -1, $depth);
}
$descendant_tids = array_merge(array(
$tid,
), array_map('_taxonomy_get_tid_from_term', $tree));
// The values of $descendant_tids should be safe for raw inclusion in the
// SQL since they're all loaded from integer fields in the database.
$where_clause = 'tn.tid IN (' . implode(',', $descendant_tids) . ')';
$query = str_replace('***WHERE_CLAUSE***', $where_clause, $this->basic_query);
break;
}
// Run the query to get the cover nid.
if ($nid = db_result(db_query_range(db_rewrite_sql($query), '', 0, 1))) {
return $nid;
}
// We have no nid: the gallery is empty. Go into descendant galleries if the
// recurse option is set.
if ($this->options['descendants'] == 'recurse' && $this->options['depth'] > 0) {
$nid = $this
->get_cover_node_nid_recurse($tid, 1);
return $nid;
}
}
/**
* Recursively query descendant tids until we get a cover nid.
*
* Warning! This is probably quite intensive, as it drills down the term
* hierarchy doing a query on each term until it finds a node -- and this is
* done for EVERY row of the main gallery term view!
*
* @param $tid The tid whose children we should investigate for a cover nid.
* @param $recurse The current recursion depth.
*/
function get_cover_node_nid_recurse($tid, $recurse) {
$tree = taxonomy_get_tree($this->vid, $tid, -1, 1);
foreach ($tree as $term) {
$where_clause = 'tn.tid = ' . $term->tid;
$query = str_replace('***WHERE_CLAUSE***', $where_clause, $this->basic_query);
if ($nid = db_result(db_query_range(db_rewrite_sql($query), '', 0, 1))) {
return $nid;
}
// Recurse into this gallery, if we may.
if ($this->options['depth'] > $recurse) {
if ($nid = $this
->get_cover_node_nid_recurse($term->tid, $recurse + 1)) {
return $nid;
}
}
}
}
/**
* The query this handler should use to gets its cover node id, unless
* the field definition specifies one.
*
* The return string should include a placeholder for the WHERE clause
* as in this basic case. This is where the tid(s) will go.
* The order clause should be supplied by the handler definition.
* Warning: this is NOT sophisticated stuff. The WHERE clause inserted into
* this string will expect to find a row "tn.tid" in the query.
*/
function get_cover_node_nid_query() {
return 'SELECT n.nid from {node} n INNER JOIN {term_node} tn ON n.nid = tn.nid ' . "WHERE ***WHERE_CLAUSE*** AND n.type = 'image' AND n.status = 1 " . 'ORDER BY ***ORDER_CLAUSE***';
}
/**
* Override query() so we don't query: fake field.
*/
function query() {
$this
->ensure_my_table();
$this
->add_additional_fields();
}
/**
* Returns field html. Just a dummy to inherit.
*/
function render($values) {
$nid = $this
->get_cover_node_nid($values);
return $nid;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
image_gallery_handler_field_gallery_cover:: |
function |
Constructor to provide additional fields to add. Overrides views_handler_field_taxonomy:: |
||
image_gallery_handler_field_gallery_cover:: |
function | Get the cover nid for the current tid. | ||
image_gallery_handler_field_gallery_cover:: |
function | The query this handler should use to gets its cover node id, unless the field definition specifies one. | ||
image_gallery_handler_field_gallery_cover:: |
function | Recursively query descendant tids until we get a cover nid. | ||
image_gallery_handler_field_gallery_cover:: |
function |
Init the handler with necessary data. Overrides views_handler_field:: |
||
image_gallery_handler_field_gallery_cover:: |
function |
Provide link to taxonomy option. Overrides views_handler_field_taxonomy:: |
2 | |
image_gallery_handler_field_gallery_cover:: |
function |
Information about options for all kinds of purposes will be held here. Overrides views_handler_field_taxonomy:: |
1 | |
image_gallery_handler_field_gallery_cover:: |
function |
Override query() so we don't query: fake field. Overrides views_handler_field:: |
||
image_gallery_handler_field_gallery_cover:: |
function |
Returns field html. Just a dummy to inherit. Overrides views_handler_field_taxonomy:: |
2 | |
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 | 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 | Get the value that's supposed to be rendered. | 3 |
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_handler_field_taxonomy:: |
public | function | Render whatever the data is as a link to the taxonomy. | |
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 |