Kitodo\Dlf\Format\Mods

Complexity

Total Complexity

45

Size/Duplication

Total Lines	213
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getPlaces()	0	12	5
B	getYears()	0	26	9
C	getAuthors()	0	50	16
C	getHolders()	0	41	14
A	extractMetadata()	0	13	1

<?php

/**
 * (c) Kitodo. Key to digital objects e.V. <contact@kitodo.org>
 *
 * This file is part of the Kitodo and TYPO3 projects.
 *
 * @license GNU General Public License version 3 or later.
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 */

namespace Kitodo\Dlf\Format;

/**
 * Metadata MODS format class for the 'dlf' extension
 *
 * @author Sebastian Meyer <sebastian.meyer@slub-dresden.de>
 * @package TYPO3
 * @subpackage dlf
 * @access public
 */
class Mods implements \Kitodo\Dlf\Common\MetadataInterface
{
        /**
     * The metadata XML
     *
     * @var \SimpleXMLElement
     **/
    private $xml;

    /**
     * The metadata array
     *
     * @var array
     **/
    private $metadata;

    /**
     * This extracts the essential MODS metadata from XML
     *
     * @access public
     *
     * @param \SimpleXMLElement $xml: The XML to extract the metadata from
     * @param array &$metadata: The metadata array to fill
     *
     * @return void
     */
    public function extractMetadata(\SimpleXMLElement $xml, array &$metadata)
    {
        $this->xml = $xml;
        $this->metadata = $metadata;

        $this->xml->registerXPathNamespace('mods', 'http://www.loc.gov/mods/v3');

        $this->getAuthors();
        $this->getHolders();
        $this->getPlaces();
        $this->getYears();

        $metadata = $this->metadata;
    }

    /**
     * Get "author" and "author_sorting".
     *
     * @access private
     *
     * @return void
     */
    private function getAuthors() {
        $authors = $this->xml->xpath('./mods:name[./mods:role/mods:roleTerm[@type="code" and @authority="marcrelator"]="aut"]');

        // Get "author" and "author_sorting" again if that was too sophisticated.
        if (empty($authors)) {
            // Get all names which do not have any role term assigned and assume these are authors.
            $authors = $this->xml->xpath('./mods:name[not(./mods:role)]');
        }
        if (!empty($authors)) {
            for ($i = 0, $j = count($authors); $i < $j; $i++) {
                $authors[$i]->registerXPathNamespace('mods', 'http://www.loc.gov/mods/v3');

                // Check if there is a display form.
                if (($displayForm = $authors[$i]->xpath('./mods:displayForm'))) {
                    $this->metadata['author'][$i] = (string) $displayForm[0];
                } elseif (($nameParts = $authors[$i]->xpath('./mods:namePart'))) {
                    $name = [];
                    $k = 4;
                    foreach ($nameParts as $namePart) {
                        if (
                            isset($namePart['type'])
                            && (string) $namePart['type'] == 'family'
                        ) {
                            $name[0] = (string) $namePart;
                        } elseif (
                            isset($namePart['type'])
                            && (string) $namePart['type'] == 'given'
                        ) {
                            $name[1] = (string) $namePart;
                        } elseif (
                            isset($namePart['type'])
                            && (string) $namePart['type'] == 'termsOfAddress'
                        ) {
                            $name[2] = (string) $namePart;
                        } elseif (
                            isset($namePart['type'])
                            && (string) $namePart['type'] == 'date'
                        ) {
                            $name[3] = (string) $namePart;
                        } else {
                            $name[$k] = (string) $namePart;
                        }
                        $k++;
                    }
                    ksort($name);
                    $this->metadata['author'][$i] = trim(implode(', ', $name));
                }
                // Append "valueURI" to name using Unicode unit separator.
                if (isset($authors[$i]['valueURI'])) {
                    $this->metadata['author'][$i] .= chr(31) . (string) $authors[$i]['valueURI'];
                }
            }
        }
    }

    /**
     * Get holder.
     *
     * @access private
     *
     * @return void
     */
    private function getHolders() {
        $holders = $this->xml->xpath('./mods:name[./mods:role/mods:roleTerm[@type="code" and @authority="marcrelator"]="prv"]');

        if (!empty($holders)) {
            for ($i = 0, $j = count($holders); $i < $j; $i++) {
                $holders[$i]->registerXPathNamespace('mods', 'http://www.loc.gov/mods/v3');

                // Check if there is a display form.
                if (($displayForm = $holders[$i]->xpath('./mods:displayForm'))) {
                    $this->metadata['holder'][$i] = (string) $displayForm[0];
                } elseif (($nameParts = $holders[$i]->xpath('./mods:namePart'))) {
                    $name = [];
                    $k = 4;
                    foreach ($nameParts as $namePart) {
                        if (
                            isset($namePart['type'])
                            && (string) $namePart['type'] == 'family'
                        ) {
                            $name[0] = (string) $namePart;
                        } elseif (
                            isset($namePart['type'])
                            && (string) $namePart['type'] == 'given'
                        ) {
                            $name[1] = (string) $namePart;
                        } elseif (
                            isset($namePart['type'])
                            && (string) $namePart['type'] == 'termsOfAddress'
                        ) {
                            $name[2] = (string) $namePart;
                        } elseif (
                            isset($namePart['type'])
                            && (string) $namePart['type'] == 'date'
                        ) {
                            $name[3] = (string) $namePart;
                        } else {
                            $name[$k] = (string) $namePart;
                        }
                        $k++;
                    }
                    ksort($name);
                    $this->metadata['holder'][$i] = trim(implode(', ', $name));
                }
            }
        }
    }

    /**
     * Get "place" and "place_sorting".
     *
     * @access private
     *
     * @return void
     */
    private function getPlaces() {
        $places = $this->xml->xpath('./mods:originInfo[not(./mods:edition="[Electronic ed.]")]/mods:place/mods:placeTerm');
        // Get "place" and "place_sorting" again if that was to sophisticated.
        if (empty($places)) {
            // Get all places and assume these are places of publication.
            $places = $this->xml->xpath('./mods:originInfo/mods:place/mods:placeTerm');
        }
        if (!empty($places)) {
            foreach ($places as $place) {
                $this->metadata['place'][] = (string) $place;
                if (!$this->metadata['place_sorting'][0]) {
                    $this->metadata['place_sorting'][0] = preg_replace('/[[:punct:]]/', '', (string) $place);
                }
            }
        }
    }

    /**
     * Get "year" and "year_sorting".
     *
     * @access private
     *
     * @return void
     */
    private function getYears() {
        // Get "year_sorting".
        if (($years_sorting = $this->xml->xpath('./mods:originInfo[not(./mods:edition="[Electronic ed.]")]/mods:dateOther[@type="order" and @encoding="w3cdtf"]'))) {
            foreach ($years_sorting as $year_sorting) {
                $this->metadata['year_sorting'][0] = intval($year_sorting);
            }
        }
        // Get "year" and "year_sorting" if not specified separately.
        $years = $this->xml->xpath('./mods:originInfo[not(./mods:edition="[Electronic ed.]")]/mods:dateIssued[@keyDate="yes"]');
        // Get "year" and "year_sorting" again if that was to sophisticated.
        if (empty($years)) {
            // Get all dates and assume these are dates of publication.
            $years = $this->xml->xpath('./mods:originInfo/mods:dateIssued');
        }
        if (!empty($years)) {
            foreach ($years as $year) {
                $this->metadata['year'][] = (string) $year;
                if (!$this->metadata['year_sorting'][0]) {
                    $year_sorting = str_ireplace('x', '5', preg_replace('/[^\d.x]/i', '', (string) $year));
                    if (
                        strpos($year_sorting, '.')

It seems like $year_sorting can also be of type array; however, parameter $haystack of strpos() does only seem to accept string, maybe add an additional type check?

                        || strlen($year_sorting) < 3

It seems like $year_sorting can also be of type array; however, parameter $string of strlen() does only seem to accept string, maybe add an additional type check?

                    ) {
                        $year_sorting = ((intval(trim($year_sorting, '.')) - 1) * 100) + 50;

It seems like $year_sorting can also be of type array; however, parameter $string of trim() does only seem to accept string, maybe add an additional type check?

                    }
                    $this->metadata['year_sorting'][0] = intval($year_sorting);
                }
            }
        }
    }
}