psfs / core

src/base/types/Api.php

Unused Use Statements -3 removed lines

@@ -4,15 +4,12 @@
 use Propel\Runtime\ActiveQuery\ModelCriteria;
 use Propel\Runtime\Map\TableMap;
 use Propel\Runtime\Propel;
-use PSFS\base\config\Config;
 use PSFS\base\dto\JsonResponse;
 use PSFS\base\dto\Order;
 use PSFS\base\Logger;
 use PSFS\base\Request;
-use PSFS\base\Security;
 use PSFS\base\Singleton;
 use PSFS\base\types\helpers\ApiHelper;
-use PSFS\base\types\helpers\Inspector;
 use PSFS\base\types\traits\Api\ManagerTrait;
 
 /**

Spacing +28 added lines, -28 removed lines

@@ -74,15 +74,15 @@ 
     public function init()
     {
         parent::init();
-        Logger::log(get_called_class() . ' init', LOG_DEBUG);
+        Logger::log(get_called_class().' init', LOG_DEBUG);
         $this->domain = $this->getDomain();
         $this->hydrateRequestData();
         $this->hydrateOrders();
-        if($this instanceof CustomApi === false) {
+        if ($this instanceof CustomApi === false) {
             $this->createConnection($this->getTableMap());
         }
         $this->setLoaded(true);
-        Logger::log(get_called_class() . ' loaded', LOG_DEBUG);
+        Logger::log(get_called_class().' loaded', LOG_DEBUG);
     }
 
     /**
@@ -91,7 +91,7 @@ 
     protected function hydrateOrders()
     {
         if (count($this->query)) {
-            Logger::log(get_called_class() . ' gathering query string', LOG_DEBUG);
+            Logger::log(get_called_class().' gathering query string', LOG_DEBUG);
             foreach ($this->query as $key => $value) {
                 if ($key === self::API_ORDER_FIELD) {
                     foreach ($value as $field => $direction) {
@@ -108,10 +108,10 @@ 
      */
     protected function extractPagination()
     {
-        Logger::log(get_called_class() . ' extract pagination start', LOG_DEBUG);
+        Logger::log(get_called_class().' extract pagination start', LOG_DEBUG);
         $page = (array_key_exists(self::API_PAGE_FIELD, $this->query)) ? $this->query[self::API_PAGE_FIELD] : 1;
         $limit = (array_key_exists(self::API_LIMIT_FIELD, $this->query)) ? $this->query[self::API_LIMIT_FIELD] : 100;
-        Logger::log(get_called_class() . ' extract pagination end', LOG_DEBUG);
+        Logger::log(get_called_class().' extract pagination end', LOG_DEBUG);
         return array($page, $limit);
     }
 
@@ -120,9 +120,9 @@ 
      *
      * @param ModelCriteria $query
      */
-    private function addOrders(ModelCriteria &$query)
+    private function addOrders(ModelCriteria & $query)
     {
-        Logger::log(get_called_class() . ' extract orders start ', LOG_DEBUG);
+        Logger::log(get_called_class().' extract orders start ', LOG_DEBUG);
         $orderAdded = FALSE;
         $tableMap = $this->getTableMap();
         foreach ($this->order->getOrders() as $field => $direction) {
@@ -130,17 +130,17 @@ 
                 $orderAdded = TRUE;
                 if ($direction === Order::ASC) {
                     $query->addAscendingOrderByColumn($column->getPhpName());
-                } else {
+                }else {
                     $query->addDescendingOrderByColumn($column->getPhpName());
                 }
             }
         }
         if (!$orderAdded) {
-            foreach($this->getPkDbName() as $pk => $phpName) {
+            foreach ($this->getPkDbName() as $pk => $phpName) {
                 $query->addAscendingOrderByColumn($pk);
             }
         }
-        Logger::log(get_called_class() . ' extract orders end', LOG_DEBUG);
+        Logger::log(get_called_class().' extract orders end', LOG_DEBUG);
     }
 
     /**
@@ -148,14 +148,14 @@ 
      *
      * @param ModelCriteria $query
      */
-    protected function addFilters(ModelCriteria &$query)
+    protected function addFilters(ModelCriteria & $query)
     {
         if (count($this->query) > 0) {
             $tableMap = $this->getTableMap();
             foreach ($this->query as $field => $value) {
                 if (self::API_COMBO_FIELD === $field) {
                     ApiHelper::composerComboField($tableMap, $query, $this->extraColumns, $value);
-                } elseif(!preg_match('/^__/', $field)) {
+                } elseif (!preg_match('/^__/', $field)) {
                     ApiHelper::addModelField($tableMap, $query, $field, $value);
                 }
             }
@@ -176,10 +176,10 @@ 
             list($page, $limit) = $this->extractPagination();
             if ($limit == -1) {
                 $this->list = $query->find($this->con);
-            } else {
+            }else {
                 $this->list = $query->paginate($page, $limit, $this->con);
             }
-        } catch (\Exception $e) {
+        }catch (\Exception $e) {
             Logger::log($e->getMessage(), LOG_ERR);
         }
     }
@@ -198,7 +198,7 @@ 
         $code = 200;
         list($return, $total, $pages) = $this->getList();
         $message = null;
-        if(!$total) {
+        if (!$total) {
             $message = _('No se han encontrado elementos para la búsqueda');
         }
 
@@ -224,7 +224,7 @@ 
         $pages = 1;
         $message = null;
         list($code, $return) = $this->getSingleResult($pk);
-        if($code !== 200) {
+        if ($code !== 200) {
             $message = _('No se ha encontrado el elemento solicitado');
         }
 
@@ -253,11 +253,11 @@ 
                 $status = 200;
                 $saved = TRUE;
                 $model = $this->model->toArray();
-            } else {
+            }else {
                 $message = _('No se ha podido guardar el modelo seleccionado');
             }
-        } catch (\Exception $e) {
-            $message = _('Ha ocurrido un error intentando guardar el elemento: ') .'<br>'. $e->getMessage();
+        }catch (\Exception $e) {
+            $message = _('Ha ocurrido un error intentando guardar el elemento: ').'<br>'.$e->getMessage();
             Logger::log($e->getMessage(), LOG_ERR);
         }
 
@@ -291,14 +291,14 @@ 
                     $updated = TRUE;
                     $status = 200;
                     $model = $this->model->toArray();
-                } else {
+                }else {
                     $message = _('Ha ocurrido un error intentando actualizar el elemento, por favor revisa los logs');
                 }
-            } catch (\Exception $e) {
+            }catch (\Exception $e) {
                 $message = $e->getMessage();
                 Logger::getInstance(get_class($this->model))->errorLog($e->getMessage());
             }
-        } else {
+        }else {
             $message = _('No se ha encontrado el modelo al que se hace referencia para actualizar');
         }
 
@@ -328,7 +328,7 @@ 
                     $this->model->delete($this->con);
                     $deleted = TRUE;
                 }
-            } catch (\Exception $e) {
+            }catch (\Exception $e) {
                 $message = _('Ha ocurrido un error intentando eliminar el elemento, por favor verifica que no tenga otros elementos relacionados');
                 Logger::getInstance(get_class($this->model))->errorLog($e->getMessage());
             }
@@ -356,7 +356,7 @@ 
             $this->saveBulk();
             $saved = true;
             $status = 200;
-        } catch(\Exception $e) {
+        }catch (\Exception $e) {
             Logger::log($e->getMessage(), LOG_ERR, $this->getRequest()->getData());
             $message = _('Bulk insert rolled back');
         }
@@ -388,8 +388,8 @@ 
                 $total = $this->list->getNbResults();
                 $pages = $this->list->getLastPage();
             }
-        } catch (\Exception $e) {
-            Logger::log(get_class($this) . ': ' . $e->getMessage(), LOG_ERR);
+        }catch (\Exception $e) {
+            Logger::log(get_class($this).': '.$e->getMessage(), LOG_ERR);
         }
 
         return array($return, $total, $pages);
@@ -407,7 +407,7 @@ 
         $return = array();
         if (NULL === $model || !method_exists($model, 'toArray')) {
             $code = 404;
-        } else {
+        }else {
             $return = $model->toArray();
         }
 

src/base/types/helpers/DocumentorHelper.php

Doc Comments +2 added lines, -2 removed lines

@@ -47,7 +47,7 @@ 
      * @param $object
      * @param $paths
      * @param $url
-     * @param $method
+     * @param string $method
      * @param $dtos
      * @return array
      */
@@ -84,7 +84,7 @@ 
      * Translator from php types to swagger types
      * @param string $format
      *
-     * @return array
+     * @return string[]
      */
     public static function translateSwaggerFormats($format)
     {

Spacing +6 added lines, -6 removed lines

@@ -27,10 +27,10 @@ 
         ];
         if ($endpoint['payload']['is_array']) {
             $schema['items'] = [
-                '$ref' => '#/definitions/' . $endpoint['payload']['type'],
+                '$ref' => '#/definitions/'.$endpoint['payload']['type'],
             ];
-        } else {
-            $schema['$ref'] = '#/definitions/' . $endpoint['payload']['type'];
+        }else {
+            $schema['$ref'] = '#/definitions/'.$endpoint['payload']['type'];
         }
         $paths[$url][$method]['parameters'][] = [
             'in' => 'body',
@@ -58,13 +58,13 @@ 
             if (array_key_exists('data', $endpoint['return']) && count(array_keys($object)) === count(array_keys($endpoint['return']['data']))) {
                 $classDefinition = [
                     'type' => 'object',
-                    '$ref' => '#/definitions/' . $class,
+                    '$ref' => '#/definitions/'.$class,
                 ];
-            } else {
+            }else {
                 $classDefinition = [
                     'type' => 'array',
                     'items' => [
-                        '$ref' => '#/definitions/' . $class,
+                        '$ref' => '#/definitions/'.$class,
                     ],
                 ];
             }

src/base/types/helpers/InjectorHelper.php

Unused Use Statements -1 removed lines

@@ -2,7 +2,6 @@
 namespace PSFS\base\types\helpers;
 
 use PSFS\base\Logger;
-use PSFS\services\DocumentorService;
 
 /**
  * Class InjectorHelper

src/services/DocumentorService.php

Unused Use Statements -1 removed lines

@@ -9,7 +9,6 @@
 use PSFS\base\Router;
 use PSFS\base\Service;
 use PSFS\base\types\helpers\DocumentorHelper;
-use PSFS\base\types\helpers\GeneratorHelper;
 use PSFS\base\types\helpers\I18nHelper;
 use PSFS\base\types\helpers\InjectorHelper;
 use PSFS\base\types\helpers\RouterHelper;

Spacing +21 added lines, -21 removed lines

@@ -57,10 +57,10 @@ 
                     if (!preg_match('/^ROOT/i', $module) && $module == $requestModule) {
                         $modules = [
                             'name' => $module,
-                            'path' => realpath($info['template'] . DIRECTORY_SEPARATOR . '..'),
+                            'path' => realpath($info['template'].DIRECTORY_SEPARATOR.'..'),
                         ];
                     }
-                } catch (\Exception $e) {
+                }catch (\Exception $e) {
                     $modules[] = $e->getMessage();
                 }
             }
@@ -78,7 +78,7 @@ 
      */
     public function extractApiEndpoints(array $module)
     {
-        $module_path = $module['path'] . DIRECTORY_SEPARATOR . 'Api';
+        $module_path = $module['path'].DIRECTORY_SEPARATOR.'Api';
         $module_name = $module['name'];
         $endpoints = [];
         if (file_exists($module_path)) {
@@ -87,7 +87,7 @@ 
             if (count($finder)) {
                 /** @var \SplFileInfo $file */
                 foreach ($finder as $file) {
-                    $namespace = "\\{$module_name}\\Api\\" . str_replace('.php', '', $file->getFilename());
+                    $namespace = "\\{$module_name}\\Api\\".str_replace('.php', '', $file->getFilename());
                     $info = $this->extractApiInfo($namespace, $module_name);
                     if (!empty($info)) {
                         $endpoints[$namespace] = $info;
@@ -111,14 +111,14 @@ 
         if (Router::exists($namespace) && !I18nHelper::checkI18Class($namespace)) {
             $reflection = new \ReflectionClass($namespace);
             $visible = InjectorHelper::checkIsVisible($reflection->getDocComment());
-            if($visible) {
+            if ($visible) {
                 foreach ($reflection->getMethods(\ReflectionMethod::IS_PUBLIC) as $method) {
                     try {
                         $mInfo = $this->extractMethodInfo($namespace, $method, $reflection, $module);
                         if (NULL !== $mInfo) {
                             $info[] = $mInfo;
                         }
-                    } catch (\Exception $e) {
+                    }catch (\Exception $e) {
                         Logger::getInstance()->errorLog($e->getMessage());
                     }
                 }
@@ -251,7 +251,7 @@ 
             $payload = $this->extractModelFields($namespace);
             $reflector = new \ReflectionClass($namespace);
             $namespace = $reflector->getShortName();
-        } else {
+        }else {
             $namespace = $model;
         }
 
@@ -338,10 +338,10 @@ 
                         "required" => $field->isNotNull(),
                         'format' => $format,
                     ];
-                    if(count($field->getValueSet())) {
+                    if (count($field->getValueSet())) {
                         $info['enum'] = array_values($field->getValueSet());
                     }
-                    if(null !== $field->getDefaultValue()) {
+                    if (null !== $field->getDefaultValue()) {
                         $info['default'] = $field->getDefaultValue();
                     }
                     $payload[$field->getPhpName()] = $info;
@@ -349,7 +349,7 @@ 
             } elseif (null !== $reflector && $reflector->isSubclassOf(self::DTO_INTERFACE)) {
                 $payload = $this->extractDtoProperties($namespace);
             }
-        } catch (\Exception $e) {
+        }catch (\Exception $e) {
             Logger::getInstance()->errorLog($e->getMessage());
         }
 
@@ -380,7 +380,7 @@ 
                     $return = $this->extractReturn($modelNamespace, $docComments);
                     $url = array_pop($route);
                     $methodInfo = [
-                        'url' => str_replace("/" . $module . "/api", '', $url),
+                        'url' => str_replace("/".$module."/api", '', $url),
                         'method' => $info['http'],
                         'description' => $info['label'],
                         'return' => $return,
@@ -391,7 +391,7 @@ 
                     $this->setRequestParams($method, $methodInfo, $modelNamespace, $docComments);
                     $this->setQueryParams($method, $methodInfo);
                     $this->setRequestHeaders($reflection, $methodInfo);
-                } catch (\Exception $e) {
+                }catch (\Exception $e) {
                     Logger::getInstance()->errorLog($e->getMessage());
                 }
             }
@@ -460,10 +460,10 @@ 
         $formatted = [
             "swagger" => "2.0",
             "host" => preg_replace('/^(http|https)\:\/\/(.*)\/$/i', '$2', Router::getInstance()->getRoute('', true)),
-            "basePath" => '/' . $module['name'] . '/api',
+            "basePath" => '/'.$module['name'].'/api',
             "schemes" => [Request::getInstance()->getServer('HTTPS') == 'on' ? "https" : "http"],
             "info" => [
-                "title" => _('Documentación API módulo ') . $module['name'],
+                "title" => _('Documentación API módulo ').$module['name'],
                 "version" => Config::getParam('api.version', '1.0.0'),
                 "contact" => [
                     "name" => Config::getParam("author", "Fran López"),
@@ -476,7 +476,7 @@ 
         foreach ($endpoints as $model) {
             foreach ($model as $endpoint) {
                 if (!preg_match('/^\/(admin|api)\//i', $endpoint['url']) && strlen($endpoint['url'])) {
-                    $url = preg_replace('/\/' . $module['name'] . '\/api/i', '', $endpoint['url']);
+                    $url = preg_replace('/\/'.$module['name'].'\/api/i', '', $endpoint['url']);
                     $description = $endpoint['description'];
                     $method = strtolower($endpoint['method']);
                     $paths[$url][$method] = [
@@ -535,7 +535,7 @@ 
     protected function extractDtoName($dto, $isArray = false)
     {
         $dto = explode('\\', $dto);
-        $modelDto = array_pop($dto) . "Dto";
+        $modelDto = array_pop($dto)."Dto";
         if ($isArray) {
             $modelDto .= "List";
         }
@@ -585,10 +585,10 @@ 
     {
 
         $methodInfo['headers'] = [];
-        foreach($reflection->getProperties() as $property) {
+        foreach ($reflection->getProperties() as $property) {
             $doc = $property->getDocComment();
             preg_match('/@header\ (.*)\n/i', $doc, $headers);
-            if(count($headers)) {
+            if (count($headers)) {
                 $header = [
                     "name" => $headers[1],
                     "in" => "header",
@@ -600,13 +600,13 @@ 
 
                 // Extract description
                 preg_match('/@label\ (.*)\n/i', $doc, $label);
-                if(count($label)) {
+                if (count($label)) {
                     $header['description'] = _($label[1]);
                 }
 
                 // Extract default value
                 preg_match('/@default\ (.*)\n/i', $doc, $default);
-                if(count($default)) {
+                if (count($default)) {
                     $header['default'] = $default[1];
                 }
                 $methodInfo['headers'][] = $header;
@@ -637,7 +637,7 @@ 
             foreach ($method->getParameters() as $parameter) {
                 $parameterName = $parameter->getName();
                 $types = [];
-                preg_match_all('/\@param\ (.*)\ \$' . $parameterName . '$/im', $docComments, $types);
+                preg_match_all('/\@param\ (.*)\ \$'.$parameterName.'$/im', $docComments, $types);
                 if (count($types) > 1) {
                     $methodInfo['parameters'][$parameterName] = $types[1][0];
                 }

src/base/types/traits/Api/ApiTrait.php

Spacing +16 added lines, -16 removed lines

@@ -95,14 +95,14 @@ 
      */
     protected function hydrateBulkRequest() {
         $class = new \ReflectionClass($this->getModelNamespace());
-        foreach($this->data as $item) {
-            if(count($this->list) < Config::getParam('api.block.limit', 1000)) {
+        foreach ($this->data as $item) {
+            if (count($this->list) < Config::getParam('api.block.limit', 1000)) {
                 /** @var ActiveRecordInterface $model */
                 $model = $class->newInstance();
                 $this->hydrateModelFromRequest($model, $item);
                 $this->list[] = $model;
-            } else {
-                Logger::log(_('Max items per bulk insert raised'), LOG_WARNING, count($this->data) . _('items'));
+            }else {
+                Logger::log(_('Max items per bulk insert raised'), LOG_WARNING, count($this->data)._('items'));
             }
         }
     }
@@ -112,12 +112,12 @@ 
      */
     protected function saveBulk() {
         $tablemap = $this->getTableMap();
-        foreach($this->list as &$model) {
+        foreach ($this->list as &$model) {
             $con = Propel::getWriteConnection($tablemap::DATABASE_NAME);
             try {
                 $model->save($con);
                 $con->commit();
-            } catch(\Exception $e) {
+            }catch (\Exception $e) {
                 Logger::log($e->getMessage(), LOG_ERR, $model->toArray());
                 $con->rollBack();
             }
@@ -130,7 +130,7 @@ 
     protected function exportList() {
         $list = [];
         /** @var ActiveRecordInterface $item */
-        foreach($this->list as $item) {
+        foreach ($this->list as $item) {
             $list[] = $item->toArray();
         }
         return $list;
@@ -141,7 +141,7 @@ 
      *
      * @param ModelCriteria $query
      */
-    protected function joinTables(ModelCriteria &$query)
+    protected function joinTables(ModelCriteria & $query)
     {
         //TODO for specific implementations
     }
@@ -154,16 +154,16 @@ 
      */
     protected function findPk(ModelCriteria $query, $pk) {
         $pks = explode(Api::API_PK_SEPARATOR, urldecode($pk));
-        if(count($pks) == 1 && !empty($pks[0])) {
+        if (count($pks) == 1 && !empty($pks[0])) {
             $model = $query->findPk($pks[0], $this->con);
-        } else {
+        }else {
             $i = 0;
-            foreach($this->getPkDbName() as $key => $phpName) {
+            foreach ($this->getPkDbName() as $key => $phpName) {
                 try {
                     $query->filterBy($phpName, $pks[$i]);
                     $i++;
-                    if($i >= count($pks)) break;
-                } catch(\Exception $e) {
+                    if ($i >= count($pks)) break;
+                }catch (\Exception $e) {
                     Logger::log($e->getMessage(), LOG_DEBUG);
                 }
             }
@@ -193,8 +193,8 @@ 
         try {
             $query = $this->prepareQuery();
             $this->model = $this->findPk($query, $pk);
-        } catch (\Exception $e) {
-            Logger::log(get_class($this) . ': ' . $e->getMessage(), LOG_ERR);
+        }catch (\Exception $e) {
+            Logger::log(get_class($this).': '.$e->getMessage(), LOG_ERR);
         }
     }
 
@@ -215,7 +215,7 @@ 
     /**
      * @param ModelCriteria $query
      */
-    protected function checkReturnFields(ModelCriteria &$query)
+    protected function checkReturnFields(ModelCriteria & $query)
     {
         $returnFields = Request::getInstance()->getQuery(Api::API_FIELDS_RESULT_FIELD);
         if (null !== $returnFields) {

src/base/types/traits/Api/ConnectionTrait.php

Spacing +6 added lines, -6 removed lines

@@ -32,7 +32,7 @@ 
     {
         $this->con = Propel::getConnection($tableMap::DATABASE_NAME);
         $this->con->beginTransaction();
-        if(method_exists($this->con, 'useDebug')) {
+        if (method_exists($this->con, 'useDebug')) {
             Logger::log('Enabling debug queries mode', LOG_INFO);
             $this->con->useDebug(Config::getParam('debug'));
         }
@@ -45,12 +45,12 @@ 
      */
     protected function closeTransaction($status)
     {
-        if(null !== $this->con) {
+        if (null !== $this->con) {
             $this->traceDebugQuery();
             if (null !== $this->con && $this->con->inTransaction()) {
                 if ($status === 200) {
                     $this->con->commit();
-                } else {
+                }else {
                     $this->con->rollBack();
                 }
             }
@@ -72,13 +72,13 @@ 
      * Checks if the connection has a transaction initialized
      */
     protected function checkTransaction() {
-        if(null !== $this->con && !$this->con->inTransaction()) {
+        if (null !== $this->con && !$this->con->inTransaction()) {
             $this->con->beginTransaction();
         }
-        if(null !== $this->con && $this->con->inTransaction()) {
+        if (null !== $this->con && $this->con->inTransaction()) {
             $this->items++;
         }
-        if($this->items >= Config::getParam('api.block.limit', 1000)) {
+        if ($this->items >= Config::getParam('api.block.limit', 1000)) {
             $this->con->commit();
             $this->items = 0;
         }