Bib::onData() - Code Metrics - Inspection of "Add user fees" - scriptotek/php-alma-client - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9d90d4...cee823 )

by Dan Michael O.

created 2018-07-30 16:42 UTC

Bib::onData() A

↳ Parent: Bib

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	1
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php

namespace Scriptotek\Alma\Bibs;

use Scriptotek\Alma\Client;
use Scriptotek\Alma\Exception\NoLinkedNetworkZoneRecordException;
use Scriptotek\Alma\Model\LazyResource;
use Scriptotek\Marc\Record as MarcRecord;
use Scriptotek\Sru\Record as SruRecord;

/**
 * A single Bib resource.
 */
class Bib extends LazyResource
{
    /** @var string */
    public $mms_id;

    /* @var Holdings */
    public $holdings;

    /* @var MarcRecord */
    protected $_marc;

    public function __construct(Client $client = null, $mms_id = null)
    {
        parent::__construct($client);
function notNullable(stdClass $x) { }

// Unsafe
function withoutCheck(stdClass $x = null) {
    notNullable($x);
}

// Safe - Alternative 1: Adding Additional Type-Check
function withCheck(stdClass $x = null) {
    if ($x instanceof stdClass) {
        notNullable($x);
    }
}

// Safe - Alternative 2: Changing Parameter
function withNonNullableParam(stdClass $x) {
    notNullable($x);
}
        $this->mms_id = $mms_id;
        $this->holdings = Holdings::make($this->client, $this);
    }

    /**
     * Load MARC record onto this Bib object. Chainable method.
     *
     * @param string $xml
     *
     * @return Bib
     */
    public function setMarcRecord($xml)
    {
        // Workaround for a long-standing API-bug
        $xml = str_replace('UTF-16', 'UTF-8', $xml);

        $this->_marc = MarcRecord::fromString($xml);

        // Note: do not marc as initialized, since we miss some other data from the Bib record. Oh, Alma :/

        return $this;
    }

    /**
     * Initialize from SRU record without having to fetch the Bib record.
     * @param SruRecord $record
     * @param Client|null $client
     * @return Bib
     */
    public static function fromSruRecord(SruRecord $record, Client $client = null)
    {
        $record->data->registerXPathNamespace('marc', 'http://www.loc.gov/MARC21/slim');
        $mmsId = $record->data->text('.//controlfield[@tag="001"]');

        return (new self($client, $mmsId))
            ->setMarcRecord($record->data->asXML());
    }

    public function getHoldings()
    {
        return $this->holdings;
    }

    public function save()
    {
        // If initialized from an SRU record, we need to fetch the
        // remaining parts of the Bib record.
        $this->init();

        // Serialize the MARC record
        $data = $this->_marc->toXML('UTF-8', false, false);

        // but wait, Alma hates namespaces, so we have to remove them...
        $data = str_replace(' xmlns="http://www.loc.gov/MARC21/slim"', '', $data);

        $this->data->anies = [$data];

        return $this->client->putJSON('/bibs/' . $this->mms_id, $data);
    }

    /**
     * Get the MMS ID of the linked record in network zone.
     */
    public function getNzMmsId()
    {
        // If initialized from an SRU record, we need to fetch the
        // remaining parts of the Bib record.
        $this->init();

        // @TODO: What if record is also linked to CZ? Probably an array is returned.
        $nz_mms_id = $this->data->linked_record_id->value;
        if (!$nz_mms_id) {
            throw new NoLinkedNetworkZoneRecordException("Record $this->mms_id is not linked to a network zone record.");
        }

        return $nz_mms_id;
    }

    /**
     * Get the Bib of the linked record in network zone.
     */
    public function getNzRecord()
    {
        return $this->client->nz->bibs->get($this->getNzMmsId());
    }

    /**
     * Returns the MARC record. Load it if we don't have it yet.
     */
    public function getRecord()
    {
        if (is_null($this->_marc)) {
            $this->init();
        }
        return $this->_marc;
    }

    /**
     * Called when data is available to be processed.
     *
     * @param mixed $data
     */
    protected function onData($data)
    {
        $this->setMarcRecord($data->anies[0]);
    }

    /**
     * Check if we have the full representation of our data object.
     *
     * @param \stdClass $data
     * @return boolean
     */
    protected function isInitialized($data)
    {
        return isset($data->anies);
    }

    /**
     * Generate the base URL for this resource.
     *
     * @return string
     */
    protected function urlBase()
    {
        return "/bibs/{$this->mms_id}";
    }
}


1			<?php
2
3			namespace Scriptotek\Alma\Bibs;
4
5			use Scriptotek\Alma\Client;
6			use Scriptotek\Alma\Exception\NoLinkedNetworkZoneRecordException;
7			use Scriptotek\Alma\Model\LazyResource;
8			use Scriptotek\Marc\Record as MarcRecord;
9			use Scriptotek\Sru\Record as SruRecord;
10
11			/**
12			* A single Bib resource.
13			*/
14			class Bib extends LazyResource
15			{
16			/** @var string */
17			public $mms_id;
18
19			/* @var Holdings */
20			public $holdings;
21
22			/* @var MarcRecord */
23			protected $_marc;
24
25			public function __construct(Client $client = null, $mms_id = null)
26			{
27			parent::__construct($client);
			0 ignored issues – show Bug introduced 2018-07-30 16:45 UTC by Report Bug Copy Issue Report It seems like `$client` defined by parameter `$client` on line `25` can be `null`; however, `Scriptotek\Alma\Model\Model::__construct()` does not accept `null`, maybe add an additional type check? It seems like you allow that null is being passed for a parameter, however the function which is called does not seem to accept null. We recommend to add an additional type check (or disallow null for the parameter): function notNullable(stdClass $x) { } // Unsafe function withoutCheck(stdClass $x = null) { notNullable($x); } // Safe - Alternative 1: Adding Additional Type-Check function withCheck(stdClass $x = null) { if ($x instanceof stdClass) { notNullable($x); } } // Safe - Alternative 2: Changing Parameter function withNonNullableParam(stdClass $x) { notNullable($x); } Loading history...
28			$this->mms_id = $mms_id;
29			$this->holdings = Holdings::make($this->client, $this);
30			}
31
32			/**
33			* Load MARC record onto this Bib object. Chainable method.
34			*
35			* @param string $xml
36			*
37			* @return Bib
38			*/
39			public function setMarcRecord($xml)
40			{
41			// Workaround for a long-standing API-bug
42			$xml = str_replace('UTF-16', 'UTF-8', $xml);
43
44			$this->_marc = MarcRecord::fromString($xml);
			0 ignored issues – show Documentation Bug introduced 2018-07-26 20:14 UTC by Report Bug Copy Issue Report It seems like `\Scriptotek\Marc\Record::fromString($xml)` of type `object<Scriptotek\Marc\Collection>` is incompatible with the declared type `object<Scriptotek\Marc\Record>` of property `$_marc`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
45			// Note: do not marc as initialized, since we miss some other data from the Bib record. Oh, Alma :/
46
47			return $this;
48			}
49
50			/**
51			* Initialize from SRU record without having to fetch the Bib record.
52			* @param SruRecord $record
53			* @param Client\|null $client
54			* @return Bib
55			*/
56			public static function fromSruRecord(SruRecord $record, Client $client = null)
57			{
58			$record->data->registerXPathNamespace('marc', 'http://www.loc.gov/MARC21/slim');
59			$mmsId = $record->data->text('.//controlfield[@tag="001"]');
60
61			return (new self($client, $mmsId))
62			->setMarcRecord($record->data->asXML());
63			}
64
65			public function getHoldings()
66			{
67			return $this->holdings;
68			}
69
70			public function save()
71			{
72			// If initialized from an SRU record, we need to fetch the
73			// remaining parts of the Bib record.
74			$this->init();
75
76			// Serialize the MARC record
77			$data = $this->_marc->toXML('UTF-8', false, false);
78
79			// but wait, Alma hates namespaces, so we have to remove them...
80			$data = str_replace(' xmlns="http://www.loc.gov/MARC21/slim"', '', $data);
81
82			$this->data->anies = [$data];
83
84			return $this->client->putJSON('/bibs/' . $this->mms_id, $data);
85			}
86
87			/**
88			* Get the MMS ID of the linked record in network zone.
89			*/
90			public function getNzMmsId()
91			{
92			// If initialized from an SRU record, we need to fetch the
93			// remaining parts of the Bib record.
94			$this->init();
95
96			// @TODO: What if record is also linked to CZ? Probably an array is returned.
97			$nz_mms_id = $this->data->linked_record_id->value;
98			if (!$nz_mms_id) {
99			throw new NoLinkedNetworkZoneRecordException("Record $this->mms_id is not linked to a network zone record.");
100			}
101
102			return $nz_mms_id;
103			}
104
105			/**
106			* Get the Bib of the linked record in network zone.
107			*/
108			public function getNzRecord()
109			{
110			return $this->client->nz->bibs->get($this->getNzMmsId());
111			}
112
113			/**
114			* Returns the MARC record. Load it if we don't have it yet.
115			*/
116			public function getRecord()
117			{
118			if (is_null($this->_marc)) {
119			$this->init();
120			}
121			return $this->_marc;
122			}
123
124			/**
125			* Called when data is available to be processed.
126			*
127			* @param mixed $data
128			*/
129			protected function onData($data)
130			{
131			$this->setMarcRecord($data->anies[0]);
132			}
133
134			/**
135			* Check if we have the full representation of our data object.
136			*
137			* @param \stdClass $data
138			* @return boolean
139			*/
140			protected function isInitialized($data)
141			{
142			return isset($data->anies);
143			}
144
145			/**
146			* Generate the base URL for this resource.
147			*
148			* @return string
149			*/
150			protected function urlBase()
151			{
152			return "/bibs/{$this->mms_id}";
153			}
154			}
155

scriptotek / php-alma-client

Push — master ( 9d90d4...cee823 )

Bib::onData() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like