You are here

Home » API reference » Bibliography Module 7.2 » biblio_plugin_row_citation.inc

class biblio_plugin_row_citation in Bibliography Module 7.2

Hierarchy

Expanded class hierarchy of biblio_plugin_row_citation

File

views/biblio_plugin_row_citation.inc, line 2

View source 
class biblio_plugin_row_citation extends views_plugin_row {

  // Basic properties that let the row style follow relationships.
  var $base_table = 'biblio';
  var $base_field = 'bid';

  // Stores the nodes loaded with pre_render.
  var $nodes = array();
  function option_definition() {
    $options = parent::option_definition();
    $options['style_name'] = array(
      'default' => biblio_get_style(),
    );
    $options['export_links'] = array(
      'default' => 1,
    );
    $options['file_attachments'] = array(
      'default' => 1,
    );
    $options['open_url_link'] = array(
      'default' => 1,
    );
    return $options;
  }
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['style_name'] = array(
      '#type' => 'select',
      '#title' => t('Style'),
      '#default_value' => $this->options['style_name'],
      '#options' => biblio_get_styles(),
      '#description' => t('Define the layout of citation.'),
    );
    $form['export_links'] = array(
      '#type' => 'checkbox',
      '#title' => t('Show export links'),
      '#default_value' => $this->options['export_links'],
      '#description' => t('This will add a set of links to export the entry in various file formats such as Bibtex or RIS.'),
    );
    $form['file_attachments'] = array(
      '#type' => 'checkbox',
      '#title' => t('Show download links for file attachments'),
      '#default_value' => $this->options['file_attachments'],
      '#description' => t('If there are files attached to the entry, this will add a download link for each file attached.'),
    );
    $form['open_url_link'] = array(
      '#type' => 'checkbox',
      '#title' => t('Show OpenURL Links'),
      '#default_value' => $this->options['open_url_link'],
      '#description' => t('This will add an !openurl link to the entry, assuming you have competed the OpenURL configuration on the Biblio !settings page.', array(
        '!openurl' => l('OpenURL', "http://en.wikipedia.org/wiki/OpenURL"),
        '!settings' => l('settings', 'admin/config/content/biblio'),
      )),
    );
  }
  function pre_render($values) {
    $nids = array();
    foreach ($values as $row) {
      $nids[] = $row->{$this->field_alias};
    }
    $this->nodes = node_load_multiple($nids);
    $langcode = $GLOBALS['language_content']->language;
    field_attach_prepare_view('node', $this->nodes, 'full', $langcode);
    entity_prepare_view('node', $this->nodes, $langcode);
  }
  function render($row) {
    $output = '';
    $item = $this->nodes[$row->{$this->field_alias}];
    if (empty($this->biblio_base)) {
      $this->biblio_base = variable_get('biblio_base', 'biblio');
    }
    if ($item->type != 'biblio') {
      return;
    }
    if (isset($item->biblio_year)) {
      $item->biblio_year = _biblio_text_year($item->biblio_year);
    }
    if (variable_get('biblio_hide_bibtex_braces', 0)) {
      $item->title = biblio_remove_brace($item->title);
    }
    if (!$item->status) {
      $output .= '<div id="node-' . $item->nid . '" class="node node-unpublished">';
    }

    // first add the styled entry...
    $output .= theme('biblio_style', array(
      'node' => $item,
      'style_name' => $this->options['style_name'],
    ));
    $annotation_field = variable_get('biblio_annotations', 'none');
    if ($annotation_field != 'none' && $item->{$annotation_field}) {
      $output .= '<div class="biblio-annotation">';
      $output .= filter_xss($item->{$annotation_field}, biblio_get_allowed_tags());
      $output .= '</div>';
    }
    $openurl_base = variable_get('biblio_baseopenurl', '');
    if (!empty($openurl_base) && $this->options['open_url_link']) {
      $output .= theme('biblio_openurl', array(
        'openURL' => biblio_openurl($item),
      ));
    }
    if (biblio_access('export') && $this->options['export_links']) {
      $output .= theme('biblio_export_links', array(
        'node' => $item,
      ));
    }
    if (biblio_access('download', $item) && $this->options['file_attachments']) {
      $output .= theme('biblio_download_links', array(
        'node' => $item,
      ));
    }
    if (!$item->status) {
      $output .= '</div>';
    }
    return $output;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
biblio_plugin_row_citation::$base_field property
biblio_plugin_row_citation::$base_table property
biblio_plugin_row_citation::$nodes property
biblio_plugin_row_citation::options_form function Provide a form for setting options. Overrides views_plugin_row::options_form
biblio_plugin_row_citation::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_plugin_row::option_definition
biblio_plugin_row_citation::pre_render function Allow the style to do stuff before each row is rendered. Overrides views_plugin_row::pre_render
biblio_plugin_row_citation::render function Render a row object. This usually passes through to a theme template of some form, but not always. Overrides views_plugin_row::render
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::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::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::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::validate public function Validate that the plugin is correct and can be saved. 3
views_plugin_row::init public function 2
views_plugin_row::options_submit 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. Overrides views_plugin::options_submit 1
views_plugin_row::options_validate public function Validate the options form. Overrides views_plugin::options_validate
views_plugin_row::query public function Add anything to the query that we might need to. Overrides views_plugin::query
views_plugin_row::uses_fields public function