agoalofalife / bpm-online

Api/ApiBpm.php

Doc Comments +7 added lines, -7 removed lines

@@ -124,7 +124,7 @@ 
 
     /**
      * Get Protocol
-     * @return mixed
+     * @return string
      */
     public function getProtocol()
     {
@@ -133,7 +133,7 @@ 
 
     /**
      * Get HTTP TYPE
-     * @return mixed
+     * @return string
      */
     public function getHttpType()
     {
@@ -160,7 +160,7 @@ 
 
     /**
      *  Concatenation Url In Curl
-     * @param $newParameters
+     * @param string $newParameters
      * @return $this
      */
     protected function concatenationUrlCurl($newParameters)
@@ -186,7 +186,7 @@ 
     }
     /**
      * Получить обьект для обновления
-     * @return Select
+     * @return Update
      */
     public function update()
     {
@@ -195,7 +195,7 @@ 
 
     /**
      * Get Object for class create
-     * @return Select
+     * @return Create
      */
     public function create()
     {
@@ -203,7 +203,7 @@ 
     }
     /**
      * Get Object for class delete
-     * @return Select
+     * @return Delete
      */
     public function delete()
     {
@@ -257,7 +257,7 @@ 
     /**
      * Validation of BPM API response
      * @param $request
-     * @return bool
+     * @return null|boolean
      */
     private function checkRequestAuth($request)
     {

Unused Use Statements -2 removed lines

@@ -3,9 +3,7 @@
 
 use agoalofalife\bpmOnline\Facade\Authentication as CookieBpm;
 use Assert\Assertion;
-use agoalofalife\bpmOnline\Contract\CreatorData;
 use Illuminate\Config\Repository;
-use Illuminate\Container\Container;
 
 /***
  * @documentation BPM https://academy.terrasoft.ru/documents/technic-sdk/7-8-0/rabota-s-obektami-bpmonline-po-protokolu-odata-s-ispolzovaniem-http

Indentation +7 added lines, -7 removed lines

@@ -82,7 +82,7 @@ 
         $collection = ucfirst($collection);
         $format     = mb_strtolower($format);
         \Assert\that($collection, 'The first parameter expects a string to the type of collection has BPM')->string();
-         Assertion::regex($format, '~^json$|^xml$~', 'Expects parameter json or xml');
+            Assertion::regex($format, '~^json$|^xml$~', 'Expects parameter json or xml');
     }
     /**
      * Get Base URL
@@ -225,7 +225,7 @@ 
             $this->protocol,
             $this->Content_type,
             $this->formatCurl,
-                      ];
+                        ];
 
         !empty($Data)?curl_setopt($curl, CURLOPT_POSTFIELDS, $Data):true;
         curl_setopt($curl, CURLOPT_CUSTOMREQUEST, $this->HTTP_TYPE);
@@ -286,12 +286,12 @@ 
 
         foreach ( scandir($pathToConfig) as $file)
         {
-             if ( preg_match('/.php/', $file) )
-             {
-                 $nameFile = preg_replace('/.php/', '', $file);
+                if ( preg_match('/.php/', $file) )
+                {
+                    $nameFile = preg_replace('/.php/', '', $file);
 
-                 app('config')->set($nameFile,  require_once $pathToConfig . '/'.$file);
-             }
+                    app('config')->set($nameFile,  require_once $pathToConfig . '/'.$file);
+                }
         }
     }
 }
\ No newline at end of file

Spacing +12 added lines, -12 removed lines

@@ -19,7 +19,7 @@ 
      * Type HTTP
      * @var string
      */
-    protected $HTTP_TYPE ;
+    protected $HTTP_TYPE;
     /**
      * Type protocol HTTP
      * @var string
@@ -103,12 +103,12 @@ 
         $format = strtoupper($format);
         switch ($format) {
             case 'JSON':
-                    $this->formatCurl        =  'Accept: application/json;odata=verbose';
-                    $this->Content_type      =  'Content-type: application/json;odata=verbose;';
+                    $this->formatCurl        = 'Accept: application/json;odata=verbose';
+                    $this->Content_type      = 'Content-type: application/json;odata=verbose;';
                 break;
             case 'XML':
-                    $this->formatCurl        =  'application/atom+xml;type=entry;';
-                    $this->Content_type      =  'Content-type: application/atom+xml;type=entry;';
+                    $this->formatCurl        = 'application/atom+xml;type=entry;';
+                    $this->Content_type      = 'Content-type: application/atom+xml;type=entry;';
                 break;
         }
     }
@@ -165,7 +165,7 @@ 
      */
     protected function concatenationUrlCurl($newParameters)
     {
-        if ($this->UrlHome  == '?') {
+        if ($this->UrlHome == '?') {
             $this->URL_CURL .= $newParameters;
         } elseif ($this->URL_CURL == '') {
             $this->URL_CURL .= $newParameters;
@@ -227,7 +227,7 @@ 
             $this->formatCurl,
                       ];
 
-        !empty($Data)?curl_setopt($curl, CURLOPT_POSTFIELDS, $Data):true;
+        !empty($Data) ? curl_setopt($curl, CURLOPT_POSTFIELDS, $Data) : true;
         curl_setopt($curl, CURLOPT_CUSTOMREQUEST, $this->HTTP_TYPE);
         curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
         curl_setopt($curl, CURLOPT_COOKIE, $this->getCookie());
@@ -274,7 +274,7 @@ 
      */
     private function bootstrapping()
     {
-        if ( app()->resolved('config') === false )
+        if (app()->resolved('config') === false)
         {
             app()->instance('config', new Repository());
         }
@@ -282,15 +282,15 @@ 
 
     private function loadConfiguration()
     {
-        $pathToConfig = $_SERVER['PWD'] . '/config';
+        $pathToConfig = $_SERVER['PWD'].'/config';
 
-        foreach ( scandir($pathToConfig) as $file)
+        foreach (scandir($pathToConfig) as $file)
         {
-             if ( preg_match('/.php/', $file) )
+             if (preg_match('/.php/', $file))
              {
                  $nameFile = preg_replace('/.php/', '', $file);
 
-                 app('config')->set($nameFile,  require_once $pathToConfig . '/'.$file);
+                 app('config')->set($nameFile, require_once $pathToConfig.'/'.$file);
              }
         }
     }

Api/Create.php

Doc Comments +2 added lines, -2 removed lines

@@ -20,8 +20,8 @@
 
     /**
      * Create constructor.
-     * @param null $collection
-     * @param null $format
+     * @param string $collection
+     * @param string $format
      */
     public function __construct($collection, $format)
     {

Api/Select.php

Doc Comments +6 added lines, -2 removed lines

@@ -14,6 +14,10 @@ 
      */
     protected $HTTP_TYPE = 'GET';
 
+    /**
+     * @param string $collection
+     * @param string $format
+     */
     public function __construct($collection,$format)
     {
        parent::__construct($collection,$format);
@@ -24,7 +28,7 @@ 
      * Restrictions in the sample query
      * If you want the request to return more than 40 records at a time, it can be implemented using the parameter $ top
      * @param $amountMax
-     * @return string
+     * @return Select
      */
     public function amount($amountMax=null)
     {
@@ -71,7 +75,7 @@ 
      * Example $newobject->select()->choose()->orderby()->run();
      * It can not use
      * @param array $parameters
-     * @return string
+     * @return Select
      */
     public function choose($parameters = array())
     {

Indentation +1 added lines, -1 removed lines

@@ -16,7 +16,7 @@
 
     public function __construct($collection,$format)
     {
-       parent::__construct($collection,$format);
+        parent::__construct($collection,$format);
 
         $this->getFormatData($format);
     }

Spacing +10 added lines, -10 removed lines

@@ -14,9 +14,9 @@ 
      */
     protected $HTTP_TYPE = 'GET';
 
-    public function __construct($collection,$format)
+    public function __construct($collection, $format)
     {
-       parent::__construct($collection,$format);
+       parent::__construct($collection, $format);
 
         $this->getFormatData($format);
     }
@@ -26,9 +26,9 @@ 
      * @param $amountMax
      * @return string
      */
-    public function amount($amountMax=null)
+    public function amount($amountMax = null)
     {
-        \Assert\that($amountMax,'You must specify a numeric parameter for the amount of the method')->integer();
+        \Assert\that($amountMax, 'You must specify a numeric parameter for the amount of the method')->integer();
         $ParameterQuery = '$top='.$amountMax;
         return $this->concatenationUrlCurl($ParameterQuery);
     }
@@ -57,12 +57,12 @@ 
     public function orderby($asc, $param = null)
     {
         $ParameterQuery = '$orderby=';
-        $ParameterQuery.=  ucfirst($asc);
+        $ParameterQuery .= ucfirst($asc);
         if (!empty($param)) {
             if ($param != 'desc' && $param != 'asc') {
                 throw new \Exception('no valid orderby parameters');
             }
-            $ParameterQuery.=  " ".$param;
+            $ParameterQuery .= " ".$param;
         }
         return $this->concatenationUrlCurl($ParameterQuery);
     }
@@ -75,14 +75,14 @@ 
      */
     public function choose($parameters = array())
     {
-        $ParameterQuery='select=';
+        $ParameterQuery = 'select=';
         $counter = 0;
         foreach ($parameters as $parameter) {
             $counter++;
             if ($counter == count($parameters)) {
-                $ParameterQuery.= ucfirst($parameter);
+                $ParameterQuery .= ucfirst($parameter);
             } else {
-                $ParameterQuery.= ucfirst($parameter).',';
+                $ParameterQuery .= ucfirst($parameter).',';
             }
         }
         return $this->concatenationUrlCurl($ParameterQuery);
@@ -102,7 +102,7 @@ 
     public function filterConstructor($strRequest)
     {
         $ParameterQuery = '$filter=';
-        $ParameterQuery.= $strRequest;
+        $ParameterQuery .= $strRequest;
         return $this->concatenationUrlCurl($ParameterQuery);
     }
 

Api/Update.php

Doc Comments +4 added lines

@@ -7,6 +7,10 @@
 {
     protected $HTTP_TYPE = 'PUT';
 
+    /**
+     * @param string $collection
+     * @param string $format
+     */
     public function __construct($collection, $format)
     {
         parent::__construct($collection, $format);

Spacing +4 added lines, -4 removed lines

@@ -22,10 +22,10 @@
     {
         $this->URL_CURL = '';
         $ParameterQuery = '(guid';
-        $ParameterQuery.= "'";
-        $ParameterQuery.= $guid;
-        $ParameterQuery.= "'";
-        $ParameterQuery.=')';
+        $ParameterQuery .= "'";
+        $ParameterQuery .= $guid;
+        $ParameterQuery .= "'";
+        $ParameterQuery .= ')';
         return $this->concatenationUrlCurl($ParameterQuery);
     }
 

Api/XmlHandler.php

Doc Comments +3 added lines, -3 removed lines

@@ -72,7 +72,7 @@ 
     }
     /**
      *  Get one Element
-     * @return mixed
+     * @return XmlHandler
      */
     public function arrayOne()
     {
@@ -83,7 +83,7 @@ 
 
     /**
      * Extraction array in response XML , more element one
-     * @return array
+     * @return XmlHandler|null
      * @throws \Exception
      */
     public function arrayMany()
@@ -147,7 +147,7 @@ 
 
     /**
      * Get collect Data in proprty @responceRender
-     * @return mixed
+     * @return \Illuminate\Support\Collection
      */
     public function collectData()
     {

Indentation +2 added lines, -2 removed lines

@@ -92,7 +92,7 @@ 
         try {
             foreach ($this->responceXML->children(self::$Atom)->entry as $item) {
                 $array_cashe[] =   $item->content->children(self::$Metadata)
-                     ->children(self::$Dataservices);
+                        ->children(self::$Dataservices);
             }
             return  $this->Addrender($array_cashe);
         } catch (\Exeption $e) {
@@ -174,7 +174,7 @@ 
             $value    = $dom->createTextNode($value[key($value)]);
             $xmlBase->appendChild($value);
         }
-       //----------  <content type="application/xml">  ----------//
+        //----------  <content type="application/xml">  ----------//
         $content      = $dom->createElement('content');
         $entry->appendChild($content);
         $xmlns_dcd    = $dom->createAttribute('type');

Spacing +3 added lines, -3 removed lines

@@ -59,7 +59,7 @@ 
         }
 
         if ($responseXml) {
-            $array_vars_list    = get_object_vars($copyresponceXML);
+            $array_vars_list = get_object_vars($copyresponceXML);
             if (key_exists('content', $array_vars_list)) {
                 return $this->arrayOne();
             }
@@ -91,7 +91,7 @@ 
         $array_cashe = [];
         try {
             foreach ($this->responceXML->children(self::$Atom)->entry as $item) {
-                $array_cashe[] =   $item->content->children(self::$Metadata)
+                $array_cashe[] = $item->content->children(self::$Metadata)
                      ->children(self::$Dataservices);
             }
             return  $this->Addrender($array_cashe);
@@ -108,7 +108,7 @@ 
     {
         if (!empty($this->responceXML->message->collection->title)) {
                 throw new \Exception("responce BPM API : ".
-                    $this->responceXML->innererror->message.". ENG :".  $this->responceXML->message);
+                    $this->responceXML->innererror->message.". ENG :".$this->responceXML->message);
         }
         foreach ($this->responceXML->workspace->collection as $item) {
             $array_cashe[] = get_object_vars($item->children(self::$Atom))['title'];

helpers/helpers.php

Doc Comments +1 added lines, -1 removed lines

@@ -18,7 +18,7 @@
 if (! function_exists('JsonHandler')) {
     /**
      * Just return object XmlHandler
-     * @return XmlHandler
+     * @return JsonHandler
      */
     function JsonHandler()
     {

Spacing +4 added lines, -4 removed lines

@@ -3,7 +3,7 @@ 
 use agoalofalife\bpmOnline\Api\JsonHandler;
 use Illuminate\Container\Container;
 
-if (! function_exists('XmlHandler')) {
+if (!function_exists('XmlHandler')) {
     /**
      * Just return object XmlHandler
      * @return XmlHandler
@@ -15,7 +15,7 @@ 
 }
 
 
-if (! function_exists('JsonHandler')) {
+if (!function_exists('JsonHandler')) {
     /**
      * Just return object XmlHandler
      * @return XmlHandler
@@ -27,7 +27,7 @@ 
 }
 
 
-if (! function_exists('config')) {
+if (!function_exists('config')) {
     /**
      * Get / set the specified configuration value.
      *
@@ -51,7 +51,7 @@ 
     }
 }
 
-if (! function_exists('app')) {
+if (!function_exists('app')) {
     /**
      * Get the available container instance.
      *

Api/Delete.php

Spacing +4 added lines, -4 removed lines

@@ -26,10 +26,10 @@
     {
         $this->URL_CURL = '';
         $ParameterQuery = '(guid';
-        $ParameterQuery.= "'";
-        $ParameterQuery.= $guid;
-        $ParameterQuery.= "'";
-        $ParameterQuery.=')';
+        $ParameterQuery .= "'";
+        $ParameterQuery .= $guid;
+        $ParameterQuery .= "'";
+        $ParameterQuery .= ')';
         return $this->concatenationUrlCurl($ParameterQuery);
     }
     /**