class freepager_plugin_display_pagerblock in Free pager 7.2
The plugin that handles a block.
Hierarchy
- class \views_object
- class \views_plugin
- class \views_plugin_display
- class \views_plugin
Expanded class hierarchy of freepager_plugin_display_pagerblock
1 string reference to 'freepager_plugin_display_pagerblock'
- freepager_views_plugins in ./
freepager.views.inc - Declares the pager block display.
File
- ./
freepager_plugin_display_pagerblock.inc, line 12 - Contains the block display plugin.
View source
class freepager_plugin_display_pagerblock extends views_plugin_display_block {
function option_definition() {
$options = parent::option_definition();
foreach (array_keys(freepager_settings()) as $setting_name) {
$options[$setting_name] = array(
'default' => FALSE,
);
}
return $options;
}
/**
* Provide the summary for page options in the views UI.
*
* This output is returned as an array.
*/
function options_summary(&$categories, &$options) {
// It is very important to call the parent function here:
parent::options_summary($categories, $options);
// Remove the category set by the parent class before adding our own.
unset($categories['block']);
$categories['freepager_block'] = array(
'title' => t('Pager block settings'),
'column' => 'second',
'build' => array(
'#weight' => -10,
),
);
$options['block_description']['category'] = 'freepager_block';
// Get all the fields present in this view, to use as setting summaries.
$field_labels = $this
->get_field_labels();
foreach (freepager_settings() as $name => $setting) {
$options[$name] = array(
'category' => 'freepager_block',
'title' => $setting['label'],
'value' => isset($field_labels[$this
->get_option($name)]) ? $field_labels[$this
->get_option($name)] : t('(none)'),
);
}
// The 'loop' option is treated differently. It isn't a field select list.
$yesno = array(
0 => t('no'),
1 => t('yes'),
);
$options['loop']['value'] = $yesno[$this
->get_option($name)];
}
/**
* Provide the default form for setting options.
*/
function options_form(&$form, &$form_state) {
// It is very important to call the parent function here:
parent::options_form($form, $form_state);
// Set some variables to increase code readability.
$freepager_settings = freepager_settings();
$section =& $form_state['section'];
// If one of Free pager's settings are built, populate the form.
if (isset($freepager_settings[$section])) {
$form['#title'] .= $freepager_settings[$section]['label'];
$form[$section] = array(
'#type' => 'select',
'#description' => $freepager_settings[$section]['description'],
'#options' => array(
FALSE => t('(none)'),
) + $this
->get_field_labels(),
'#default_value' => $this
->get_option($section),
);
// The 'loop' setting should be treated differently. It's a check box.
if ($section == 'loop') {
$form[$section] = array(
'#type' => 'checkbox',
'#title' => $freepager_settings['loop']['label'],
'#description' => $freepager_settings[$section]['description'],
'#default_value' => $this
->get_option($section),
);
}
}
}
/**
* Perform any necessary changes to the form values prior to storage.
* There is no need for this function to actually store the data.
*/
function options_submit(&$form, &$form_state) {
// It is very important to call the parent function here:
parent::options_submit($form, $form_state);
// Set some variables to increase code readability.
$freepager_settings = freepager_settings();
$section =& $form_state['section'];
// If one of Free pager's settings are submitted, make sure to save them.
if (isset($freepager_settings[$section])) {
$this
->set_option($section, $form_state['values'][$section]);
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
freepager_plugin_display_pagerblock:: |
function |
Provide the default form for setting options. Overrides views_plugin_display_block:: |
||
freepager_plugin_display_pagerblock:: |
function |
Perform any necessary changes to the form values prior to storage.
There is no need for this function to actually store the data. Overrides views_plugin_display_block:: |
||
freepager_plugin_display_pagerblock:: |
function |
Provide the summary for page options in the views UI. Overrides views_plugin_display_block:: |
||
freepager_plugin_display_pagerblock:: |
function |
Information about options for all kinds of purposes will be held here. Overrides views_plugin_display_block:: |
||
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 | Views handlers use a special construct function. | 4 |
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 | ||
views_plugin:: |
public | property | The current used views display. | |
views_plugin:: |
public | property | The plugin name of this plugin, for example table or full. | |
views_plugin:: |
public | property | The plugin type of this plugin, for example style or query. | |
views_plugin:: |
public | function | Provide a list of additional theme functions for the theme info page. | |
views_plugin:: |
public | function | Return the human readable name of the display. | |
views_plugin:: |
public | function | Returns the summary of the settings in the display. | 8 |
views_plugin:: |
public | function | Provide a full list of possible theme templates used by this style. | |
views_plugin_display:: |
public | property | Stores all available display extenders. | |
views_plugin_display:: |
public | property | List of handlers for this display. | |
views_plugin_display:: |
public | property |
The top object of a view. Overrides views_plugin:: |
|
views_plugin_display:: |
public | function | Can this display accept attachments? | |
views_plugin_display:: |
public | function | Determine if the user has access to this display of the view. | |
views_plugin_display:: |
public | function | Allow displays to attach to other views. | 2 |
views_plugin_display:: |
public | function | List which sections are defaultable and what items each section contains. | 1 |
views_plugin_display:: |
public | function |
Destructor. Overrides views_object:: |
|
views_plugin_display:: |
public | function | Determine if this display should display the exposed filters widgets. | 1 |
views_plugin_display:: |
public | function | Special method to export items that have handlers. | |
views_plugin_display:: |
public | function |
Override of export_option() Overrides views_object:: |
|
views_plugin_display:: |
public | function | Special handling for plugin export. | |
views_plugin_display:: |
public | function | Special handling for the style export. | |
views_plugin_display:: |
public | function | Format a list of theme templates for output by the theme info helper. | |
views_plugin_display:: |
public | function | Returns to tokens for arguments. | |
views_plugin_display:: |
public | function | Provide some helpful text for the arguments. | 1 |
views_plugin_display:: |
public | function | List of fields for the current display with the associated relationship. | |
views_plugin_display:: |
public | function | Get the handler object for a single handler. | |
views_plugin_display:: |
public | function | Get a full array of handlers for $type. This caches them. | |
views_plugin_display:: |
public | function | Check to see which display to use when creating links. | |
views_plugin_display:: |
public | function | Intelligently get an option either from this or default display. | |
views_plugin_display:: |
public | function | Provide some helpful text for pagers. | 1 |
views_plugin_display:: |
public | function | Return the base path to use for this display. | |
views_plugin_display:: |
public | function | Get the instance of a plugin, for example style or row. | |
views_plugin_display:: |
public | function | Provide the block system with any exposed widget blocks for this display. | |
views_plugin_display:: |
public | function | Displays can require a certain type of style plugin. | 1 |
views_plugin_display:: |
public | function | ||
views_plugin_display:: |
public | function | Check to see if the display has a 'path' field. | 1 |
views_plugin_display:: |
public | function | If this display creates a block, implement one of these. | |
views_plugin_display:: |
public | function | If this display creates a page with a menu item, implement it here. | |
views_plugin_display:: |
public | function | 1 | |
views_plugin_display:: |
public | function | Determine if a given option is set to use the default or current display. | |
views_plugin_display:: |
public | function | If this display is the 'default' display which contains fallback settings. | 1 |
views_plugin_display:: |
public | function | Check if the provided identifier is unique. | |
views_plugin_display:: |
public | function | If override/revert was clicked, perform the proper toggle. | |
views_plugin_display:: |
public | function |
Validate the options form. Overrides views_plugin:: |
1 |
views_plugin_display:: |
public | function | Because forms may be split up into sections, this provides an easy URL to exactly the right section. Don't override this. | |
views_plugin_display:: |
public | function | Set an option and force it to be an override. | |
views_plugin_display:: |
public | function | Fully render the display. | 1 |
views_plugin_display:: |
public | function | Set up any variables on the view prior to execution. | |
views_plugin_display:: |
public | function |
Inject anything into the query that the display handler needs. Overrides views_plugin:: |
|
views_plugin_display:: |
public | function | Render this display. | 1 |
views_plugin_display:: |
public | function | ||
views_plugin_display:: |
public | function | ||
views_plugin_display:: |
public | function | Not all display plugins will support filtering. | |
views_plugin_display:: |
public | function | Render the footer of the view. | |
views_plugin_display:: |
public | function | Render the header of the view. | |
views_plugin_display:: |
public | function | Render the 'more' link. | |
views_plugin_display:: |
public | function | Not all display plugins will suppert pager rendering. | 1 |
views_plugin_display:: |
public | function | Intelligently set an option either from this display or from the default display, if directed to do so. | |
views_plugin_display:: |
public | function | Flip the override setting for the given section. | |
views_plugin_display:: |
public | function | Special method to unpack items that have handlers. | |
views_plugin_display:: |
public | function | Special handling for plugin unpacking. | |
views_plugin_display:: |
public | function | ||
views_plugin_display:: |
public | function | Check to see if the display needs a breadcrumb. | 1 |
views_plugin_display:: |
public | function | Check to see if the display can put the exposed form in a block. | |
views_plugin_display:: |
public | function | Determine if the display's style uses fields. | |
views_plugin_display:: |
public | function | Check to see if the display has some need to link to another display. | 1 |
views_plugin_display:: |
public | function | Does the display use AJAX? | |
views_plugin_display:: |
public | function | Does the display have groupby enabled? | |
views_plugin_display:: |
public | function | Does the display have a more link enabled? | |
views_plugin_display:: |
public | function | Should the enabled display more link be shown when no more items? | |
views_plugin_display:: |
public | function | Should the enabled display more link being opened in an new window? | |
views_plugin_display:: |
public | function | Does the display have custom link text? | |
views_plugin_display:: |
public | function | Does the display have a pager enabled? | 1 |
views_plugin_display:: |
public | function |
Make sure the display and all associated handlers are valid. Overrides views_plugin:: |
1 |
views_plugin_display:: |
public | function | Render any special blocks provided for this display. | |
views_plugin_display_block:: |
public | function | Provide a list of core's block caching modes. | |
views_plugin_display_block:: |
public | function |
The display block handler returns the structure necessary for a block. Overrides views_plugin_display:: |
|
views_plugin_display_block:: |
public | function | The default block handler doesn't support configurable items, but extended block handlers might be able to do interesting stuff with it. | |
views_plugin_display_block:: |
public | function | Provide a single method to figure caching type, keeping a sensible default for when it's unset. | |
views_plugin_display_block:: |
public | function | Save the block cache setting in the blocks table if this block already exists in the blocks table. Dirty fix until http://drupal.org/node/235673 gets in. | |
views_plugin_display_block:: |
public | function | Update the block delta when the machine name of the display changes. | |
views_plugin_display_block:: |
public | function |
Block views use exposed widgets only if AJAX is set. Overrides views_plugin_display:: |