Update the readme (#704)

* Improving the readme

* More docs updates

* More readme

* Minor fixes

* Minor fixes

* minor

* Minor

* MInor

* Alwasy use snake_case on provider name

* Added docs about stateful geocoder

* Bugfix

* Bugfix

Author: Nyholm

ProviderAggregator.php

@@ -41,7 +41,7 @@ class ProviderAggregator implements Geocoder
     /**
      * @param int $limit
      */
-    public function __construct($limit = Geocoder::DEFAULT_RESULT_LIMIT)
+    public function __construct(int $limit = Geocoder::DEFAULT_RESULT_LIMIT)
     {
         $this->limit($limit);
     }
@@ -67,7 +67,7 @@ public function reverseQuery(ReverseQuery $query): Collection
      */
     public function getName(): string
     {
-        return 'ProviderAggregator';
+        return 'provider_aggregator';
     }
 
     /**
@@ -89,19 +89,21 @@ public function reverse($latitude, $longitude): Collection
     }
 
     /**
-     * {@inheritdoc}
+     * @param $limit
+     *
+     * @return $this
      */
-    public function limit($limit)
+    public function limit(int $limit): self
     {
         $this->limit = $limit;
 
         return $this;
     }
 
     /**
-     * {@inheritdoc}
+     * @return int
      */
-    public function getLimit()
+    public function getLimit(): int
     {
         return $this->limit;
     }
@@ -113,7 +115,7 @@ public function getLimit()
      *
      * @return ProviderAggregator
      */
-    public function registerProvider(Provider $provider)
+    public function registerProvider(Provider $provider): self
     {
         $this->providers[$provider->getName()] = $provider;
 
@@ -127,7 +129,7 @@ public function registerProvider(Provider $provider)
      *
      * @return ProviderAggregator
      */
-    public function registerProviders(array $providers = [])
+    public function registerProviders(array $providers = []): self
     {
         foreach ($providers as $provider) {
             $this->registerProvider($provider);
@@ -143,7 +145,7 @@ public function registerProviders(array $providers = [])
      *
      * @return ProviderAggregator
      */
-    public function using($name)
+    public function using(string $name): self
     {
         if (!isset($this->providers[$name])) {
             throw new ProviderNotRegistered($name ?? '');
@@ -159,7 +161,7 @@ public function using($name)
      *
      * @return Provider[]
      */
-    public function getProviders()
+    public function getProviders(): array
     {
         return $this->providers;
     }
@@ -168,8 +170,10 @@ public function getProviders()
      * Returns the current provider in use.
      *
      * @return Provider
+     *
+     * @throws \RuntimeException
      */
-    protected function getProvider()
+    protected function getProvider(): Provider
     {
         if (null === $this->provider) {
             if (0 === count($this->providers)) {

StatefulGeocoder.php

@@ -124,7 +124,7 @@ public function reverseQuery(ReverseQuery $query): Collection
      *
      * @return StatefulGeocoder
      */
-    public function setLocale(string $locale): StatefulGeocoder
+    public function setLocale(string $locale): self
     {
         $this->locale = $locale;
 
@@ -136,7 +136,7 @@ public function setLocale(string $locale): StatefulGeocoder
      *
      * @return StatefulGeocoder
      */
-    public function setBounds(Bounds $bounds): StatefulGeocoder
+    public function setBounds(Bounds $bounds): self
     {
         $this->bounds = $bounds;
 
@@ -148,7 +148,7 @@ public function setBounds(Bounds $bounds): StatefulGeocoder
      *
      * @return StatefulGeocoder
      */
-    public function setLimit(int $limit): StatefulGeocoder
+    public function setLimit(int $limit): self
     {
         $this->limit = $limit;
 

Tests/ProviderAggregatorTest.php

@@ -78,14 +78,6 @@ public function testUsingNonExistantProviderShouldThrowAnException()
         $this->geocoder->using('non_existant');
     }
 
-    /**
-     * @expectedException \Geocoder\Exception\ProviderNotRegistered
-     */
-    public function testUsingNullShouldThrowAnException()
-    {
-        $this->geocoder->using(null);
-    }
-
     /**
      * @expectedException \Geocoder\Exception\ProviderNotRegistered
      */
@@ -207,7 +199,7 @@ class TestableGeocoder extends ProviderAggregator
 {
     public $countCallGetProvider = 0;
 
-    public function getProvider()
+    public function getProvider(): Provider
     {
         ++$this->countCallGetProvider;
 

TimedGeocoder.php

@@ -89,6 +89,6 @@ public function __call($method, $args)
 
     public function getName(): string
     {
-        return 'TimedGeocoder';
+        return 'timed_geocoder';
     }
 }