You are here

Home » API reference » Bibliography Module 7 » biblio_handler_field_contributor.inc

class biblio_handler_field_contributor in Bibliography Module 7

Same name and namespace in other branches
  1. 6.2 views/biblio_handler_field_contributor.inc \biblio_handler_field_contributor
  2. 6 views/biblio_handler_field_contributor.inc \biblio_handler_field_contributor
  3. 7.2 views/biblio_handler_field_contributor.inc \biblio_handler_field_contributor

Hierarchy

Expanded class hierarchy of biblio_handler_field_contributor

1 string reference to 'biblio_handler_field_contributor'
biblio_views_data in views/biblio.views.inc
Implementation of hook_views_data().

File

views/biblio_handler_field_contributor.inc, line 6

View source 
class biblio_handler_field_contributor extends biblio_handler_field {

  /**
   *
   */
  public function init(&$view, &$options) {
    module_load_include('inc', 'biblio', 'includes/biblio.contributors');
    parent::init($view, $options);
    $this->multiple = TRUE;
    $this->additional_fields['vid'] = array(
      'table' => 'biblio',
      'field' => 'vid',
    );
  }

  /**
   *
   */
  public function option_definition() {
    $options = parent::option_definition();
    $options['auth_category'] = array(
      'default' => 1,
    );
    $options['auth_links'] = array(
      'default' => 0,
    );
    $options['initialize'] = array(
      'default' => TRUE,
    );
    $options['initialize_with'] = array(
      'default' => '.',
    );
    $options['initialize_with_hyphen'] = array(
      'default' => FALSE,
    );
    $options['separator'] = array(
      'default' => '; ',
    );
    $options['sort_separator'] = array(
      'default' => ', ',
    );
    $options['short_form'] = array(
      'default' => 0,
    );
    $options['name_order'] = array(
      'default' => 'first-last',
    );
    return $options;
  }

  /**
   *
   */
  public function options_form(&$form, &$form_state) {
    $form['auth_category'] = array(
      '#type' => 'select',
      '#title' => t('Category of Author'),
      '#default_value' => $this->options['auth_category'],
      '#options' => array(
        0 => t('All categories'),
        1 => t('Primary'),
        2 => t('Secondary'),
        3 => t('Tertiary'),
        4 => t('Subsidiary'),
        5 => t('Corporate/Institutional'),
      ),
    );
    $form['formatting'] = array(
      '#type' => 'fieldset',
      '#title' => t('Author format'),
      '#collapsible' => TRUE,
    );
    $form['name_order'] = array(
      '#type' => 'select',
      '#title' => t('Name order'),
      '#default_value' => $this->options['name_order'],
      '#options' => array(
        'first-last' => t('First name first'),
        'last-first' => t('Last name first'),
      ),
      '#description' => t('The order that first and last names appear for each author.'),
      '#fieldset' => 'formatting',
    );
    $form['initialize'] = array(
      '#type' => 'checkbox',
      '#title' => t('Shorten given names'),
      '#default_value' => $this->options['initialize'],
      '#description' => t('Shorten given names to single initial each.'),
      '#fieldset' => 'formatting',
    );
    $form['short_form'] = array(
      '#type' => 'checkbox',
      '#title' => t('Show only "family" names'),
      '#default_value' => $this->options['short_form'],
      '#description' => t('Show only family name, no first name or initials.'),
      '#fieldset' => 'formatting',
    );
    $form['separators'] = array(
      '#type' => 'fieldset',
      '#title' => t('Separators'),
      '#collapsible' => TRUE,
    );
    $form['initialize_with'] = array(
      '#type' => 'textfield',
      '#size' => 5,
      '#title' => t('Initial separator'),
      '#default_value' => $this->options['initialize_with'],
      '#description' => t('Enter the character (if any) which will be used to separate the initials.'),
      '#fieldset' => 'separators',
    );
    $form['sort_separator'] = array(
      '#type' => 'textfield',
      '#size' => 5,
      '#title' => t('Sort separator'),
      '#default_value' => $this->options['sort_separator'],
      '#description' => t('Enter the character which will be used to separate the last name from the first name (or initials) when displayed last name first (Smith, John).'),
      '#fieldset' => 'separators',
    );
    $form['separator'] = array(
      '#type' => 'textfield',
      '#size' => 5,
      '#title' => t('Author separator'),
      '#default_value' => $this->options['separator'],
      '#required' => TRUE,
      '#description' => t('Enter the character which will be used to separate the authors (Smith, John; Doe, Jane).'),
      '#fieldset' => 'separators',
    );
    parent::options_form($form, $form_state);
  }

  /**
   *
   */
  public function query() {
    $this
      ->add_additional_fields();
    $this->field_alias = $this->aliases['vid'];
  }

  /**
   *
   */
  public function post_execute(&$values) {
    $vids = array();
    $this->items = array();
    $filter = '';
    foreach ($values as $result) {

      // Don't add empty results to the array.
      if (isset($this->aliases['vid']) && !empty($result->{$this->aliases['vid']})) {
        $vids[] = $result->{$this->aliases['vid']};
      }
    }
    if (count($vids)) {
      $this->items = biblio_load_contributors_multiple($vids, $this->options['auth_category']);
    }
  }

  /**
   *
   */
  public function render($values) {
    parent::set_label($values);
    $vid = $values->{$this->field_alias};
    if (!isset($this->items[$vid])) {
      return NULL;
    }
    return $this
      ->render_contriubutors($this->items[$vid]);
  }

  /**
   *
   */
  public function render_contriubutors($contributors) {
    $authors = array();
    if (!isset($this->alnum)) {
      list($this->alnum, $this->alpha, $this->cntrl, $this->dash, $this->digit, $this->graph, $this->lower, $this->print, $this->punct, $this->space, $this->upper, $this->word, $this->patternModifiers) = $this
        ->get_regex_patterns();
    }
    foreach ($contributors as $rank => $author) {
      $author = (object) $author;
      if ($author->literal == 1) {
        $authors[] = $author->name;
      }
      else {
        if (!empty($author->firstname) && $this->options['initialize'] == 1) {
          $author->firstname = preg_replace("/([{$this->upper}])[{$this->lower}]+/{$this->patternModifiers}", '\\1', $author->firstname);
          $author->firstname = preg_replace("/(?<=[-{$this->upper}]) +(?=[-{$this->upper}])/{$this->patternModifiers}", "", $author->firstname);
          $author->initials = $author->firstname . $author->initials;
        }
        if (isset($author->initials)) {

          // Within initials, remove any dots:
          $author->initials = preg_replace("/([{$this->upper}])\\.+/{$this->patternModifiers}", "\\1", $author->initials);

          // Within initials, remove any spaces *between* initials:
          $author->initials = preg_replace("/(?<=[-{$this->upper}]) +(?=[-{$this->upper}])/{$this->patternModifiers}", "", $author->initials);
          if ($this->options['initialize_with_hyphen'] === FALSE) {
            $author->initials = preg_replace("/-/", '', $author->initials);
          }

          // Within initials, add a space after a hyphen, but only if ...
          // ... the delimiter that separates initials ends with a space.
          if (preg_match("/ \$/", $this->options['initialize_with'])) {
            $author->initials = preg_replace("/-(?=[{$this->upper}])/{$this->patternModifiers}", "- ", $author->initials);
          }

          // then, separate initials with the specified delimiter:
          $init_sep = $this->options['initialize_with'];
          $author->initials = preg_replace("/([{$this->upper}])(?=[^{$this->lower}]+|\$)/{$this->patternModifiers}", "\\1{$init_sep}", $author->initials);

          // $shortenInitials = (isset($options['numberOfInitialsToKeep)) ? $options['numberOfInitialsToKeep : FALSE;
          //      if ($shortenInitials) $given = drupal_substr($given, 0, $shortenInitials);.
          if ($this->options['initialize'] == 1) {
            $author->firstname = $author->initials;

            // If ($shortenInitials) $author->firstname = drupal_substr($author->firstname, 0, $shortenInitials);.
          }
          elseif (!empty($author->firstname)) {
            $author->firstname = $author->firstname . ' ' . $author->initials;
          }
          elseif (empty($author->firstname)) {
            $author->firstname = $author->initials;
          }
        }
        if (isset($author->lastname)) {
          if ($this->options['short_form'] == 1) {
            $authors[] = $author->lastname;
          }
          else {
            switch ($this->options['name_order']) {
              case 'last-first':
                $authors[] = $author->lastname . $this->options['sort_separator'] . $author->firstname;
                break;
              default:
                $authors[] = $author->firstname . ' ' . $author->lastname;
            }
          }
        }
      }
    }
    return implode($this->options['separator'], $authors);
  }

  /**
   *
   */
  public function get_regex_patterns() {

    // Checks if PCRE is compiled with UTF-8 and Unicode support.
    if (!@preg_match('/\\pL/u', 'a')) {

      // Probably a broken PCRE library.
      return $this
        ->get_latin1_regex();
    }
    else {

      // Unicode safe filter for the value.
      return $this
        ->get_utf8_regex();
    }
  }

  /**
   *
   */
  public function get_latin1_regex() {
    $alnum = "[:alnum:]ÄÅÁÀÂÃÇÉÈÊËÑÖØÓÒÔÕÜÚÙÛÍÌÎÏÆäåáàâãçéèêëñöøóòôõüúùûíìîïæÿß";

    // Matches ISO-8859-1 letters:
    $alpha = "[:alpha:]ÄÅÁÀÂÃÇÉÈÊËÑÖØÓÒÔÕÜÚÙÛÍÌÎÏÆäåáàâãçéèêëñöøóòôõüúùûíìîïæÿß";

    // Matches ISO-8859-1 control characters:
    $cntrl = "[:cntrl:]";

    // Matches ISO-8859-1 dashes & hyphens:
    $dash = "-–";

    // Matches ISO-8859-1 digits:
    $digit = "[\\d]";

    // Matches ISO-8859-1 printing characters (excluding space):
    $graph = "[:graph:]ÄÅÁÀÂÃÇÉÈÊËÑÖØÓÒÔÕÜÚÙÛÍÌÎÏÆäåáàâãçéèêëñöøóòôõüúùûíìîïæÿß";

    // Matches ISO-8859-1 lower case letters:
    $lower = "[:lower:]äåáàâãçéèêëñöøóòôõüúùûíìîïæÿß";

    // Matches ISO-8859-1 printing characters (including space):
    $print = "[:print:]ÄÅÁÀÂÃÇÉÈÊËÑÖØÓÒÔÕÜÚÙÛÍÌÎÏÆäåáàâãçéèêëñöøóòôõüúùûíìîïæÿß";

    // Matches ISO-8859-1 punctuation:
    $punct = "[:punct:]";

    // Matches ISO-8859-1 whitespace (separating characters with no visual representation):
    $space = "[\\s]";

    // Matches ISO-8859-1 upper case letters:
    $upper = "[:upper:]ÄÅÁÀÂÃÇÉÈÊËÑÖØÓÒÔÕÜÚÙÛÍÌÎÏÆ";

    // Matches ISO-8859-1 "word" characters:
    $word = "_[:alnum:]ÄÅÁÀÂÃÇÉÈÊËÑÖØÓÒÔÕÜÚÙÛÍÌÎÏÆäåáàâãçéèêëñöøóòôõüúùûíìîïæÿß";

    // Defines the PCRE pattern modifier(s) to be used in conjunction with the above variables:
    // More info: <http://www.php.net/manual/en/reference.pcre.pattern.modifiers.php>
    $patternModifiers = "";
    return array(
      $alnum,
      $alpha,
      $cntrl,
      $dash,
      $digit,
      $graph,
      $lower,
      $print,
      $punct,
      $space,
      $upper,
      $word,
      $patternModifiers,
    );
  }

  /**
   *
   */
  public function get_utf8_regex() {

    // Matches Unicode letters & digits:
    // Unicode-aware equivalent of "[:alnum:]".
    $alnum = "\\p{Ll}\\p{Lu}\\p{Lt}\\p{Lo}\\p{Nd}";

    // Matches Unicode letters:
    // Unicode-aware equivalent of "[:alpha:]".
    $alpha = "\\p{Ll}\\p{Lu}\\p{Lt}\\p{Lo}";

    // Matches Unicode control codes & characters not in other categories:
    // Unicode-aware equivalent of "[:cntrl:]".
    $cntrl = "\\p{C}";

    // Matches Unicode dashes & hyphens:
    $dash = "\\p{Pd}";

    // Matches Unicode digits:
    // Unicode-aware equivalent of "[:digit:]".
    $digit = "\\p{Nd}";

    // Matches Unicode printing characters (excluding space):
    // Unicode-aware equivalent of "[:graph:]".
    $graph = "^\\p{C}\t\n\f\r\\p{Z}";

    // Matches Unicode lower case letters:
    // Unicode-aware equivalent of "[:lower:]".
    $lower = "\\p{Ll}\\p{M}";

    // Matches Unicode printing characters (including space):
    // same as "^\p{C}", Unicode-aware equivalent of "[:print:]".
    $print = "\\P{C}";

    // Matches Unicode punctuation (printing characters excluding letters & digits):
    // Unicode-aware equivalent of "[:punct:]".
    $punct = "\\p{P}";

    // Matches Unicode whitespace (separating characters with no visual representation):
    // Unicode-aware equivalent of "[:space:]".
    $space = "\t\n\f\r\\p{Z}";

    // Matches Unicode upper case letters:
    // Unicode-aware equivalent of "[:upper:]".
    $upper = "\\p{Lu}\\p{Lt}";

    // Matches Unicode "word" characters:
    // Unicode-aware equivalent of "[:word:]" (or "[:alnum:]" plus "_")
    $word = "_\\p{Ll}\\p{Lu}\\p{Lt}\\p{Lo}\\p{Nd}";

    // Defines the PCRE pattern modifier(s) to be used in conjunction with the above variables:
    // More info: <http://www.php.net/manual/en/reference.pcre.pattern.modifiers.php>
    // the "u" (PCRE_UTF8) pattern modifier causes PHP/PCRE to treat pattern strings as UTF-8.
    $patternModifiers = "u";
    return array(
      $alnum,
      $alpha,
      $cntrl,
      $dash,
      $digit,
      $graph,
      $lower,
      $print,
      $punct,
      $space,
      $upper,
      $word,
      $patternModifiers,
    );
  }

}

Members

Namesort descending Modifiers Type Description Overrides
biblio_handler_field::pre_render public function Run before any fields are rendered. Overrides views_handler_field::pre_render
biblio_handler_field::set_label public function
biblio_handler_field_contributor::get_latin1_regex public function
biblio_handler_field_contributor::get_regex_patterns public function
biblio_handler_field_contributor::get_utf8_regex public function
biblio_handler_field_contributor::init public function Init the handler with necessary data. Overrides biblio_handler_field::init
biblio_handler_field_contributor::options_form public function Default options form provides the label widget that all fields should have. Overrides biblio_handler_field::options_form
biblio_handler_field_contributor::option_definition public function Information about options for all kinds of purposes will be held here. Overrides biblio_handler_field::option_definition
biblio_handler_field_contributor::post_execute public function Run after the view is executed, before the result is cached. Overrides views_handler::post_execute
biblio_handler_field_contributor::query public function Called to add the field to a query. Overrides biblio_handler_field::query
biblio_handler_field_contributor::render public function Render the field. Overrides biblio_handler_field::render
biblio_handler_field_contributor::render_contriubutors public function
views_handler::$handler_type public property The type of the handler, for example filter/footer/field.
views_handler::$query public property Where the $query object will reside:. 1
views_handler::$real_field public property The actual field in the database table, maybe different on other kind of query plugins/special handlers.
views_handler::$relationship public property The relationship used for this field.
views_handler::$table_alias public property The alias of the table of this handler which is used in the query.
views_handler::$view public property The top object of a view. Overrides views_object::$view
views_handler::accept_exposed_input public function Take input from exposed handlers and assign to this handler, if necessary. 1
views_handler::access public function Check whether current user has access to this handler. 10
views_handler::broken public function Determine if the handler is considered 'broken'. 6
views_handler::can_expose public function Determine if a handler can be exposed. 2
views_handler::case_transform public function Transform a string by a certain method.
views_handler::ensure_my_table public function Ensure the main table for this handler is in the query. This is used a lot. 8
views_handler::exposed_form public function Render our chunk of the exposed handler form when selecting. 1
views_handler::exposed_info public function Get information about the exposed form for the form renderer. 1
views_handler::exposed_submit public function Submit the exposed handler form.
views_handler::exposed_validate public function Validate the exposed handler form. 4
views_handler::expose_form public function Form for exposed handler options. 2
views_handler::expose_options public function Set new exposed option defaults when exposed setting is flipped on. 2
views_handler::expose_submit 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::expose_validate public function Validate the options form. 1
views_handler::extra_options public function Provide defaults for the handler.
views_handler::extra_options_form public function Provide a form for setting options. 1
views_handler::extra_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.
views_handler::extra_options_validate public function Validate the options form.
views_handler::get_field public function Shortcut to get a handler's raw field value.
views_handler::get_join public function Get the join object that should be used for this handler.
views_handler::groupby_form public function Provide a form for aggregation settings. 1
views_handler::groupby_form_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. 1
views_handler::has_extra_options public function If a handler has 'extra options' it will get a little settings widget and another form called extra_options. 1
views_handler::is_a_group public function Returns TRUE if the exposed filter works like a grouped filter. 1
views_handler::is_exposed public function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
views_handler::multiple_exposed_input 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::needs_style_plugin public function Determine if the argument needs a style plugin. 1
views_handler::options_validate public function Validate the options form. 4
views_handler::placeholder public function Provides a unique placeholders for handlers.
views_handler::pre_query public function Run before the view is built. 1
views_handler::sanitize_value public function Sanitize the value for output.
views_handler::set_relationship public function Called just prior to query(), this lets a handler set up any relationship it needs.
views_handler::show_expose_button public function Shortcut to display the expose/hide button. 2
views_handler::show_expose_form public function Shortcut to display the exposed options form.
views_handler::store_exposed_input public function If set to remember exposed input in the session, store it there. 1
views_handler::use_group_by public function Provides the handler some groupby. 2
views_handler::validate public function Validates the handler against the complete View. 1
views_handler_field::$additional_fields public property Stores additional fields which get added to the query. The generated aliases are stored in $aliases.
views_handler_field::$aliases public property
views_handler_field::$field_alias public property
views_handler_field::$last_render_index protected property Keeps track of the last render index.
views_handler_field::$original_value public property The field value prior to any rewriting.
views_handler_field::add_additional_fields public function Add 'additional' fields to the query.
views_handler_field::add_self_tokens public function Add any special tokens this field might use for itself. 4
views_handler_field::admin_summary public function Provide extra data to the administration form Overrides views_handler::admin_summary
views_handler_field::advanced_render public function Render a field using advanced settings.
views_handler_field::allow_advanced_render public function Determine if this field can allow advanced rendering. 1
views_handler_field::click_sort public function Called to determine what to tell the clicksorter. 1
views_handler_field::click_sortable public function Determine if this field is click sortable. 1
views_handler_field::construct public function Construct a new field handler. Overrides views_object::construct 17
views_handler_field::document_self_tokens public function Document any special tokens this field might use for itself. 4
views_handler_field::element_classes public function Return the class of the field.
views_handler_field::element_label_classes public function Return the class of the field's label.
views_handler_field::element_label_type public function Return an HTML element for the label based upon the field's element type.
views_handler_field::element_type public function Return an HTML element based upon the field's element type. 2
views_handler_field::element_wrapper_classes public function Return the class of the field's wrapper.
views_handler_field::element_wrapper_type public function Return an HTML element for the wrapper based upon the field's element type.
views_handler_field::get_elements public function Provide a list of elements valid for field HTML.
views_handler_field::get_render_tokens public function Get the 'render' tokens to use for advanced rendering.
views_handler_field::get_token_values_recursive public function Recursive function to add replacements for nested query string parameters.
views_handler_field::get_value public function Get the value that's supposed to be rendered. 3
views_handler_field::is_value_empty public function Checks if a field value is empty.
views_handler_field::label public function Get this field's label.
views_handler_field::options_submit public function Performs some cleanup tasks on the options array before saving it. Overrides views_handler::options_submit 1
views_handler_field::render_altered public function Render this field as altered text, from a fieldset set by the user.
views_handler_field::render_as_link public function Render this field as a link, with info from a fieldset set by the user.
views_handler_field::render_text public function Perform an advanced text render for the item.
views_handler_field::render_trim_text public function Trim the field down to the specified length.
views_handler_field::theme public function Call out to the theme() function.
views_handler_field::theme_functions public function Build a list of suitable theme functions for this view.
views_handler_field::tokenize_value public function Replace a value with tokens from the last field.
views_handler_field::ui_name public function Return a string representing this handler's name in the UI. Overrides views_handler::ui_name 1
views_handler_field::use_string_group_by public function Determines if this field will be available as an option to group the result by in the style settings.
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::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