scriptotek / colligator-backend

app/CachedImage.php

Doc Comments +6 added lines

@@ -13,6 +13,9 @@ 
     public $maxHeight;
     protected $_metadata;
 
+    /**
+     * @param string $url
+     */
     public function __construct($url, $maxHeight = 0, AdapterInterface $filesystem = null, ImageManager $imageManager = null)
     {
         $this->sourceUrl = $url;
@@ -37,6 +40,9 @@ 
         return $this->_metadata;
     }
 
+    /**
+     * @param string $file
+     */
     protected function setMetadata($file, Image $img)
     {
         $this->_metadata = [

app/Cover.php

Doc Comments +1 added lines, -1 removed lines

@@ -37,7 +37,7 @@
     /**
      * The document the cover belongs to.
      *
-     * @return Document
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
      */
     public function document()
     {

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) {

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/Http/Controllers/DocumentsController.php

Doc Comments +5 added lines, -5 removed lines

@@ -13,7 +13,7 @@ 
     /**
      * Display a listing of the resource.
      *
-     * @return Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function index(SearchDocumentsRequest $request, DocumentsIndex $se)
     {
@@ -65,7 +65,7 @@ 
      * @param DocumentsIndex $se
      * @param int            $id
      *
-     * @return Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function show(Request $request, DocumentsIndex $se, $id)
     {
@@ -125,7 +125,7 @@ 
     /**
      * Show cover.
      *
-     * @return Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function cover($document_id)
     {
@@ -139,7 +139,7 @@ 
     /**
      * Store cover.
      *
-     * @return Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function storeCover($document_id, Request $request, DocumentsIndex $se)
     {
@@ -171,7 +171,7 @@ 
     /**
      * Store description.
      *
-     * @return Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function storeDescription($document_id, Request $request, DocumentsIndex $se)
     {

Unused Use Statements -1 removed lines

@@ -2,7 +2,6 @@
 
 namespace Colligator\Http\Controllers;
 
-use Colligator\Cover;
 use Colligator\Document;
 use Colligator\Http\Requests\SearchDocumentsRequest;
 use Colligator\Search\DocumentsIndex;

app/Http/Controllers/OntosaurController.php

Doc Comments +2 added lines, -2 removed lines

@@ -9,7 +9,7 @@ 
     /**
      * Display a listing of the resource.
      *
-     * @return Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function index()
     {
@@ -21,7 +21,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 +1 added lines, -1 removed lines

@@ -217,7 +217,7 @@
         $query = \DB::table('entities')
                     ->select(['entity_id', 'entity_type', \DB::raw('count(document_id) as doc_count')])
                     ->groupBy('entity_id', 'entity_type');
-        $query->chunk(5000, function ($rows) use ($typemap) {
+        $query->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));

app/Console/Commands/OaiPmhHarvest.php

Spacing +3 added lines, -3 removed lines

@@ -154,11 +154,11 @@ 
         // For timing
         $this->startTime = $this->batchTime = microtime(true) - 1;
 
-        \Event::listen('Colligator\Events\OaiPmhHarvestStatus', function ($event) {
+        \Event::listen('Colligator\Events\OaiPmhHarvestStatus', function($event) {
             $this->status($event->harvested, $event->position, $event->total);
         });
 
-        \Event::listen('Colligator\Events\OaiPmhHarvestComplete', function ($event) {
+        \Event::listen('Colligator\Events\OaiPmhHarvestComplete', function($event) {
             $this->info(sprintf('[%s] Harvest complete, got %d records in %d seconds',
                 strftime('%Y-%m-%d %H:%M:%S'),
                 $event->count,
@@ -166,7 +166,7 @@ 
             ));
         });
 
-        \Event::listen('Colligator\Events\JobError', function ($event) {
+        \Event::listen('Colligator\Events\JobError', function($event) {
             \Log::error('[OaiPmhHarvest] ' . $event->msg);
             $this->error($event->msg);
         });

app/Console/Commands/Reindex.php

Spacing +1 added lines, -1 removed lines

@@ -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();