[Documentation] Stub phpDoc added

Author: sudiptochoudhury

README.md

@@ -1,2 +1,5 @@
 # php-api-client-forge
-Create restful API client in PHP
+Create restful API client in PHP with least code
+
+
+

src/support/forge/api/Client.php

@@ -36,6 +36,11 @@ class Client
     protected $options;
     protected $rootPath;
 
+    /**
+     * Client constructor.
+     *
+     * @param array $config
+     */
     public function __construct($config = [])
     {
         $this->setOptions($config);
@@ -50,6 +55,11 @@ public function __construct($config = [])
 
     }
 
+    /**
+     * @param array $options
+     *
+     * @return $this
+     */
     public function setOptions($options = [])
     {
         $myProperties = get_class_vars(__CLASS__);
@@ -68,6 +78,12 @@ public function setOptions($options = [])
         return $this;
     }
 
+    /**
+     * @param       $options
+     * @param array $rootOption
+     *
+     * @return array|mixed
+     */
     protected function parseOptions($options, $rootOption = [])
     {
 
@@ -91,6 +107,11 @@ protected function parseOptions($options, $rootOption = [])
 
     }
 
+    /**
+     * @param array $descriptionOptions
+     *
+     * @return $this
+     */
     public function setDescription($descriptionOptions = [])
     {
 
@@ -129,12 +150,22 @@ public function setDescription($descriptionOptions = [])
         return $this;
     }
 
+    /**
+     * @param array $clientOptions
+     *
+     * @return $this
+     */
     public function createClient($clientOptions = [])
     {
         $this->client = new GHClient($clientOptions);
         return $this;
     }
 
+    /**
+     * @param array $clientOptions
+     *
+     * @return $this
+     */
     protected function setClient($clientOptions = [])
     {
 
@@ -144,6 +175,12 @@ protected function setClient($clientOptions = [])
         return $this;
     }
 
+    /**
+     * @param $name
+     * @param $arguments
+     *
+     * @return mixed
+     */
     public function __call($name, $arguments)
     {
         $api = $this->consumer;
@@ -154,6 +191,13 @@ public function __call($name, $arguments)
         throw new \BadMethodCallException(sprintf('Call to undefined method %s::%s().', get_called_class(), $name));
     }
 
+    /**
+     * @param string $source
+     * @param string $destination
+     * @param array  $options
+     *
+     * @return bool|int
+     */
     public function importApi($source = '', $destination = '', $options = [])
     {
         if (empty($source)) {
@@ -177,9 +221,17 @@ protected function getAllOptions() {
         ];
     }
 
+    /**
+     * @return string
+     * @throws \ReflectionException
+     */
     private function getChildDir() {
         return dirname((new \ReflectionClass(static::class))->getFileName());
     }
+
+    /**
+     * @return string
+     */
     private function getDir() {
         return __DIR__;
     }

src/support/forge/api/Import.php

@@ -22,6 +22,14 @@ class Import
     protected $DEFAULT_API_JSON_PATH = './config/api.json';
     protected $DEFAULT_SOURCE_JSON_PATH = './config/postman.json';
 
+    /**
+     * Import constructor.
+     *
+     * @param string $filePath Path containing source (Postman generated) json file
+     * @param array  $options
+     *
+     * @throws \ReflectionException
+     */
     public function __construct($filePath = '', $options = [])
     {
 
@@ -50,6 +58,11 @@ public function __construct($filePath = '', $options = [])
         $this->options = $options;
     }
 
+    /**
+     * @param $filePath Path containing source (Postman generated) json file
+     *
+     * @return array
+     */
     protected function importFromJson($filePath)
     {
 
@@ -111,6 +124,11 @@ protected function importFromJson($filePath)
         return $data;
     }
 
+    /**
+     * @param array $request
+     *
+     * @return array
+     */
     protected function parseOperation($request = [])
     {
         $meta = [$request];
@@ -128,6 +146,13 @@ protected function parseOperation($request = [])
 
     }
 
+    /**
+     * @param array  $paths
+     * @param string $bodyRaw
+     * @param array  $meta
+     *
+     * @return array
+     */
     protected function parseParams($paths = [], $bodyRaw = '', $meta = [])
     {
         $params = [];
@@ -164,11 +189,22 @@ protected function parseParams($paths = [], $bodyRaw = '', $meta = [])
 
     }
 
+    /**
+     * @param       $url
+     * @param array $meta
+     *
+     * @return string
+     */
     protected function parseUri($url, $meta = [])
     {
         return implode('/', array_slice($url['path'], 2));
     }
 
+    /**
+     * @param $api
+     *
+     * @return string
+     */
     protected function parseApiName($api)
     {
 
@@ -207,6 +243,13 @@ protected function parseApiName($api)
 
     }
 
+    /**
+     * @param        $operation
+     * @param array  $api
+     * @param string $method
+     *
+     * @return array
+     */
     protected function generateDocs($operation, $api = [], $method = '') {
 
 //        $baseUri  = $this->clientOptions['base_url'] ?: '';
@@ -251,6 +294,11 @@ protected function generateMethod($apiName, $operation = [], $api = []) {
 
     }
 
+    /**
+     * @param string $string
+     *
+     * @return string
+     */
     protected function sluggify($string = '')
     {
         if (!empty($string)) {
@@ -261,22 +309,36 @@ protected function sluggify($string = '')
         return $string;
     }
 
-
+    /**
+     * @return array
+     */
     public function getData()
     {
         return $this->data;
     }
 
+    /**
+     * @return array
+     */
     public function getDocs()
     {
         return $this->docsData;
     }
 
+    /**
+     * @return array
+     */
     public function getMethods()
     {
         return $this->methodData;
     }
 
+    /**
+     * @param string $path
+     * @param array  $options
+     *
+     * @return bool|int
+     */
     public function writeData($path = '', $options = [])
     {
         if (empty($path)) {
@@ -300,7 +362,11 @@ public function writeData($path = '', $options = [])
         return file_put_contents($path, $json);
     }
 
-
+    /**
+     * @param string $path
+     *
+     * @return bool|int
+     */
     protected function writeMDDocs($path = '') {
 
         if (empty($path)) {
@@ -347,6 +413,11 @@ protected function writeMDDocs($path = '') {
         return file_put_contents($path, $mdText);
     }
 
+    /**
+     * @param string $path
+     *
+     * @return bool|int
+     */
     protected function writeMethods($path = '') {
 
         if (empty($path)) {
@@ -367,9 +438,17 @@ protected function writeMethods($path = '') {
         return file_put_contents($path, $methodText);
     }
 
+    /**
+     * @return string
+     * @throws \ReflectionException
+     */
     private function getChildDir() {
         return dirname((new \ReflectionClass(static::class))->getFileName());
     }
+
+    /**
+     * @return string
+     */
     private function getDir() {
         return __DIR__;
     }