SearchableDocument::toArray() - Code Metrics - scriptotek/colligator-backend - Measure and Improve Code Quality continuously with Scrutinizer

SearchableDocument::toArray() C
last analyzed 2018-08-07 10:50 UTC

↳ Parent: SearchableDocument

Complexity

Conditions	9
Paths	144

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	72
rs	6.762
c	0
b	0
f	0
cc	9
nc	144
nop	0

How to fix Long Method

<?php

namespace Colligator\Search;

use Colligator\Document;
use Colligator\XisbnResponse;

class SearchableDocument
{
    /**
     * @var DocumentsIndex
     */
    protected $docIndex;

    /**
     * @var string
     */
    protected $sortableCallCodePattern = '/FA ([0-9]+)(\/([A-Z]))?/';

    /**
     * @param Document       $doc
     * @param DocumentsIndex $docIndex
     */
    public function __construct(Document $doc, DocumentsIndex $docIndex)
    {
        $this->doc = $doc;
        $this->docIndex = $docIndex;
    }

    /**
     * Generate ElasticSearch index payload.
     *
     * @return array
     */
    public function toArray()
    {
        $body = $this->doc->bibliographic;  // PHP makes a copy for us

        $body['id'] = $this->doc->id;
        $body['bibsys_id'] = $this->doc->bibsys_id;

        // Remove some stuff we don't need
        foreach (['agency', 'catalogingRules', 'debug', 'modified', 'extent', 'cover_image'] as $key) {
            unset($body[$key]);
        }

        // Add local collections
        $body['collections'] = [];
        foreach ($this->doc->collections as $collection) {
            $body['collections'][] = $collection['name'];
        }

        // Add cover
        $body['cover'] = $this->doc->cover ? $this->doc->cover->toArray() : null;

        // Add subjects
        $body['subjects'] = [];
        foreach ($this->doc->subjects as $subject) {
            $body['subjects'][$subject['vocabulary'] ?: 'keywords'][] = [
                'id'        => array_get($subject, 'id'),
                'prefLabel' => str_replace('--', ' : ', array_get($subject, 'term')),
                'type'      => array_get($subject, 'type'),
                'count'     => $this->docIndex->getUsageCount(array_get($subject, 'id'), 'subject'),
            ];
        }

        // Add genres
        $body['genres'] = [];
        foreach ($this->doc->genres as $genre) {
            $body['genres'][$genre['vocabulary'] ?: 'keywords'][] = [
                'id'        => array_get($genre, 'id'),
                'prefLabel' => array_get($genre, 'term'),
                'count'     => $this->docIndex->getUsageCount(array_get($genre, 'id'), 'genre'),
            ];
        }

        // Add holdings
        $this->addHoldings($body, $this->doc);

        // Add xisbns
        $body['xisbns'] = (new XisbnResponse($this->doc->xisbn))->getSimpleRepr();

        // Add description
        $body['description'] = $this->doc->description;

        // Add 'other form'
        $otherFormId = array_get($body, 'other_form.id');
        if (!empty($otherFormId)) {

            // @TODO: https://github.com/scriptotek/colligator-backend/issues/34
            // Not sure how to handle this in Alma yet
            unset($body['other_form']);
            // $otherFormDoc = Document::where('bibsys_id', '=', $otherFormId)->firstOrFail();

            // $body['other_form'] = [

            //     'id'         => $otherFormDoc->id,

            //     'bibsys_id'  => $otherFormDoc->bibsys_id,

            //     'electronic' => $otherFormDoc->isElectronic(),

            // ];
            // $this->addHoldings($body['other_form'], $otherFormDoc);

        }

        // Add 'cannot_find_cover'
        $body['cannot_find_cover'] = $this->doc->cannot_find_cover;

        return $body;
    }

    public function sortableCallCode($holding)
    {
        $m = preg_match($this->sortableCallCodePattern, array_get($holding, 'callcode'), $matches);
        if ($m) {
            return intval($matches[1]);
            // TODO: Også ta hensyn til undersortering i $matches[3], men
            // denne er en blanding av romertall og alfabetisk sortering
            // https://github.com/scriptotek/colligator-backend/issues/28
        }

        return;
    }

    public function addHoldings(&$body, Document $doc)
    {
        if ($doc->isElectronic()) {
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}

            // @ TODO: Virker ikke med Alma
            // https://github.com/scriptotek/colligator-backend/issues/34
            // $body['fulltext'] = $this->fulltextFromHoldings($doc->holdings);


        } else {
            $body['holdings'] = [];
            foreach ($doc->holdings as $holding) {
                array_forget($holding, 'fulltext');
                array_forget($holding, 'bibliographic_record');
                array_forget($holding, 'nonpublic_notes');
                $s = $this->sortableCallCode($holding);
                if (!is_null($s)) {
                    $holding['callcodeSortable'] = $s;
                }
                $body['holdings'][] = $holding;
            }
        }
    }

    public function fulltextFromHoldings($holdings)
    {
        $fulltext = [
            'access' => false,
        ];
        foreach ($holdings as $holding) {
            if (!count($holding['fulltext'])) {
                continue;
            }
            if ($holding['location'] == 'UBO' || stripos($holding['fulltext'][0]['comment'], 'gratis') !== false) {
                $fulltext = $holding['fulltext'][0];
                $fulltext['access'] = true;
            }
        }

        return $fulltext;
    }
}


1			<?php
2
3			namespace Colligator\Search;
4
5			use Colligator\Document;
6			use Colligator\XisbnResponse;
7
8			class SearchableDocument
9			{
10			/**
11			* @var DocumentsIndex
12			*/
13			protected $docIndex;
14
15			/**
16			* @var string
17			*/
18			protected $sortableCallCodePattern = '/FA ([0-9]+)(\/([A-Z]))?/';
19
20			/**
21			* @param Document $doc
22			* @param DocumentsIndex $docIndex
23			*/
24			public function __construct(Document $doc, DocumentsIndex $docIndex)
25			{
26			$this->doc = $doc;
27			$this->docIndex = $docIndex;
28			}
29
30			/**
31			* Generate ElasticSearch index payload.
32			*
33			* @return array
34			*/
35			public function toArray()
36			{
37			$body = $this->doc->bibliographic; // PHP makes a copy for us
38
39			$body['id'] = $this->doc->id;
40			$body['bibsys_id'] = $this->doc->bibsys_id;
41
42			// Remove some stuff we don't need
43			foreach (['agency', 'catalogingRules', 'debug', 'modified', 'extent', 'cover_image'] as $key) {
44			unset($body[$key]);
45			}
46
47			// Add local collections
48			$body['collections'] = [];
49			foreach ($this->doc->collections as $collection) {
50			$body['collections'][] = $collection['name'];
51			}
52
53			// Add cover
54			$body['cover'] = $this->doc->cover ? $this->doc->cover->toArray() : null;
55
56			// Add subjects
57			$body['subjects'] = [];
58			foreach ($this->doc->subjects as $subject) {
59			$body['subjects'][$subject['vocabulary'] ?: 'keywords'][] = [
60			'id' => array_get($subject, 'id'),
61			'prefLabel' => str_replace('--', ' : ', array_get($subject, 'term')),
62			'type' => array_get($subject, 'type'),
63			'count' => $this->docIndex->getUsageCount(array_get($subject, 'id'), 'subject'),
64			];
65			}
66
67			// Add genres
68			$body['genres'] = [];
69			foreach ($this->doc->genres as $genre) {
70			$body['genres'][$genre['vocabulary'] ?: 'keywords'][] = [
71			'id' => array_get($genre, 'id'),
72			'prefLabel' => array_get($genre, 'term'),
73			'count' => $this->docIndex->getUsageCount(array_get($genre, 'id'), 'genre'),
74			];
75			}
76
77			// Add holdings
78			$this->addHoldings($body, $this->doc);
79
80			// Add xisbns
81			$body['xisbns'] = (new XisbnResponse($this->doc->xisbn))->getSimpleRepr();
82
83			// Add description
84			$body['description'] = $this->doc->description;
85
86			// Add 'other form'
87			$otherFormId = array_get($body, 'other_form.id');
88			if (!empty($otherFormId)) {
89
90			// @TODO: https://github.com/scriptotek/colligator-backend/issues/34
91			// Not sure how to handle this in Alma yet
92			unset($body['other_form']);
93			// $otherFormDoc = Document::where('bibsys_id', '=', $otherFormId)->firstOrFail();
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-07-13 19:13 UTC by Report Bug Copy Issue Report `60%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
94			// $body['other_form'] = [
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-07-13 19:13 UTC by Report Bug Copy Issue Report `56%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
95			// 'id' => $otherFormDoc->id,
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-07-13 19:13 UTC by Report Bug Copy Issue Report `56%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
96			// 'bibsys_id' => $otherFormDoc->bibsys_id,
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-07-13 19:13 UTC by Report Bug Copy Issue Report `56%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
97			// 'electronic' => $otherFormDoc->isElectronic(),
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-07-13 19:13 UTC by Report Bug Copy Issue Report `64%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
98			// ];
99			// $this->addHoldings($body['other_form'], $otherFormDoc);
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-07-13 19:13 UTC by Report Bug Copy Issue Report `79%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
100			}
101
102			// Add 'cannot_find_cover'
103			$body['cannot_find_cover'] = $this->doc->cannot_find_cover;
104
105			return $body;
106			}
107
108			public function sortableCallCode($holding)
109			{
110			$m = preg_match($this->sortableCallCodePattern, array_get($holding, 'callcode'), $matches);
111			if ($m) {
112			return intval($matches[1]);
113			// TODO: Også ta hensyn til undersortering i $matches[3], men
114			// denne er en blanding av romertall og alfabetisk sortering
115			// https://github.com/scriptotek/colligator-backend/issues/28
116			}
117
118			return;
119			}
120
121			public function addHoldings(&$body, Document $doc)
122			{
123			if ($doc->isElectronic()) {
			0 ignored issues – show Unused Code introduced 2016-07-13 19:13 UTC by Report Bug Copy Issue Report This `if` statement is empty and can be removed. This check looks for the bodies of `if` statements that have no statements or where all statements have been commented out. This may be the result of changes for debugging or the code may simply be obsolete. These `if` bodies can be removed. If you have an empty if but statements in the `else` branch, consider inverting the condition. if (rand(1, 6) > 3) { //print "Check failed"; } else { print "Check succeeded"; } could be turned into if (rand(1, 6) <= 3) { print "Check succeeded"; } This is much more concise to read. Loading history...
124
125			// @ TODO: Virker ikke med Alma
126			// https://github.com/scriptotek/colligator-backend/issues/34
127			// $body['fulltext'] = $this->fulltextFromHoldings($doc->holdings);
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-07-13 19:13 UTC by Report Bug Copy Issue Report `65%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
128
129			} else {
130			$body['holdings'] = [];
131			foreach ($doc->holdings as $holding) {
132			array_forget($holding, 'fulltext');
133			array_forget($holding, 'bibliographic_record');
134			array_forget($holding, 'nonpublic_notes');
135			$s = $this->sortableCallCode($holding);
136			if (!is_null($s)) {
137			$holding['callcodeSortable'] = $s;
138			}
139			$body['holdings'][] = $holding;
140			}
141			}
142			}
143
144			public function fulltextFromHoldings($holdings)
145			{
146			$fulltext = [
147			'access' => false,
148			];
149			foreach ($holdings as $holding) {
150			if (!count($holding['fulltext'])) {
151			continue;
152			}
153			if ($holding['location'] == 'UBO' \|\| stripos($holding['fulltext'][0]['comment'], 'gratis') !== false) {
154			$fulltext = $holding['fulltext'][0];
155			$fulltext['access'] = true;
156			}
157			}
158
159			return $fulltext;
160			}
161			}
162

scriptotek / colligator-backend

SearchableDocument::toArray() C last analyzed 2018-08-07 10:50 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like

SearchableDocument::toArray() C
last analyzed 2018-08-07 10:50 UTC