Fix CS/doc for PR #303

Author: willdurand

README.md

@@ -17,7 +17,7 @@ Currently, there are the following adapters:
 * `CurlHttpAdapter` to use [cURL](http://php.net/manual/book.curl.php);
 * `GuzzleHttpAdapter` to use [Guzzle](https://github.com/guzzle/guzzle), PHP 5.3+ HTTP client and framework for building RESTful web service clients;
 * `SocketHttpAdapter` to use a [socket](http://www.php.net/manual/function.fsockopen.php);
-* `ZendHttpAdapter` to use [Zend Http Client](http://framework.zend.com/manual/2.0/en/modules/zend.http.client.html).
+* `ZendHttpAdapter` to use [Zend Http Client](http://framework.zend.com/manual/2.0/en/modules/zend.http.client.html);
 * `GeoIP2Adapter` to use [GeoIP2 Database Reader](https://github.com/maxmind/GeoIP2-php#database-reader) or the [Webservice Client](https://github.com/maxmind/GeoIP2-php#web-service-client) by MaxMind.
 
 
@@ -265,23 +265,33 @@ be used in production. For more information, please read [issue #301](https://gi
 
 ### GeoIP2DatabaseProvider ###
 
-The `GeoIP2Provider` named `maxmind_geoip2` is able to geocode **IPv4 and IPv6 addresses**
-only - it makes use of the MaxMind GeoIP2 databases or the webservice.
+The `GeoIP2Provider` named `maxmind_geoip2` is able to geocode **IPv4 and IPv6
+addresses** only - it makes use of the MaxMind GeoIP2 databases or the
+webservice.
 
-It requires either the [database file](http://dev.maxmind.com/geoip/geoip2/geolite2/), or the [webservice](http://dev.maxmind.com/geoip/geoip2/web-services/) - represented by the GeoIP2 Provider, which is injected to the `GeoIP2Adapter`. The [geoip2/geoip2](https://packagist.org/packages/geoip2/geoip2) package must be installed.
+It requires either the [database
+file](http://dev.maxmind.com/geoip/geoip2/geolite2/), or the
+[webservice](http://dev.maxmind.com/geoip/geoip2/web-services/) - represented by
+the GeoIP2 Provider, which is injected to the `GeoIP2Adapter`. The
+[geoip2/geoip2](https://packagist.org/packages/geoip2/geoip2) package must be
+installed.
 
 This provider will only work with the corresponding `GeoIP2Adapter`.
 
-**Usage:**
+##### Usage
 
-	// Maxmind GeoIP2 Provider: e.g. the database reader
-	$reader = new \GeoIp2\Database\Reader('/path/to/database'); 
+``` php
+<?php
 
-    $adapter = new \Geocoder\HttpAdapter\GeoIP2Adapter($reader);
-    $provider = new \Geocoder\Provider\GeoIP2Provider($adapter);
-    $geocoder = new \Geocoder\Geocoder($provider);
+// Maxmind GeoIP2 Provider: e.g. the database reader
+$reader   = new \GeoIp2\Database\Reader('/path/to/database');
 
-    $result = $geocoder->geocode('74.200.247.59');
+$adapter  = new \Geocoder\HttpAdapter\GeoIP2Adapter($reader);
+$provider = new \Geocoder\Provider\GeoIP2Provider($adapter);
+$geocoder = new \Geocoder\Geocoder($provider);
+
+$result   = $geocoder->geocode('74.200.247.59');
+```
 
 ### GeonamesProvider ###
 

src/Geocoder/HttpAdapter/GeoIP2Adapter.php

@@ -42,8 +42,8 @@ class GeoIP2Adapter implements HttpAdapterInterface
     protected $locale;
 
     /**
-     * @param \GeoIp2\ProviderInterface $geoIpProvider
-     * @param string $geoIP2Model (e.g. self::GEOIP2_MODEL_CITY)
+     * @param  \GeoIp2\ProviderInterface                $geoIpProvider
+     * @param  string                                   $geoIP2Model   (e.g. self::GEOIP2_MODEL_CITY)
      * @throws \Geocoder\Exception\UnsupportedException
      * @internal param string $dbFile
      */
@@ -61,7 +61,7 @@ public function __construct(ProviderInterface $geoIpProvider, $geoIP2Model = sel
     }
 
     /**
-     * @param string $locale
+     * @param  string $locale
      * @return $this
      */
     public function setLocale($locale)
@@ -82,7 +82,7 @@ public function getLocale()
     /**
      * Returns the content fetched from a given resource.
      *
-     * @param string $url (e.g. file://database?127.0.0.1)
+     * @param  string                                       $url (e.g. file://database?127.0.0.1)
      * @throws \Geocoder\Exception\UnsupportedException
      * @throws \Geocoder\Exception\InvalidArgumentException
      * @return string
@@ -121,7 +121,7 @@ public function getName()
     /**
      * Returns whether method is supported by GeoIP2
      *
-     * @param string $method
+     * @param  string $method
      * @return bool
      */
     protected function isSupportedGeoIP2Model($method)

src/Geocoder/Provider/GeoIP2Provider.php

@@ -80,7 +80,7 @@ public function getName()
     }
 
     /**
-     * @param string $address
+     * @param  string                                $address
      * @throws \Geocoder\Exception\NoResultException
      * @return City
      */

src/Geocoder/Provider/GoogleMapsProvider.php

@@ -146,7 +146,7 @@ protected function executeQuery($query)
             throw new NoResultException(sprintf('Could not execute query %s', $query));
         }
 
-        if('REQUEST_DENIED' === $json->status && 'The provided API key is invalid.' === $json->error_message) {
+        if ('REQUEST_DENIED' === $json->status && 'The provided API key is invalid.' === $json->error_message) {
             throw new InvalidCredentialsException(sprintf('API key is invalid %s', $query));
         }
 

src/Geocoder/Provider/MaxMindBinaryProvider.php

@@ -10,7 +10,6 @@
 
 namespace Geocoder\Provider;
 
-use Geocoder\Provider\ProviderInterface;
 use Geocoder\Exception\NoResultException;
 use Geocoder\Exception\InvalidArgumentException;
 use Geocoder\Exception\RuntimeException;

tests/Geocoder/Tests/HttpAdapter/GeoIP2AdapterTest.php

@@ -14,7 +14,6 @@
 use Geocoder\Tests\TestCase;
 use Geocoder\Exception\RuntimeException;
 use GeoIp2\Database\Reader;
-use GeoIp2\WebService\Client;
 
 /**
  * @author Jens Wiese <jens@howtrueisfalse.de>
@@ -143,7 +142,7 @@ protected function getGeoIP2ProviderMock()
     }
 
     /**
-     * @param int $geoIP2Model (e.g. GeoIP2Adapter::GEOIP2_MODEL_
+     * @param  int                                      $geoIP2Model (e.g. GeoIP2Adapter::GEOIP2_MODEL_
      * @return \PHPUnit_Framework_MockObject_MockObject
      */
     protected function getGeoIP2ModelMock($geoIP2Model)
@@ -175,4 +174,3 @@ protected function getGeoIP2ModelMock($geoIP2Model)
         return $mock;
     }
 }
- 

tests/Geocoder/Tests/Provider/GeoIP2ProviderTest.php

@@ -163,7 +163,7 @@ public function testRetrievingGeodataNotExistingLocation()
     }
 
     /**
-     * @param mixed $returnValue
+     * @param  mixed                                    $returnValue
      * @return \PHPUnit_Framework_MockObject_MockObject | GeoIP2DatabaseAdapter
      */
     public function getGeoIP2AdapterMock($returnValue = '')