Merge pull request #159 from kwhat/doc_fix

tflori · web-flow · commit e6e72046bc2e · 2020-02-04T07:55:21.000+01:00
Fixing minor phpdoc inconsistency with interface vs implementation.
diff --git a/src/GetOpt.php b/src/GetOpt.php
@@ -51,7 +51,7 @@ class GetOpt implements \Countable, \ArrayAccess, \IteratorAggregate
     protected $commands = [];
 
     /** The command that is executed determined by process
-     * @var CommandInterdface */
+     * @var CommandInterface */
     protected $command;
 
     /** @var string[] */
@@ -280,7 +280,7 @@ public function addCommand(CommandInterface $command)
      * Get the current or a named command.
      *
      * @param string $name
-     * @return Command
+     * @return CommandInterface
      */
     public function getCommand($name = null)
     {
@@ -292,7 +292,7 @@ public function getCommand($name = null)
     }
 
     /**
-     * @return Command[]
+     * @return CommandInterface[]
      */
     public function getCommands()
     {
@@ -500,6 +500,12 @@ public function parse($arguments = null)
 
     // array functions
 
+    /**
+     * @inheritDoc
+     *
+     * @return \Traversable
+     * @throws \Exception
+     */
     public function getIterator()
     {
         $result = [];
@@ -514,6 +520,12 @@ public function getIterator()
         return new \ArrayIterator($result + $this->additionalOptions);
     }
 
+    /**
+     * @inheritDoc
+     *
+     * @param mixed $offset
+     * @return bool
+     */
     public function offsetExists($offset)
     {
         $option = $this->getOptionObject($offset);
@@ -524,6 +536,12 @@ public function offsetExists($offset)
         return isset($this->additionalOptions[$offset]);
     }
 
+    /**
+     * @inheritDoc
+     *
+     * @param mixed $offset
+     * @return mixed
+     */
     public function offsetGet($offset)
     {
         $option = $this->getOptionObject($offset);
@@ -534,16 +552,34 @@ public function offsetGet($offset)
         return isset($this->additionalOptions[$offset]) ? $this->additionalOptions[$offset] : null;
     }
 
+    /**
+     * @inheritDoc
+     *
+     * @param mixed $offset
+     * @param mixed $value
+     */
     public function offsetSet($offset, $value)
     {
         throw new \LogicException('Read only array access');
     }
 
+    /**
+     * @inheritDoc
+     *
+     * @param mixed $offset
+     * @throws \LogicException
+     */
     public function offsetUnset($offset)
     {
         throw new \LogicException('Read only array access');
     }
 
+    /**
+     * @inheritDoc
+     *
+     * @return int
+     * @throws \Exception
+     */
     public function count()
     {
         return $this->getIterator()->count();
