You are here

Home » API reference » Bibliography Module 7.3 » BiblioStyleCiteProc.class.php

class BiblioStyleCiteProc in Bibliography Module 7.3

@file Chicago biblio style.

Hierarchy

Expanded class hierarchy of BiblioStyleCiteProc

1 string reference to 'BiblioStyleCiteProc'
citeproc.inc in plugins/biblio_style/citeproc/citeproc.inc

File

plugins/biblio_style/citeproc/BiblioStyleCiteProc.class.php, line 8
Chicago biblio style.

View source 
class BiblioStyleCiteProc extends BiblioStyleBase {
  public function render($options = array(), $langcode = NULL) {
    global $language;
    $langcode = $langcode ? $langcode : $language->language;

    // Make sure the CSL file exists.
    $style_name = $this->plugin['options']['style_name'] . '.csl';

    // @todo: Allow adding more styles in the Library.
    $file_path = $this->plugin['options']['style_path'] . '/' . $style_name;
    if (!file_exists($file_path)) {
      throw new Exception(format_string('@style file does not exist in @path.', array(
        '@style' => $style_name,
        '@path' => $file_path,
      )));
    }
    $csl_file_contents = file_get_contents($file_path);

    // @todo: Define CiteProc as library.
    include_once libraries_get_path('citeproc-php') . '/CiteProc.php';
    $citeproc = new citeproc($csl_file_contents, $langcode);

    // Pass CiteProc the mapped biblio.
    $mapped_data = $this
      ->map();
    if (!empty($this->plugin['options']['label_as_link'])) {

      // Add a prefix and suffix to the title, so it's later easier to replace
      // it with a link to the Biblio.
      $mapped_data->title = '---REPLACE---' . $mapped_data->title . '---REPLACE---';
    }
    $output = $citeproc
      ->render($mapped_data);
    if (!empty($this->plugin['options']['label_as_link'])) {

      // Show label as link.
      $matches = array();
      preg_match('/---REPLACE---(.*)---REPLACE---/i', $output, $matches);
      $url = entity_uri('biblio', $this->biblio);
      $output = str_replace($matches[0], l($matches[1], $url['path'], $url['options']), $output);
    }
    return $output;
  }

  /**
   * Map the fields from the Biblio entity to the ones known by CiteProc.
   */
  public function map() {
    $mappedBiblio = new stdClass();

    // Add the biblio type.
    $mappedBiblio->type = str_replace('_', '-', $this->biblio->type);
    $mapping = $this
      ->getMapping();
    $wrapper = entity_metadata_wrapper('biblio', $this->biblio);

    // Text variables.
    foreach ($mapping['biblio']['text'] as $key => $field_name) {
      if (!isset($wrapper->{$field_name})) {
        continue;
      }
      $mappedBiblio->{$key} = $wrapper->{$field_name}
        ->value();
    }

    // Date variables.
    foreach ($mapping['biblio']['date'] as $key => $field_name) {
      if (!isset($wrapper->{$field_name})) {
        continue;
      }
      $date = array();

      // @todo: Add "In press".
      if (strtolower($wrapper->biblio_status
        ->value()) == 'in press') {

        // CiteProc currently doesn't support the literal key. So this is
        // actually ignored, however, this is the "right" way.
        $mappedBiblio->{$key}->literal = 'In press';

        // This hack is just to make sure the In Press is added.
        // @todo: Check localization.
        $mappedBiblio->{$key}->{'date-parts'}[] = array(
          'In press',
        );
        continue;
      }

      // Check if the field is date field, or text.
      $field = field_info_field($field_name);
      if ($field['type'] == 'datestamp') {

        // Get the date granularity from the field settings.
        $timestamp = $wrapper->{$field_name}
          ->value();
        $date_info = array(
          'year' => 'Y',
          'month' => 'm',
          'day' => 'd',
        );
        foreach ($date_info as $granularity => $format) {
          if (empty($field['settings']['granularity'][$granularity])) {
            continue;
          }
          $date[] = date($format, $timestamp);
        }
      }
      else {

        // Textfield, so grab the value as literal.
        $date = array(
          $wrapper->{$field_name}
            ->value(),
        );
      }
      $mappedBiblio->{$key}->{'date-parts'}[] = $date;
    }

    // Add contributors.
    if (isset($wrapper->contributor_field_collection) && ($wrapper_contributors = $wrapper->contributor_field_collection)) {
      foreach ($wrapper_contributors as $wrapper_contributor) {
        if (!($type = strtolower($wrapper_contributor->biblio_contributor_role
          ->label()))) {
          $type = 'author';
        }
        $mapped_contributor = new stdClass();
        $contributor_wrapper = $wrapper_contributor->biblio_contributor;
        if (!$wrapper_contributor->biblio_contributor
          ->value()) {

          // No contributors.
          continue;
        }

        // Map the contributor data.
        foreach ($mapping['contributor']['text'] as $key => $field_name) {
          if (!isset($contributor_wrapper->{$field_name})) {
            continue;
          }
          $mapped_contributor->{$key} = $contributor_wrapper->{$field_name}
            ->value();
        }
        if ($mapped_contributor) {
          $mappedBiblio->{$type}[] = $mapped_contributor;
        }
      }
    }
    return $mappedBiblio;
  }
  public function getMapping() {
    return array(
      'biblio' => array(
        'text' => array(
          // Text variables.
          'title' => 'title',
          'container-title' => 'biblio_secondary_title',
          'collection-title' => 'biblio_secondary_title',
          'original-title' => 'biblio_alternate_title',
          'publisher' => 'biblio_publisher',
          'publisher-place' => 'biblio_place_published',
          'original-publisher' => 'original-publisher',
          'original-publisher-place' => 'original-publisher-place',
          'archive' => 'archive',
          'archive-place' => 'archive-place',
          'authority' => 'authority',
          'archive_location' => 'authority',
          'event' => 'biblio_date',
          'event-place' => 'event-place',
          'page' => 'biblio_pages',
          'page-first' => 'page',
          'locator' => 'locator',
          'version' => 'biblio_edition',
          'volume' => 'biblio_volume',
          'number-of-volumes' => 'biblio_number_of_volumes',
          'number-of-pages' => 'number-of-pages',
          'issue' => 'biblio_issue',
          'chapter-number' => 'biblio_section',
          'medium' => 'medium',
          'status' => 'status',
          'edition' => 'biblio_edition',
          'section' => 'biblio_section',
          'genre' => 'genre',
          'note' => 'biblio_note',
          'annote' => 'annote',
          'abstract' => 'biblio_abstract',
          'keyword' => 'keyword',
          'number' => 'biblio_number',
          'references' => 'references',
          'URL' => 'URL',
          'DOI' => 'biblio_doi',
          'ISBN' => 'biblio_isbn',
          'call-number' => 'biblio_call_number',
          'citation-number' => 'citation-number',
          'citation-label' => 'biblio_citekey',
          'first-reference-note-number' => 'first-reference-note-number',
          'year-suffix' => 'year-suffix',
          'jurisdiction' => 'jurisdiction',
        ),
        'date' => array(
          // Date Variables.
          'issued' => 'biblio_year',
          'event' => 'event',
          'accessed' => 'biblio_access_date',
          'container' => 'biblio_date',
          'original-date' => 'biblio_date',
        ),
        'contributor' => array(
          // Contributor Variables.
          'author' => 'author',
          'editor' => 'editor',
          'translator' => 'translator',
          'recipient' => 'recipient',
          'interviewer' => 'interviewer',
          'publisher' => 'publisher',
          'composer' => 'composer',
          'original-publisher' => 'original-publisher',
          'original-author' => 'original-author',
          'container-author' => 'container-author',
          'collection-editor' => 'collection-editor',
        ),
      ),
      'contributor' => array(
        'text' => array(
          'initials' => 'initials',
          'given' => 'firstname',
          'family' => 'lastname',
          'prefix' => 'prefix',
          'suffix' => 'suffix',
        ),
      ),
    );
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BiblioStyleBase::$biblio protected property The Biblio entity.
BiblioStyleBase::$plugin protected property The plugin definition.
BiblioStyleBase::generateBiblioMd5 public static function Generates an md5 string based on a biblio object. The md5 is later used to determine whether or not two Biblio objects are the same and prevent duplications.
BiblioStyleBase::getBiblioType public function Returns Biblio Publication Type based on Publication Type.
BiblioStyleBase::import public function Entry point for data import.
BiblioStyleBase::importKeywordsList public function Helper function to import existing or new keywords.
BiblioStyleBase::isDuplicate public function Searches for a biblio object identical to the given one.
BiblioStyleBase::renderEntryFiles public function
BiblioStyleBase::saveOrFindDuplicateFromImportData public function Given a of successful import, find duplicates or save the new Biblios.
BiblioStyleBase::settingsForm public function 1
BiblioStyleBase::settingsFormValidate public function
BiblioStyleBase::__construct public function Constructor for the notifier. Overrides BiblioStyleInterface::__construct
BiblioStyleCiteProc::getMapping public function @todo: Make abstract function? Overrides BiblioStyleBase::getMapping
BiblioStyleCiteProc::map public function Map the fields from the Biblio entity to the ones known by CiteProc.
BiblioStyleCiteProc::render public function Render the Biblio according to the style plugin. Overrides BiblioStyleBase::render 1