fix cs and phpdoc

[github/wallabag/wallabag.git] / tests / Wallabag / AnnotationBundle / Controller / AnnotationControllerTest.php

diff --git a/tests/Wallabag/AnnotationBundle/Controller/AnnotationControllerTest.php b/tests/Wallabag/AnnotationBundle/Controller/AnnotationControllerTest.php
index 70849f74129000ca787a0a414396feb478516f81..9b2a6f8dd513b97cb88ddaed56353af7c16f5b41 100644 (file)
--- a/tests/Wallabag/AnnotationBundle/Controller/AnnotationControllerTest.php
+++ b/tests/Wallabag/AnnotationBundle/Controller/AnnotationControllerTest.php
@@ -3,11 +3,17 @@
 namespace Tests\AnnotationBundle\Controller;
 
 use Tests\Wallabag\AnnotationBundle\WallabagAnnotationTestCase;
+use Wallabag\AnnotationBundle\Entity\Annotation;
+use Wallabag\CoreBundle\Entity\Entry;
 
 class AnnotationControllerTest extends WallabagAnnotationTestCase
 {
+    /**
+     * Test fetching annotations for an entry
+     */
     public function testGetAnnotations()
     {
+        /** @var Annotation $annotation */
         $annotation = $this->client->getContainer()
             ->get('doctrine.orm.entity_manager')
             ->getRepository('WallabagAnnotationBundle:Annotation')
@@ -18,7 +24,7 @@ class AnnotationControllerTest extends WallabagAnnotationTestCase
         }
 
         $this->logInAs('admin');
-        $crawler = $this->client->request('GET', 'annotations/'.$annotation->getEntry()->getId().'.json');
+        $this->client->request('GET', 'annotations/'.$annotation->getEntry()->getId().'.json');
         $this->assertEquals(200, $this->client->getResponse()->getStatusCode());
 
         $content = json_decode($this->client->getResponse()->getContent(), true);
@@ -26,10 +32,14 @@ class AnnotationControllerTest extends WallabagAnnotationTestCase
         $this->assertEquals($annotation->getText(), $content['rows'][0]['text']);
     }
 
+    /**
+     * Test creating an annotation for an entry
+     */
     public function testSetAnnotation()
     {
         $this->logInAs('admin');
 
+        /** @var Entry $entry */
         $entry = $this->client->getContainer()
             ->get('doctrine.orm.entity_manager')
             ->getRepository('WallabagCoreBundle:Entry')
@@ -41,7 +51,7 @@ class AnnotationControllerTest extends WallabagAnnotationTestCase
             'quote' => 'my quote',
             'ranges' => ['start' => '', 'startOffset' => 24, 'end' => '', 'endOffset' => 31],
         ]);
-        $crawler = $this->client->request('POST', 'annotations/'.$entry->getId().'.json', [], [], $headers, $content);
+        $this->client->request('POST', 'annotations/'.$entry->getId().'.json', [], [], $headers, $content);
 
         $this->assertEquals(200, $this->client->getResponse()->getStatusCode());
 
@@ -52,6 +62,7 @@ class AnnotationControllerTest extends WallabagAnnotationTestCase
         $this->assertEquals('my annotation', $content['text']);
         $this->assertEquals('my quote', $content['quote']);
 
+        /** @var Annotation $annotation */
         $annotation = $this->client->getContainer()
             ->get('doctrine.orm.entity_manager')
             ->getRepository('WallabagAnnotationBundle:Annotation')
@@ -60,8 +71,12 @@ class AnnotationControllerTest extends WallabagAnnotationTestCase
         $this->assertEquals('my annotation', $annotation->getText());
     }
 
+    /**
+     * Test editing an existing annotation
+     */
     public function testEditAnnotation()
     {
+        /** @var Annotation $annotation */
         $annotation = $this->client->getContainer()
             ->get('doctrine.orm.entity_manager')
             ->getRepository('WallabagAnnotationBundle:Annotation')
@@ -73,7 +88,7 @@ class AnnotationControllerTest extends WallabagAnnotationTestCase
         $content = json_encode([
             'text' => 'a modified annotation',
         ]);
-        $crawler = $this->client->request('PUT', 'annotations/'.$annotation->getId().'.json', [], [], $headers, $content);
+        $this->client->request('PUT', 'annotations/'.$annotation->getId().'.json', [], [], $headers, $content);
         $this->assertEquals(200, $this->client->getResponse()->getStatusCode());
 
         $content = json_decode($this->client->getResponse()->getContent(), true);
@@ -83,6 +98,7 @@ class AnnotationControllerTest extends WallabagAnnotationTestCase
         $this->assertEquals('a modified annotation', $content['text']);
         $this->assertEquals('my quote', $content['quote']);
 
+        /** @var Annotation $annotationUpdated */
         $annotationUpdated = $this->client->getContainer()
             ->get('doctrine.orm.entity_manager')
             ->getRepository('WallabagAnnotationBundle:Annotation')
@@ -90,8 +106,12 @@ class AnnotationControllerTest extends WallabagAnnotationTestCase
         $this->assertEquals('a modified annotation', $annotationUpdated->getText());
     }
 
+    /**
+     * Test deleting an annotation
+     */
     public function testDeleteAnnotation()
     {
+        /** @var Annotation $annotation */
         $annotation = $this->client->getContainer()
             ->get('doctrine.orm.entity_manager')
             ->getRepository('WallabagAnnotationBundle:Annotation')
@@ -103,7 +123,7 @@ class AnnotationControllerTest extends WallabagAnnotationTestCase
         $content = json_encode([
             'text' => 'a modified annotation',
         ]);
-        $crawler = $this->client->request('DELETE', 'annotations/'.$annotation->getId().'.json', [], [], $headers, $content);
+        $this->client->request('DELETE', 'annotations/'.$annotation->getId().'.json', [], [], $headers, $content);
         $this->assertEquals(200, $this->client->getResponse()->getStatusCode());
 
         $content = json_decode($this->client->getResponse()->getContent(), true);