class sna_blocks_plugin_style_snablocks in Simple Node Archive Blocks 7.2

Style plugin to render simple node archive.

Hierarchy

class \views_object
- class \views_plugin
  - class \views_plugin_style
    class \sna_blocks_plugin_style_snablocks

Expanded class hierarchy of sna_blocks_plugin_style_snablocks

1 string reference to 'sna_blocks_plugin_style_snablocks'

sna_blocks_views_plugins in ./sna_blocks.views.inc: Implements hook_views_plugins().

File

./sna_blocks_plugin_style_snablocks.inc, line 12: Contains the list style plugin.

View source

class sna_blocks_plugin_style_snablocks extends views_plugin_style {

  // Set default options.
  function option_definition() {
    $options = parent::option_definition();
    $options['field_name'] = array(
      'default' => '',
    );
    $options['sna_view_name'] = array(
      'default' => '',
    );
    $options['sna_view_display_id'] = array(
      'default' => '',
    );
    $options['sna_view_page_url'] = array(
      'default' => '',
    );
    $options['sna_use_jquery'] = array(
      'default' => '',
    );
    return $options;
  }

  // Build the settings form for the view.
  function options_form(&$form, &$form_state) {

    // Wrap all the form elements to help style the form.
    $form['sna_blocks_wrapper'] = array(
      '#markup' => '<div id="sna-blocks-form-wrapper"><b>Note:</b> As the archive settings for each block is unique. It is recommended to override view "Block: Style options" for blocks.',
    );

    // Set Default value for field_name.
    $disabled_field_name = TRUE;
    $default_field_name = 'node_created';
    if (module_exists('date')) {
      $disabled_field_name = FALSE;
      $default_field_name = $this->options['field_name'] ? $this->options['field_name'] : 'node_created';
    }
    $form['field_name'] = array(
      '#type' => 'textfield',
      '#title' => t('Archived date field machine name'),
      '#default_value' => $default_field_name,
      '#size' => 60,
      '#maxlength' => 128,
      '#required' => TRUE,
      '#disabled' => $disabled_field_name,
      '#description' => t('Achived block will created based on this field. Default value is node posted date "node_created". For custom field use <a href="http://drupal.org/project/date" target="_blank">Date module</a> and provide field machine name here. You have to add the field to views "FIELDS" list.'),
    );
    $form['sna_view_name'] = array(
      '#type' => 'textfield',
      '#title' => t('View machine name'),
      '#default_value' => $this->options['sna_view_name'] ? $this->options['sna_view_name'] : '',
      '#size' => 60,
      '#maxlength' => 128,
      '#required' => TRUE,
      '#description' => t('The machine name of the view whose page is used to display archive result.'),
      '#prefix' => '<br>A view page is required to display achive result. You need to create a page and then use below setting for page.<hr>',
    );
    $form['sna_view_display_id'] = array(
      '#type' => 'textfield',
      '#title' => t('View page display id.'),
      '#default_value' => $this->options['sna_view_display_id'] ? $this->options['sna_view_display_id'] : '',
      '#size' => 60,
      '#maxlength' => 128,
      '#required' => TRUE,
      '#description' => t('The view page display id, e.g. page_1'),
    );
    $form['sna_view_page_url'] = array(
      '#type' => 'textfield',
      '#title' => t('View page display URL.'),
      '#default_value' => $this->options['sna_view_page_url'] ? $this->options['sna_view_page_url'] : '',
      '#size' => 60,
      '#maxlength' => 128,
      '#required' => TRUE,
      '#description' => t('View page path.'),
    );
    $disabled_jquerymenu_option = TRUE;
    if (module_exists('jquerymenu')) {
      $disabled_jquerymenu_option = FALSE;
    }
    $form['sna_use_jquery'] = array(
      '#type' => 'checkbox',
      '#default_value' => $this->options['sna_use_jquery'] ? $this->options['sna_use_jquery'] : 0,
      '#title' => t('check this box if you want to use <a href="http://drupal.org/project/jquerymenu" target="_blank">Jquerymenu module </a> to theme archive block.'),
      '#disabled' => $disabled_jquerymenu_option,
      '#prefix' => '<br><b>Theme archive block:</b> <hr>',
    );

    // Wrapper close.
    $form['sna_blocks_wrapper_close'] = array(
      '#markup' => '</div>',
    );
  }

  // Run validation on the form settings.
  function options_validate(&$form, &$form_state) {
    $view_name = $form_state['values']['style_options']['sna_view_name'];
    $display_id = $form_state['values']['style_options']['sna_view_display_id'];
    $vid = $form_state['view']->vid;
    $view_display_id = $form_state['display_id'];
    try {
      $view = views_get_view($view_name);
      if (isset($view->display[$display_id]) && $view->display[$display_id]->display_plugin == 'page') {
        $style_options = sna_blocks_get_view_style_options($view_name, $display_id);
        if (!empty($style_options['vid']) && !($vid == $style_options['vid'] && $view_display_id == $style_options['id'])) {
          form_set_error('sna_view_display_id', t('Page is already in use!'));
        }
      }
      else {
        form_set_error('sna_view_display_id', t('Invalid view name or display_id.'));
      }
    } catch (Exception $e) {
      drupal_set_message($e
        ->getMessage());
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
sna_blocks_plugin_style_snablocks::options_form		function	Provide a form to edit options for this plugin. Overrides views_plugin_style::options_form
sna_blocks_plugin_style_snablocks::options_validate		function	Validate the options form. Overrides views_plugin_style::options_validate
sna_blocks_plugin_style_snablocks::option_definition		function	Information about options for all kinds of purposes will be held here. Overrides views_plugin_style::option_definition
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::altered_option_definition		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::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::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
views_plugin::$display	public	property	The current used views display.
views_plugin::$plugin_name	public	property	The plugin name of this plugin, for example table or full.
views_plugin::$plugin_type	public	property	The plugin type of this plugin, for example style or query.
views_plugin::$view	public	property	The top object of a view. Overrides views_object::$view	1
views_plugin::additional_theme_functions	public	function	Provide a list of additional theme functions for the theme info page.
views_plugin::options_submit	public	function	Handle any special handling on the validate form.	9
views_plugin::plugin_title	public	function	Return the human readable name of the display.
views_plugin::summary_title	public	function	Returns the summary of the settings in the display.	8
views_plugin::theme_functions	public	function	Provide a full list of possible theme templates used by this style.
views_plugin_style::$row_plugin	public	property	The row plugin, if it's initialized and the style itself supports it.
views_plugin_style::$row_tokens	public	property	Store all available tokens row rows.
views_plugin_style::build_sort	public	function	Called by the view builder to see if this style handler wants to interfere with the sorts. If so it should build; if it returns any non-TRUE value, normal sorting will NOT be added to the query.	1
views_plugin_style::build_sort_post	public	function	Called by the view builder to let the style build a second set of sorts that will come after any other sorts in the view.	1
views_plugin_style::destroy	public	function	Destructor. Overrides views_object::destroy
views_plugin_style::even_empty	public	function	Should the output of the style plugin be rendered even if it's empty.	1
views_plugin_style::get_field	public	function	Get a rendered field.
views_plugin_style::get_field_value	public	function	Get the raw field value.
views_plugin_style::get_row_class	public	function	Return the token replaced row class for the specified row.
views_plugin_style::init	public	function	Initialize a style plugin.
views_plugin_style::pre_render	public	function	Allow the style to do stuff before each row is rendered.
views_plugin_style::query	public	function	Add anything to the query that we might need to. Overrides views_plugin::query	2
views_plugin_style::render	public	function	Render the display in this style.	5
views_plugin_style::render_fields	public	function	Render all of the fields for a given style and store them on the object.
views_plugin_style::render_grouping	public	function	Group records as needed for rendering.
views_plugin_style::render_grouping_sets	public	function	Render the grouping sets.
views_plugin_style::tokenize_value	public	function	Take a value and apply token replacement logic to it.
views_plugin_style::uses_fields	public	function	Return TRUE if this style also uses fields.
views_plugin_style::uses_row_class	public	function	Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_row_plugin	public	function	Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_tokens	public	function	Return TRUE if this style uses tokens.
views_plugin_style::validate	public	function	Validate that the plugin is correct and can be saved. Overrides views_plugin::validate

You are here

class sna_blocks_plugin_style_snablocks in Simple Node Archive Blocks 7.2

Hierarchy

File

Members

API Navigation