added code commenting

Author: nahid

src/Presenter.php

@@ -27,17 +27,27 @@ public function __toString() : string
 
     abstract public function present() : array;
 
+    /**
+     * get transformer name, this method can be override
+     *
+     * @return null|string
+     */
     public function transformer()
     {
         return null;
     }
 
-    public function handle()
+    /**
+     * handle data based on presented data
+     *
+     * @return array
+     */
+    public function handle() : array
     {
         if ($this->isCollection($this->data)) {
             $generatedData = [];
             foreach ($this->data  as $property => $data) {
-                $generatedData[] = $this->transform($this->process($data));
+                $generatedData[$property] = $this->transform($this->process($data));
             }
 
             return $generatedData;
@@ -46,6 +56,12 @@ public function handle()
         return $this->transform($this->process($this->data));
     }
 
+    /**
+     * process data based presented data model
+     *
+     * @param array $data
+     * @return array
+     */
     public function process(array $data) : array
     {
         $present = $this->present();
@@ -72,6 +88,12 @@ public function process(array $data) : array
         return $record;
     }
 
+    /**
+     * transform given data based on transformer.
+     *
+     * @param array $data
+     * @return array
+     */
     protected function transform(array $data) : array
     {
         $transformerClass = $this->transformer();
@@ -84,11 +106,21 @@ protected function transform(array $data) : array
         return $data;
     }
 
+    /**
+     * get generated data as json string
+     *
+     * @return string
+     */
     public function toJson() : string
     {
         return json_encode($this->generatedData);
     }
 
+    /**
+     * get full set of data as array
+     *
+     * @return array
+     */
     public function get() : array
     {
         return $this->generatedData;
@@ -108,6 +140,4 @@ protected function isCollection(array $arr) : bool
 
         return isset($arr[0]) && is_array($arr[0]);
     }
-
-
 }

src/Transformer.php

@@ -14,30 +14,54 @@ public function __construct(array $data)
         $this->transform();
     }
 
-    public function __invoke() : array 
+    public function __invoke() : array
     {
         return $this->getData();
     }
 
+    /**
+     * transform given data with desired methods
+     *
+     * @return void
+     */
     public function transform()
     {
         foreach ($this->data as $key => $value) {
             $this->generatedData[$key] = $this->callPropertyFunction($key, $value);
         }
     }
 
+    /**
+     * check then current property need to be processed
+     *
+     * @param string $property
+     * @return bool
+     */
     protected function isPropertyNeedProcess(string $property) : bool
     {
         $method = $this->getPropertyFunction($property);
 
         return method_exists($this, $method);
     }
 
+    /**
+     * get property guessed function name
+     *
+     * @param string $property
+     * @return string
+     */
     protected function getPropertyFunction(string $property) : string
     {
         return 'get'. to_camel_case($property) . 'Property';
     }
 
+    /**
+     * call property function if exists
+     *
+     * @param string $property
+     * @param $value
+     * @return mixed
+     */
     protected function callPropertyFunction(string $property, $value)
     {
         if ($this->isPropertyNeedProcess($property)) {
@@ -47,11 +71,22 @@ protected function callPropertyFunction(string $property, $value)
         return $value;
     }
 
+    /**
+     * get property value from data
+     *
+     * @param string $property
+     * @return array|mixed|null
+     */
     public function getProperty(string $property)
     {
         return get_from_array($this->data, $property);
     }
 
+    /**
+     * get full set of data
+     *
+     * @return array
+     */
     public function getData() : array
     {
         return $this->generatedData;