scriptotek / colligator-backend

app/DescriptionScraper.php

Doc Comments +8 added lines, -1 removed lines

@@ -15,7 +15,6 @@ 
     /**
      * Create a new scraper.
      *
-     * @param Client $client
      */
     public function __construct()
     {
@@ -35,6 +34,11 @@ 
         }
     }
 
+    /**
+     * @param string $msg
+     * @param Document $doc
+     * @param string[] $args
+     */
     public function notify($msg, $doc, $args, $level = 'warning')
     {
         $msg = vsprintf($msg, $args);
@@ -46,6 +50,9 @@ 
         ])->send();
     }
 
+    /**
+     * @param string $url
+     */
     public function scrape($url)
     {
         foreach ($this->scrapers as $scraper) {

Spacing +7 added lines, -7 removed lines

@@ -40,8 +40,8 @@ 
         $msg = vsprintf($msg, $args);
         $docLink = sprintf('<http://colligator.biblionaut.net/api/documents/%s|#%s> ', $doc->id, $doc->id);
         \Slack::attach([
-            'fallback' => '#' . $doc->id . ' ' . $msg,
-            'text'     => $docLink . $msg,
+            'fallback' => '#'.$doc->id.' '.$msg,
+            'text'     => $docLink.$msg,
             'color'    => $level,
         ])->send();
     }
@@ -65,10 +65,10 @@ 
      */
     public function updateDocument(Document $doc, $url)
     {
-        \Log::debug('[DescriptionScraper] Looking for decription for ' . $doc->id . ' at ' . $url);
+        \Log::debug('[DescriptionScraper] Looking for decription for '.$doc->id.' at '.$url);
 
         if (preg_match('/(damm.no)/', $url)) {
-            \Log::debug('[DescriptionScraper] Ignoring URL: ' . $url);
+            \Log::debug('[DescriptionScraper] Ignoring URL: '.$url);
 
             return;
         }
@@ -76,18 +76,18 @@ 
         try {
             $result = $this->scrape($url);
         } catch (TransferException $e) {
-            \Log::error('[DescriptionScraper] Transfer failed: ' . $e->getMessage());
+            \Log::error('[DescriptionScraper] Transfer failed: '.$e->getMessage());
             $this->notify('*DescriptionScraper* failed to fetch: %s', $doc, [$url]);
 
             return;
         } catch (Scrapers\ScrapeException $e) {
-            \Log::error('[DescriptionScraper] Scraping of ' . $url . ' failed: ' . $e->getMessage());
+            \Log::error('[DescriptionScraper] Scraping of '.$url.' failed: '.$e->getMessage());
             $this->notify('*DescriptionScraper* / %s failed to find a text at: %s', $doc, [$e->getMessage(), $url]);
 
             return;
         }
         if (is_null($result)) {
-            \Log::error('Encountered URL not recognized by any scraper: ' . $url);
+            \Log::error('Encountered URL not recognized by any scraper: '.$url);
             $this->notify('*DescriptionScraper* encountered URL not recognized by any sraper: %s', $doc, [$url]);
 
             return;

app/Http/Controllers/CollectionsController.php

Doc Comments +2 added lines, -2 removed lines

@@ -10,7 +10,7 @@ 
     /**
      * Display a listing of the resource.
      *
-     * @return Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function index()
     {
@@ -24,7 +24,7 @@ 
      *
      * @param int $id
      *
-     * @return Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function show($id)
     {

app/Search/DocumentsIndex.php

Doc Comments +17 added lines, -1 removed lines

@@ -168,6 +168,7 @@ 
      * Returns the number of documents the subject is used on.
      *
      * @param int $id
+     * @param string $type
      *
      * @return int
      */
@@ -185,8 +186,8 @@ 
     /**
      * Build an array of document usage count per subject.
      *
-     * @param array|int $subject_ids
      *
+     * @param integer $entity_ids
      * @return array
      */
     public function addToUsageCache($entity_ids, $type)
@@ -264,6 +265,9 @@ 
         $this->index(Document::with('subjects', 'cover')->findOrFail($docId));
     }
 
+    /**
+     * @param integer $version
+     */
     public function createVersion($version = null)
     {
         if (is_null($version)) {
@@ -307,6 +311,9 @@ 
         return $version;
     }
 
+    /**
+     * @param integer $version
+     */
     public function dropVersion($version)
     {
         try {
@@ -318,6 +325,9 @@ 
         }
     }
 
+    /**
+     * @param string $action
+     */
     public function addAction(&$actions, $action, $version)
     {
         if ($version) {
@@ -325,6 +335,9 @@ 
         }
     }
 
+    /**
+     * @param integer $newVersion
+     */
     public function activateVersion($newVersion)
     {
         $oldVersion = $this->getCurrentVersion();
@@ -336,6 +349,9 @@ 
         }
     }
 
+    /**
+     * @param integer $version
+     */
     public function versionExists($version)
     {
         return $this->client->indices()->exists(['index' => $this->esIndex . '_v' . $version]);

Spacing +19 added lines, -19 removed lines

@@ -100,7 +100,7 @@ 
     public function sanitizeForQuery($value)
     {
         $chars = preg_quote('\\+-&|!(){}[]^~*?:');
-        $value = preg_replace('/([' . $chars . '])/', '\\\\\1', $value);
+        $value = preg_replace('/(['.$chars.'])/', '\\\\\1', $value);
 
         return $value;
         //
@@ -132,20 +132,20 @@ 
         }
         if ($request->has('collection')) {
             $col = Collection::findOrFail($request->collection);
-            $query[] = 'collections:"' . $this->sanitizeForQuery($col->name) . '"';
+            $query[] = 'collections:"'.$this->sanitizeForQuery($col->name).'"';
         }
         if ($request->has('subject')) {
-            $query[] = '(subjects.noubomn.prefLabel:"' . $this->sanitizeForQuery($request->subject) . '"' .
-                    ' OR subjects.bare.prefLabel:"' . $this->sanitizeForQuery($request->subject) . '"' .
-                    ' OR genres.noubomn.prefLabel:"' . $this->sanitizeForQuery($request->subject) . '")';
+            $query[] = '(subjects.noubomn.prefLabel:"'.$this->sanitizeForQuery($request->subject).'"'.
+                    ' OR subjects.bare.prefLabel:"'.$this->sanitizeForQuery($request->subject).'"'.
+                    ' OR genres.noubomn.prefLabel:"'.$this->sanitizeForQuery($request->subject).'")';
                 // TODO: Vi bør vel antakelig skille mellom X som emne og X som form/sjanger ?
                 //       Men da må frontend si fra hva den ønsker, noe den ikke gjør enda.
         }
         if ($request->has('language')) {
-            $query[] = 'language:"' . $this->sanitizeForQuery($request->language) . '"' ;
+            $query[] = 'language:"'.$this->sanitizeForQuery($request->language).'"';
         }
         if ($request->has('genre')) {
-            $query[] = 'genres.noubomn.prefLabel:"' . $this->sanitizeForQuery($request->genre) . '"';
+            $query[] = 'genres.noubomn.prefLabel:"'.$this->sanitizeForQuery($request->genre).'"';
         }
         if ($request->has('real')) {
             dd('`real` is (very) deprecated, please use `subject` instead.');
@@ -183,7 +183,7 @@ 
     public function getUsageCount($id, $type)
     {
         $this->getFullType($type);
-        $arg = $type . '.' . $id;
+        $arg = $type.'.'.$id;
         if (is_null(array_get($this->usage, $arg))) {
             $this->addToUsageCache($id, $type);
         }
@@ -212,11 +212,11 @@ 
             ->get();
 
         foreach ($entity_ids as $sid) {
-            array_set($this->usage, $type . '.' . $sid, 0);
+            array_set($this->usage, $type.'.'.$sid, 0);
         }
 
         foreach ($res as $row) {
-            array_set($this->usage, $type . '.' . $row->entity_id, intval($row->doc_count));
+            array_set($this->usage, $type.'.'.$row->entity_id, intval($row->doc_count));
         }
     }
 
@@ -226,10 +226,10 @@ 
         $query = \DB::table('entities')
                     ->select(['entity_id', 'entity_type', \DB::raw('count(document_id) as doc_count')])
                     ->groupBy('entity_id', 'entity_type');
-        $query->orderBy('entity_id')->orderBy('entity_type')->chunk(5000, function ($rows) use ($typemap) {
+        $query->orderBy('entity_id')->orderBy('entity_type')->chunk(5000, function($rows) use ($typemap) {
             foreach ($rows as $row) {
                 $type = $typemap[$row->entity_type];
-                array_set($this->usage, $type . '.' . $row->entity_id, intval($row->doc_count));
+                array_set($this->usage, $type.'.'.$row->entity_id, intval($row->doc_count));
             }
         });
     }
@@ -246,7 +246,7 @@ 
     {
         $payload = $this->basePayload();
         if (!is_null($indexVersion)) {
-            $payload['index'] = $this->esIndex . '_v' . $indexVersion;
+            $payload['index'] = $this->esIndex.'_v'.$indexVersion;
         }
         $payload['id'] = $doc->id;
 
@@ -256,8 +256,8 @@ 
         try {
             $this->client->index($payload);
         } catch (BadRequest400Exception $e) {
-            \Log::error('ElasticSearch returned error: ' . $e->getMessage() . '. Our request: ' . var_export($payload, true));
-            throw new \ErrorException('ElasticSearch failed to index the document ' . $doc->id . '. Please see the log for payload and full error response. Error message: ' . $e->getMessage());
+            \Log::error('ElasticSearch returned error: '.$e->getMessage().'. Our request: '.var_export($payload, true));
+            throw new \ErrorException('ElasticSearch failed to index the document '.$doc->id.'. Please see the log for payload and full error response. Error message: '.$e->getMessage());
         }
     }
 
@@ -278,7 +278,7 @@ 
         if (is_null($version)) {
             $version = $this->getCurrentVersion() + 1;
         }
-        $indexParams = ['index' => $this->esIndex . '_v' . $version];
+        $indexParams = ['index' => $this->esIndex.'_v'.$version];
         $indexParams['body']['settings']['analysis']['char_filter']['isbn_filter'] = [
             'type'        => 'pattern_replace',
             'pattern'     => '-',
@@ -326,7 +326,7 @@ 
     {
         try {
             $this->client->indices()->delete([
-                'index' => $this->esIndex . '_v' . $version,
+                'index' => $this->esIndex.'_v'.$version,
             ]);
         } catch (Missing404Exception $e) {
             # Didn't exist in the beginning, that's ok.
@@ -336,7 +336,7 @@ 
     public function addAction(&$actions, $action, $version)
     {
         if ($version) {
-            $actions[] = [$action => ['index' => $this->esIndex . '_v' . $version, 'alias' => $this->esIndex]];
+            $actions[] = [$action => ['index' => $this->esIndex.'_v'.$version, 'alias' => $this->esIndex]];
         }
     }
 
@@ -353,7 +353,7 @@ 
 
     public function versionExists($version)
     {
-        return $this->client->indices()->exists(['index' => $this->esIndex . '_v' . $version]);
+        return $this->client->indices()->exists(['index' => $this->esIndex.'_v'.$version]);
     }
 
     public function getCurrentVersion()

app/Scrapers/BsScraper.php

Spacing +1 added lines, -1 removed lines

@@ -56,7 +56,7 @@
 
     public function scrape(Crawler $crawler)
     {
-        $texts = $crawler->filter('#accordion > *')->each(function (Crawler $node) {
+        $texts = $crawler->filter('#accordion > *')->each(function(Crawler $node) {
             return $node->text();
         });
 

app/Scrapers/FluxScraper.php

Spacing +1 added lines, -1 removed lines

@@ -13,7 +13,7 @@
 
     public function scrape(Crawler $crawler)
     {
-        $texts = $crawler->filter('.productPageBody > p')->each(function (Crawler $node) {
+        $texts = $crawler->filter('.productPageBody > p')->each(function(Crawler $node) {
             return $node->text();
         });
         $text = implode('\n\n', $texts);

app/Scrapers/UnivScraper.php

Spacing +1 added lines, -1 removed lines

@@ -13,7 +13,7 @@
 
     public function scrape(Crawler $crawler)
     {
-        $texts = $crawler->filter('.book-details > div')->each(function (Crawler $node) {
+        $texts = $crawler->filter('.book-details > div')->each(function(Crawler $node) {
             if (strpos($node->attr('class'), 'row') === false) {
                 return $node->text();
             }

app/Search/SearchableDocument.php

Spacing +1 added lines, -1 removed lines

@@ -29,7 +29,7 @@
      */
     public function toArray()
     {
-        $body = $this->doc->bibliographic;  // PHP makes a copy for us
+        $body = $this->doc->bibliographic; // PHP makes a copy for us
 
         $body['id'] = $this->doc->id;
         $body['bibsys_id'] = $this->doc->bibsys_id;

app/XisbnResponse.php

Spacing +5 added lines, -5 removed lines

@@ -10,12 +10,12 @@ 
         'AA'    => 'audio',
         'AA BA' => 'audio book',
         'BA'    => 'book',
-        'BA DA' => 'ebook',      // Yes, we DO actually get these
+        'BA DA' => 'ebook', // Yes, we DO actually get these
         'BB'    => 'hardcover',
-        'BB BC' => 'book',       // ... and these
-        'BB DA' => 'ebook',      // ... and these
+        'BB BC' => 'book', // ... and these
+        'BB DA' => 'ebook', // ... and these
         'BC'    => 'paperback',
-        'BC DA' => 'ebook',      // ... and these
+        'BC DA' => 'ebook', // ... and these
         'DA'    => 'digital',
         'FA'    => 'film/transp.',
         'MA'    => 'microform',
@@ -49,7 +49,7 @@ 
         if (isset($this->formats[$formStr])) {
             return $this->formats[$formStr];
         }
-        $formStr = implode(' ', array_map(function ($el) {
+        $formStr = implode(' ', array_map(function($el) {
             return $this->formats[$el];
         }, $forms));
         \Log::warning(sprintf('Unknown form: %s', $formStr));

app/Console/Commands/Reindex.php

Spacing +4 added lines, -4 removed lines

@@ -40,7 +40,7 @@ 
         //$docIndex->dropVersion();
         $oldVersion = $docIndex->getCurrentVersion();
         $newVersion = $oldVersion + 1;
-        $this->comment(' Old version: ' . $oldVersion . ', new version: ' . $newVersion);
+        $this->comment(' Old version: '.$oldVersion.', new version: '.$newVersion);
 
         if ($docIndex->versionExists($newVersion)) {
             $this->comment(' New version already existed, probably from a crashed job. Removing.');
@@ -58,7 +58,7 @@ 
         $docCount = Document::count();
         $this->output->progressStart($docCount);
 
-        Document::with('subjects', 'genres', 'cover')->chunk(1000, function ($docs) use ($docIndex, $newVersion) {
+        Document::with('subjects', 'genres', 'cover')->chunk(1000, function($docs) use ($docIndex, $newVersion) {
             foreach ($docs as $doc) {
                 $docIndex->index($doc, $newVersion);
                 $this->output->progressAdvance();
@@ -73,7 +73,7 @@ 
         $docIndex->dropVersion($oldVersion);
 
         $dt = microtime(true) - $t0;
-        $this->info(' Completed in ' . round($dt) . ' seconds.');
-        \Log::info('[ReindexJob] Completed in ' . round($dt) . ' seconds.');
+        $this->info(' Completed in '.round($dt).' seconds.');
+        \Log::info('[ReindexJob] Completed in '.round($dt).' seconds.');
     }
 }