class BiblioStyleEndNoteXML8 in Bibliography Module 7.3

@file EndNote XML8 biblio style.

Hierarchy

class \BiblioStyleBase implements BiblioStyleInterface
- class \BiblioStyleEndNote
  - class \BiblioStyleEndNoteXML8 implements BiblioStyleImportInterface

Expanded class hierarchy of BiblioStyleEndNoteXML8

2 string references to 'BiblioStyleEndNoteXML8'

BiblioStyleEndNote::importData in plugins/biblio_style/endnote/BiblioStyleEndNote.class.php: @inheritdoc
BiblioStyleEndNote::render in plugins/biblio_style/endnote/BiblioStyleEndNote.class.php: @inheritdoc

File

plugins/biblio_style/endnote/BiblioStyleEndNoteXML8.php, line 8: EndNote XML8 biblio style.

View source

class BiblioStyleEndNoteXML8 extends BiblioStyleEndNote implements BiblioStyleImportInterface {

  /**
   * @inheritdoc
   */
  public function importData($data, $options = array()) {
    $options += array(
      // Populate the pattern here, so BiblioStyleEndNoteXML7 can re-use
      // this class.
      'pattern' => '/<ref-type>(.*)<\\/ref-type>/',
    );
    $match = array();

    // Get the Biblio type from the XML.
    preg_match($options['pattern'], $data, $match);
    if (!($type = intval($match[1]))) {
      return;
    }
    $type = $this
      ->getBiblioType($type);
    $this->biblio = $biblio = biblio_create($type);
    $this->wrapper = $wrapper = entity_metadata_wrapper('biblio', $this->biblio);
    $data = str_replace("\r\n", "\n", $data);
    $parser = drupal_xml_parser_create($data);
    xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, FALSE);
    xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, TRUE);
    xml_set_object($parser, $this);
    xml_set_element_handler($parser, 'startElement', 'endElement');
    xml_set_character_data_handler($parser, 'characterData');
    if (!xml_parse($parser, $data)) {
      $params = array(
        '@error' => xml_error_string(xml_get_error_code($parser)),
        '@line' => xml_get_current_line_number($parser),
      );
      return array(
        'error' => array(
          'data' => $data,
          'message' => t('XML error: @error at line @line', $params),
        ),
      );
    }
    xml_parser_free($parser);
    $biblios[] = $biblio;
    return array(
      'success' => $biblios,
    );
  }
  public function startElement($parser, $name, $attrs) {
    if ($name == 'style') {
      $this->font_attr = explode(' ', $attrs['face']);
      foreach ($this->font_attr as $font_attr) {
        switch ($font_attr) {
          case 'normal':

            // Do nothing.
            break;
          case 'bold':
            $this
              ->characterData(NULL, '<b>');
            break;
          case 'italic':
            $this
              ->characterData(NULL, '<i>');
            break;
          case 'underline':
            $this
              ->characterData(NULL, '<u>');
            break;
          case 'superscript':
            $this
              ->characterData(NULL, '<sup>');
            break;
          case 'subscript':
            $this
              ->characterData(NULL, '<sub>');
            break;
        }
      }
    }
    else {
      $this->element = $name;
      if (strpos($name, 'authors') !== FALSE) {

        // Add the role of the contributor.
        $this->role = $name;
      }
    }
  }
  public function endElement($parser, $name) {
    if ($name == 'style') {
      foreach ($this->font_attr as $font_attr) {
        switch ($font_attr) {
          case 'normal':

            // Do nothing.
            break;
          case 'bold':
            $this
              ->characterData(NULL, '</b>');
            break;
          case 'italic':
            $this
              ->characterData(NULL, '</i>');
            break;
          case 'underline':
            $this
              ->characterData(NULL, '</u>');
            break;
          case 'superscript':
            $this
              ->characterData(NULL, '</sup>');
            break;
          case 'subscript':
            $this
              ->characterData(NULL, '</sub>');
            break;
        }
      }
    }
    else {
      $this->element = '';
    }
  }

  /**
   * @todo: Import keywords.
   */
  public function characterData($parser, $data) {
    $map = $this
      ->getMapping();
    $element = $this->element;
    if (!empty($map['field'][$element]['import_method'])) {

      // Prepare the data by striping any tags or white space.
      $data = explode("\n", $data);
      foreach ($data as $key => $value) {
        $data[$key] = trim(htmlspecialchars_decode($value));
      }
      $data = implode('', $data);
      if (!$data) {

        // No data given, it might have been a carriage return that was striped.
        return;
      }
      $method = $map['field'][$element]['import_method'];

      // Key might be a Biblio field, or the role of a contributor.
      $key = $element == 'author' ? $this->role : $map['field'][$element]['property'];
      $this
        ->{$method}($this->wrapper, $key, $data);
    }
  }

  /**
   * Import generic property.
   *
   * @param EntityMetadataWrapper $wrapper
   *   The wrapped Biblio object.
   * @param $property
   *   The property name to import.
   * @param $data
   *   The data to import from.
   *
   */
  public function importGeneric(EntityMetadataWrapper $wrapper, $property, $data) {

    // @todo: Make more generic + configurable?
    if (!isset($wrapper->{$property})) {

      // Create field.
      biblio_create_field($property, 'biblio', $wrapper
        ->getBundle());
    }
    $value = $wrapper->{$property}
      ->value() . $data;
    $wrapper->{$property}
      ->set($value);
  }

  /**
   * Import year and Biblio status.
   *
   * @param EntityMetadataWrapper $wrapper
   *   The wrapped Biblio object.
   * @param $property
   *   The property name to import.
   * @param $data
   *   The data to import from.
   */
  public function importYear(EntityMetadataWrapper $wrapper, $property, $data) {
    if (is_numeric($data)) {
      $wrapper->biblio_year
        ->set($data);
      return;
    }

    // @todo: Get Biblio status valid options from field.
    $options = array(
      'in_press',
      'submitted',
    );
    $data = str_replace(' ', '_', strtolower($data));
    if (in_array($data, $options)) {
      $wrapper->biblio_status
        ->set($data);
    }
  }

  /**
   * Import a Contributor.
   *
   * @param EntityMetadataWrapper $wrapper
   *   The wrapped Biblio object.
   * @param $role
   *   The role of the contributor.
   * @param $name
   *   The name of the contributor.
   */
  public function importContributor(EntityMetadataWrapper $wrapper, $role, $name) {
    $biblio = $wrapper
      ->value();

    // Map the role to Biblio.
    $role = $role == 'authors' ? 'author' : str_replace('-authors', '', $role);

    // @todo: Check if roles make sense.
    switch ($role) {
      case 'authors':
        $role = 'Author';
        break;
      case 'secondary-authors':
        $role = 'Secondary Author';
        break;
      case 'tertiary-authors':
        $role = 'Tertiary Author';
        break;
      case 'subsidiary-authors':
        $role = 'Subsidiary Author';
        break;
      case 'translated-authors':
        $role = 'Translator';
    }
    $this
      ->addContributors($name, $role);
  }

  /**
   * @inheritdoc
   */
  public function render($options = array(), $langcode = NULL) {
  }

  /**
   * @inheritdoc
   */
  public function getMapping() {
    $return = array(
      'type' => array(
        2 => 'artwork',
        3 => 'audiovisual',
        4 => 'bill',
        5 => 'book_chapter',
        6 => 'book',
        7 => 'case',
        9 => 'software',
        10 => 'conference_proceedings',
        12 => 'web_article',
        13 => 'miscellaneous',
        14 => 'hearing',
        17 => 'journal_article',
        19 => 'magazine_article',
        20 => 'map',
        21 => 'broadcast',
        23 => 'newspaper_article',
        25 => 'patent',
        26 => 'personal',
        27 => 'report',
        28 => 'miscellaneous',
        31 => 'statute',
        32 => 'thesis',
        34 => 'unpublished',
        36 => 'manuscript',
        37 => 'miscellaneous',
        38 => 'chart',
        39 => 'miscellaneous',
        43 => 'miscellaneous',
        44 => 'miscellaneous',
        45 => 'database',
        46 => 'government_report',
        47 => 'conference_paper',
        48 => 'miscellaneous',
        49 => 'classical',
        50 => 'legal_ruling',
        52 => 'miscellaneous',
        53 => 'miscellaneous',
        54 => 'miscellaneous',
      ),
      'field' => array(
        // Todo: Get the role from the XML tag.
        'author' => array(
          // We don't have a property for this key. The role name will be taken
          // from the parent tag (e.g. <authors>, <secondary-authors>).
          'import_method' => 'importContributor',
        ),
        'abbr-1' => array(
          'property' => 'biblio_short_title',
        ),
        'abstract' => array(
          'property' => 'biblio_abstract',
        ),
        'access-date' => array(
          'property' => 'biblio_access_date',
        ),
        'accession-num' => array(
          'property' => 'biblio_accession_number',
        ),
        'alt-title' => array(
          'property' => 'biblio_alternate_title',
        ),
        'auth-address' => array(
          'property' => 'biblio_auth_address',
        ),
        'call-num' => array(
          'property' => 'biblio_call_number',
        ),
        'edition' => array(
          'property' => 'biblio_edition',
        ),
        'full-title' => array(
          'property' => 'biblio_secondary_title',
        ),
        'isbn' => array(
          'property' => 'biblio_isbn',
        ),
        'issue' => array(
          'property' => 'biblio_issue',
        ),
        'label' => array(
          'property' => 'biblio_label',
        ),
        'language' => array(
          'property' => 'biblio_language',
        ),
        'notes' => array(
          'property' => 'biblio_notes',
        ),
        'num-vols' => array(
          'property' => 'biblio_number_of_volumes',
        ),
        'number' => array(
          'property' => 'biblio_number',
        ),
        'orig-pub' => array(
          'property' => 'biblio_original_publication',
        ),
        'pages' => array(
          'property' => 'biblio_pages',
        ),
        'pub-location' => array(
          'property' => 'biblio_place_published',
        ),
        'publisher' => array(
          'property' => 'biblio_publisher',
        ),
        'related-urls' => array(
          'property' => 'biblio_url',
        ),
        'remote-database-name' => array(
          'property' => 'biblio_remote_db_name',
        ),
        'remote-database-provider' => array(
          'property' => 'biblio_remote_db_provider',
        ),
        'reprint-edition' => array(
          'property' => 'biblio_reprint_edition',
        ),
        'research-notes' => array(
          'property' => 'biblio_search_notes',
        ),
        'secondary-title' => array(
          'property' => 'biblio_secondary_title',
        ),
        'section' => array(
          'property' => 'biblio_section',
        ),
        'short-title' => array(
          'property' => 'biblio_short_title',
        ),
        'tertiary-title' => array(
          'property' => 'biblio_tertiary_title',
        ),
        'title' => array(
          'property' => 'title',
        ),
        'translated-title' => array(
          'property' => 'biblio_translated_title',
        ),
        'url' => array(
          'property' => 'biblio_url',
        ),
        'volume' => array(
          'property' => 'biblio_volume',
        ),
        'work-type' => array(
          'property' => 'biblio_type_of_work',
        ),
        'year' => array(
          'property' => 'biblio_year',
          'import_method' => 'importYear',
        ),
      ),
    );

    // Add default values.
    foreach (array_keys($return['field']) as $key) {
      $return['field'][$key] += array(
        'import_method' => 'importGeneric',
      );
    }
    return $return;
  }

}

Members

Name	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::settingsFormValidate	public	function
BiblioStyleBase::__construct	public	function	Constructor for the notifier. Overrides BiblioStyleInterface::__construct
BiblioStyleEndNote::settingsForm	public	function	Overrides BiblioStyleBase::settingsForm
BiblioStyleEndNoteXML8::characterData	public	function	@todo: Import keywords.
BiblioStyleEndNoteXML8::endElement	public	function
BiblioStyleEndNoteXML8::getMapping	public	function	@inheritdoc Overrides BiblioStyleBase::getMapping	1
BiblioStyleEndNoteXML8::importContributor	public	function	Import a Contributor.
BiblioStyleEndNoteXML8::importData	public	function	@inheritdoc Overrides BiblioStyleEndNote::importData	1
BiblioStyleEndNoteXML8::importGeneric	public	function	Import generic property.
BiblioStyleEndNoteXML8::importYear	public	function	Import year and Biblio status.
BiblioStyleEndNoteXML8::render	public	function	@inheritdoc Overrides BiblioStyleEndNote::render	1
BiblioStyleEndNoteXML8::startElement	public	function

You are here

class BiblioStyleEndNoteXML8 in Bibliography Module 7.3

Hierarchy

File

Members

API Navigation