psfs / core

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
      * @param $isReturn
      * @return array
@@ -87,7 +87,7 @@ 
      * Translator from php types to swagger types
      * @param string $format
      *
-     * @return array
+     * @return string[]
      */
     public static function translateSwaggerFormats($format)
     {

Spacing +11 added lines, -11 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',
@@ -59,18 +59,18 @@ 
             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,
                     ],
                 ];
             }
 
-            if($paths[$url][$method]['responses'][200]['schema']['properties']['data']['type'] === 'boolean') {
+            if ($paths[$url][$method]['responses'][200]['schema']['properties']['data']['type'] === 'boolean') {
                 $paths[$url][$method]['responses'][200]['schema']['properties']['data'] = $classDefinition;
             }
             $dtos += self::extractSwaggerDefinition($class, $object);
@@ -148,18 +148,18 @@ 
             ],
         ];
         foreach ($fields as $field => $info) {
-            if(array_key_exists('type', $info) || in_array($info['type'], ['array', 'object'])) {
+            if (array_key_exists('type', $info) || in_array($info['type'], ['array', 'object'])) {
                 $definition[$name]['properties'][$field] = $info;
-            } else {
+            }else {
                 list($type, $format) = self::translateSwaggerFormats($info['type']);
                 $fieldData = [
                     "type" => $type,
                     "required" => $info['required'],
                 ];
-                if(array_key_exists('description', $info)) {
+                if (array_key_exists('description', $info)) {
                     $fieldData['description'] = $info['description'];
                 }
-                if(array_key_exists('format', $info)) {
+                if (array_key_exists('format', $info)) {
                     $fieldData['format'] = $info['format'];
                 }
                 $dto['properties'][$field] = $fieldData;

src/base/types/helpers/InjectorHelper.php

Unused Use Statements -1 removed lines

@@ -3,7 +3,6 @@
 
 use PSFS\base\Logger;
 use PSFS\base\Router;
-use PSFS\services\DocumentorService;
 
 /**
  * Class InjectorHelper

Spacing +8 added lines, -8 removed lines

@@ -27,10 +27,10 @@ 
                 $isRequired = self::checkIsRequired($property->getDocComment());
                 $label = self::getLabel($property->getDocComment());
                 $isArray = (bool)preg_match('/\[\]$/', $instanceType);
-                if($isArray) {
+                if ($isArray) {
                     $instanceType = str_replace('[]', '', $instanceType);
                 }
-                if(!Router::exists($instanceType) || $instanceType === '\\DateTime') {
+                if (!Router::exists($instanceType) || $instanceType === '\\DateTime') {
                     list($type, $format) = DocumentorHelper::translateSwaggerFormats($instanceType);
                     $variables[$property->getName()] = [
                         'type' => $type,
@@ -38,7 +38,7 @@ 
                         'required' => $isRequired,
                         'description' => $label,
                     ];
-                } else {
+                }else {
                     $instance = new \ReflectionClass($instanceType);
                     $variables[$property->getName()] = [
                         'is_array' => $isArray,
@@ -124,7 +124,7 @@ 
         // Extract description
         $label = null;
         preg_match('/@label\ (.*)\n/i', $doc, $matches);
-        if(count($matches)) {
+        if (count($matches)) {
             $label = _($matches[1]);
         }
         return $label;
@@ -137,7 +137,7 @@ 
     public static function getDefaultValue($doc) {
         $default = null;
         preg_match('/@default\ (.*)\n/i', $doc, $matches);
-        if(count($matches)) {
+        if (count($matches)) {
             $default = $matches[1];
         }
         return $default;
@@ -153,13 +153,13 @@ 
      */
     public static function constructInyectableInstance($variable, $singleton, $classNameSpace, $calledClass)
     {
-        Logger::log('Create inyectable instance for ' . $classNameSpace);
+        Logger::log('Create inyectable instance for '.$classNameSpace);
         $reflector = new \ReflectionClass($calledClass);
         $property = $reflector->getProperty($variable);
         $varInstanceType = (null === $classNameSpace) ? InjectorHelper::extractVarType($property->getDocComment()) : $classNameSpace;
         if (true === $singleton && method_exists($varInstanceType, "getInstance")) {
             $instance = $varInstanceType::getInstance();
-        } else {
+        }else {
             $instance = new $varInstanceType();
         }
         return $instance;
@@ -173,7 +173,7 @@ 
     public static function getClassProperties($class)
     {
         $properties = [];
-        Logger::log('Extracting annotations properties from class ' . $class);
+        Logger::log('Extracting annotations properties from class '.$class);
         $selfReflector = new \ReflectionClass($class);
         if (false !== $selfReflector->getParentClass()) {
             $properties = self::getClassProperties($selfReflector->getParentClass()->getName());

src/services/DocumentorService.php

Spacing +24 added lines, -24 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;
         }
 
@@ -339,10 +339,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;
@@ -350,7 +350,7 @@ 
             } elseif (null !== $reflector && $reflector->isSubclassOf(self::DTO_INTERFACE)) {
                 $payload = $this->extractDtoProperties($namespace);
             }
-        } catch (\Exception $e) {
+        }catch (\Exception $e) {
             Logger::getInstance()->errorLog($e->getMessage());
         }
 
@@ -381,7 +381,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,
@@ -392,7 +392,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());
                 }
             }
@@ -461,10 +461,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"),
@@ -477,7 +477,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] = [
@@ -538,7 +538,7 @@ 
     protected function extractDtoName($dto, $isArray = false)
     {
         $dto = explode('\\', $dto);
-        $modelDto = array_pop($dto) . "Dto";
+        $modelDto = array_pop($dto)."Dto";
         if ($isArray) {
             $modelDto .= "List";
         }
@@ -588,10 +588,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",
@@ -635,7 +635,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];
                 }
@@ -657,21 +657,21 @@ 
                     $modelDto['objects'][$dtoName][$param] = [
                         'type' => 'array',
                         'items' => [
-                            '$ref' => '#/definitions/' . $info['shortName'],
+                            '$ref' => '#/definitions/'.$info['shortName'],
                         ]
                     ];
-                } else {
+                }else {
                     $modelDto['objects'][$dtoName][$param] = [
                         'type' => 'object',
-                        '$ref' => '#/definitions/' . $info['shortName'],
+                        '$ref' => '#/definitions/'.$info['shortName'],
                     ];
                 }
                 $modelDto['objects'][$info['class']] = $info['variables'];
                 $paramDto = $this->checkDtoAttributes($info['variables'], $info['variables'], $info['class']);
-                if(array_key_exists('objects', $paramDto)) {
+                if (array_key_exists('objects', $paramDto)) {
                     $modelDto['objects'] = array_merge($modelDto['objects'], $paramDto['objects']);
                 }
-            } else {
+            }else {
                 $modelDto['objects'][$dtoName][$param] = $info;
             }
         }