[Doc] Add phpdoc and some comments.

.gitignore

@@ -3,4 +3,4 @@ Guardfile
 phpunit.xml
 /TestsProject/app/cache/
 /TestsProject/app/log/
-/vendor/
+/vendor/

DependencyInjection/Compiler/AddPagerfantasPass.php

@@ -22,6 +22,9 @@
  */
 class AddPagerfantasPass implements CompilerPassInterface
 {
+    /**
+     * @param ContainerBuilder $container
+     */
     public function process(ContainerBuilder $container)
     {
         if (!$container->hasDefinition('white_october_pagerfanta.view_factory')) {

DependencyInjection/WhiteOctoberPagerfantaExtension.php

@@ -32,13 +32,13 @@ class WhiteOctoberPagerfantaExtension extends Extension
      */
     public function load(array $configs, ContainerBuilder $container)
     {
-        $configuration = new Configuration();
-        $processor = new Processor();
+        $configuration  = new Configuration();
+        $processor      = new Processor();
 
         $config = $processor->processConfiguration($configuration, $configs);
         $container->setParameter('white_october_pagerfanta.default_view', $config['default_view']);
 
-        $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
+        $loader = new XmlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
         $loader->load('pagerfanta.xml');
 
         if ($config['exceptions_strategy']['out_of_range_page'] == Configuration::EXCEPTION_STRATEGY_TO_HTTP_NOT_FOUND) {

Resources/public/css/pagerfantaDefault.css

@@ -31,26 +31,3 @@
     border-color: #ccf;
     color: #ccf;
 }
-
-/*
-
-.pagerfanta a,
-.pagerfanta span {
-    border-color: blue;
-    color: blue;
-}
-
-.pagerfanta a:hover {
-    background: #ccf;
-}
-
-.pagerfanta .current {
-    background: #ccf;
-}
-
-.pagerfanta .disabled {
-    border-color: #ccf;
-    color: #cf;
-}
-
-*/

Tests/bootstrap.php

@@ -1,3 +1,3 @@
 <?php
 
-$loader = require __DIR__.'/../vendor/autoload.php';
+$loader = require __DIR__ . '/../vendor/autoload.php';

TestsProject/src/WhiteOctober/PagerfantaTestBundle/Controller/PagerfantaController.php

@@ -9,58 +9,91 @@
 
 class PagerfantaController extends Controller
 {
+    /**
+     * @return \Symfony\Component\HttpFoundation\Response
+     */
     public function defaultViewAction()
     {
         return $this->renderPagerfanta('defaultView');
     }
 
+    /**
+     * @return \Symfony\Component\HttpFoundation\Response
+     */
     public function twitterBootstrapViewAction()
     {
         return $this->renderPagerfanta('twitterBootstrapView');
     }
 
+    /**
+     * @return \Symfony\Component\HttpFoundation\Response
+     */
     public function twitterBootstrap3ViewAction()
     {
         return $this->renderPagerfanta('twitterBootstrap3View');
     }
 
+    /**
+     * @return \Symfony\Component\HttpFoundation\Response
+     */
     public function viewWithOptionsAction()
     {
         return $this->renderPagerfanta('viewWithOptions');
     }
 
+    /**
+     * @return \Symfony\Component\HttpFoundation\Response
+     */
     public function defaultTranslatedViewAction()
     {
         $this->setLocale('es');
 
         return $this->renderPagerfanta('defaultTranslatedView');
     }
 
+    /**
+     * @return \Symfony\Component\HttpFoundation\Response
+     */
     public function twitterBootstrapTranslatedViewAction()
     {
         $this->setLocale('es');
 
         return $this->renderPagerfanta('twitterBootstrapTranslatedView');
     }
 
+    /**
+     * @return \Symfony\Component\HttpFoundation\Response
+     */
     public function twitterBootstrap3TranslatedViewAction()
     {
         $this->setLocale('es');
 
         return $this->renderPagerfanta('twitterBootstrap3TranslatedView');
     }
 
+    /**
+     * @return \Symfony\Component\HttpFoundation\Response
+     */
     public function myView1Action()
     {
         return $this->renderPagerfanta('myView1');
     }
 
-
+    /**
+     * @param null $test
+     *
+     * @return \Symfony\Component\HttpFoundation\Response
+     */
     public function viewWithRouteParamsAction($test = null)
     {
         return $this->renderPagerfanta('viewWithRouteParams');
     }
 
+    /**
+     * @param Request $request
+     *
+     * @return \Symfony\Component\HttpFoundation\Response
+     */
     public function defaultWithRequestAction(Request $request)
     {
         $template = $this->buildTemplateName('defaultView');
@@ -73,6 +106,11 @@ public function defaultWithRequestAction(Request $request)
         ));
     }
 
+    /**
+     * @param $name
+     *
+     * @return \Symfony\Component\HttpFoundation\Response
+     */
     private function renderPagerfanta($name)
     {
         $template = $this->buildTemplateName($name);
@@ -84,18 +122,29 @@ private function renderPagerfanta($name)
 
     }
 
+    /**
+     * @param $name
+     *
+     * @return string
+     */
     private function buildTemplateName($name)
     {
         return sprintf('WhiteOctoberPagerfantaTestBundle:Pagerfanta:%s.html.twig', $name);
     }
 
+    /**
+     * @return Pagerfanta
+     */
     private function createPagerfanta()
     {
         $adapter = $this->createAdapter();
 
         return new Pagerfanta($adapter);
     }
 
+    /**
+     * @return FixedAdapter
+     */
     private function createAdapter()
     {
         $nbResults = 100;
@@ -104,8 +153,12 @@ private function createAdapter()
         return new FixedAdapter($nbResults, $results);
     }
 
+    /**
+     * @param $locale
+     */
     private function setLocale($locale)
     {
+        // getRequest method is deprecated since version 2.4, to be removed in 3.0
         $this->getRequest()->setLocale($locale);
     }
 }

TestsProject/src/WhiteOctober/PagerfantaTestBundle/Tests/Controller/PagerfantaControllerTest.php

@@ -244,7 +244,7 @@ private function assertView($view, $html)
     {
         $client = static::createClient();
 
-        $crawler = $client->request('GET', $this->buildViewUrl($view));
+        $client->request('GET', $this->buildViewUrl($view));
 
         $response = $client->getResponse();
         $this->assertSame(200, $response->getStatusCode());

Twig/PagerfantaExtension.php

@@ -130,6 +130,7 @@ private function createRouteGenerator($options = array())
         $pagePropertyPath = new PropertyPath($options['pageParameter']);
 
         return function($page) use($router, $routeName, $routeParams, $pagePropertyPath) {
+            // getPropertyAccessor method is deprecated since version 2.3, to be removed in 3.0
             $propertyAccessor = PropertyAccess::getPropertyAccessor();
             $propertyAccessor->setValue($routeParams, $pagePropertyPath, $page);
 

View/DefaultTranslatedView.php

@@ -20,21 +20,37 @@
  */
 class DefaultTranslatedView extends TranslatedView
 {
+    /**
+     * @return string
+     */
     protected function previousMessageOption()
     {
         return 'previous_message';
     }
 
+    /**
+     * @return string
+     */
     protected function nextMessageOption()
     {
         return 'next_message';
     }
 
+    /**
+     * @param string $text
+     *
+     * @return string
+     */
     protected function buildPreviousMessage($text)
     {
         return sprintf('« %s', $text);
     }
 
+    /**
+     * @param string $text
+     *
+     * @return string
+     */
     protected function buildNextMessage($text)
     {
         return sprintf('%s »', $text);

View/TranslatedView.php

@@ -99,11 +99,17 @@ private function nextMessage()
         return $this->buildNextMessage($nextText);
     }
 
+    /**
+     * @return string
+     */
     private function previousText()
     {
         return $this->translator->trans('previous', array(), 'pagerfanta');
     }
 
+    /**
+     * @return string
+     */
     private function nextText()
     {
         return $this->translator->trans('next', array(), 'pagerfanta');

View/TwitterBootstrapTranslatedView.php

@@ -18,21 +18,37 @@
  */
 class TwitterBootstrapTranslatedView extends TranslatedView
 {
+    /**
+     * @return string
+     */
     protected function previousMessageOption()
     {
         return 'prev_message';
     }
 
+    /**
+     * @return string
+     */
     protected function nextMessageOption()
     {
         return 'next_message';
     }
 
+    /**
+     * @param string $text
+     *
+     * @return string
+     */
     protected function buildPreviousMessage($text)
     {
         return sprintf('← %s', $text);
     }
 
+    /**
+     * @param string $text
+     *
+     * @return string
+     */
     protected function buildNextMessage($text)
     {
         return sprintf('%s →', $text);