Fix code style according to PSR12

mikopbx · Oct 4, 2024 · c87c460 · c87c460
1 parent d733c7b
commit c87c460
Show file tree

Hide file tree

Showing 310 changed files with 2,326 additions and 2,026 deletions.
diff --git a/composer.json b/composer.json
@@ -17,6 +17,7 @@
         "ext-sqlite3": "*",
         "ext-zip": "*",
         "ext-mailparse": "*",
+        "ext-xdebug": "*",
         "filp/whoops": "^2.15.2",
         "guzzlehttp/guzzle": "^7.5.3",
         "malkusch/lock": "*",
@@ -31,13 +32,13 @@
         "sentry/sdk": "^3.3.0"
     },
     "require-dev": {
-        "ext-xdebug": "*",
-        "roave/security-advisories": "dev-master",
+      "roave/security-advisories": "dev-master",
         "phpunit/phpunit-selenium": "^9.0",
         "php-webdriver/webdriver": "^1.14.0",
         "browserstack/browserstack-local": "^v1.1.0",
         "phpunit/phpunit": "^9.0",
-        "phalcon/ide-stubs": "^5.0.0"
+        "phalcon/ide-stubs": "^5.0.0",
+        "squizlabs/php_codesniffer": "*"
     },
     "autoload": {
         "psr-4": {
@@ -97,5 +98,8 @@
         "allow-plugins": {
             "php-http/discovery": true
         }
+    },
+    "scripts": {
+        "phpcs": "phpcs --standard=PSR12"
     }
 }
diff --git a/sites/admin-cabinet/index.php b/sites/admin-cabinet/index.php
@@ -16,12 +16,10 @@
  * You should have received a copy of the GNU General Public License along with this program.
  * If not, see <https://www.gnu.org/licenses/>.
  */
+namespace MikoPBX\AdminCabinet;
 
 use MikoPBX\Common\Config\RegisterDIServices as RegisterCommonDIServices;
 use MikoPBX\Common\Handlers\CriticalErrorsHandler;
-use MikoPBX\Common\Providers\RegistryProvider;
-use MikoPBX\Common\Providers\SentryErrorHandlerProvider;
-use MikoPBX\Common\Providers\WhoopsErrorHandlerProvider;
 use MikoPBX\Modules\PbxExtensionUtils;
 use Phalcon\Mvc\Application as BaseApplication;
 
@@ -33,7 +31,7 @@ class Application extends BaseApplication
     protected function registerServices()
     {
 
-        $di = new Phalcon\Di\FactoryDefault();
+        $di = new \Phalcon\Di\FactoryDefault();
 
         /**
          * Auto-loader configuration
@@ -63,11 +61,11 @@ public function main()
 
         try {
             echo $this->handle($_SERVER['REQUEST_URI'])->getContent();
-        } catch (Throwable $e) {
+        } catch (\Throwable $e) {
             CriticalErrorsHandler::handleException($e);
         }
     }
 }
 
 $application = new Application();
-$application->main();
+$application->main();
diff --git a/sites/pbxcore/index.php b/sites/pbxcore/index.php
@@ -43,7 +43,7 @@ public function main()
 
         // Start application
         try {
-            $requestUri = sprintf('/pbxcore%s',$_REQUEST['_url']);
+            $requestUri = sprintf('/pbxcore%s', $_REQUEST['_url']);
             $application->handle($requestUri);
         } catch (Throwable $e) {
             CriticalErrorsHandler::handleException($e);
@@ -52,4 +52,4 @@ public function main()
 }
 
 $restApi = new RestAPI();
-$restApi->main();
+$restApi->main();
diff --git a/src/AdminCabinet/Config/RegisterDIServices.php b/src/AdminCabinet/Config/RegisterDIServices.php
@@ -21,34 +21,34 @@
 
 namespace MikoPBX\AdminCabinet\Config;
 
-use MikoPBX\AdminCabinet\Providers\{AssetProvider,
-    CryptProvider,
-    DispatcherProvider,
-    ElementsProvider,
-    FlashProvider,
-    SecurityPluginProvider,
-    ViewProvider,
-    VoltProvider};
-use MikoPBX\Common\Providers\{AclProvider,
-    BeanstalkConnectionModelsProvider,
-    CDRDatabaseProvider,
-    LanguageProvider,
-    MarketPlaceProvider,
-    LoggerAuthProvider,
-    LoggerProvider,
-    MainDatabaseProvider,
-    ManagedCacheProvider,
-    MessagesProvider,
-    ModelsAnnotationsProvider,
-    ModelsMetadataProvider,
-    ModulesDBConnectionsProvider,
-    PBXConfModulesProvider,
-    PBXCoreRESTClientProvider,
-    RegistryProvider,
-    RouterProvider,
-    SessionProvider,
-    TranslationProvider,
-    UrlProvider,};
+use MikoPBX\AdminCabinet\Providers\AssetProvider;
+use MikoPBX\AdminCabinet\Providers\CryptProvider;
+use MikoPBX\AdminCabinet\Providers\DispatcherProvider;
+use MikoPBX\AdminCabinet\Providers\ElementsProvider;
+use MikoPBX\AdminCabinet\Providers\FlashProvider;
+use MikoPBX\AdminCabinet\Providers\SecurityPluginProvider;
+use MikoPBX\AdminCabinet\Providers\ViewProvider;
+use MikoPBX\AdminCabinet\Providers\VoltProvider;
+use MikoPBX\Common\Providers\AclProvider;
+use MikoPBX\Common\Providers\BeanstalkConnectionModelsProvider;
+use MikoPBX\Common\Providers\CDRDatabaseProvider;
+use MikoPBX\Common\Providers\LanguageProvider;
+use MikoPBX\Common\Providers\MarketPlaceProvider;
+use MikoPBX\Common\Providers\LoggerAuthProvider;
+use MikoPBX\Common\Providers\LoggerProvider;
+use MikoPBX\Common\Providers\MainDatabaseProvider;
+use MikoPBX\Common\Providers\ManagedCacheProvider;
+use MikoPBX\Common\Providers\MessagesProvider;
+use MikoPBX\Common\Providers\ModelsAnnotationsProvider;
+use MikoPBX\Common\Providers\ModelsMetadataProvider;
+use MikoPBX\Common\Providers\ModulesDBConnectionsProvider;
+use MikoPBX\Common\Providers\PBXConfModulesProvider;
+use MikoPBX\Common\Providers\PBXCoreRESTClientProvider;
+use MikoPBX\Common\Providers\RegistryProvider;
+use MikoPBX\Common\Providers\RouterProvider;
+use MikoPBX\Common\Providers\SessionProvider;
+use MikoPBX\Common\Providers\TranslationProvider;
+use MikoPBX\Common\Providers\UrlProvider;
 use Phalcon\Di\DiInterface;
 
 class RegisterDIServices
@@ -123,7 +123,7 @@ public static function init(DiInterface $di): void
             $di->register(new $provider());
         }
 
-        // Set library name
+        // Set the library name
         $di->getShared(RegistryProvider::SERVICE_NAME)->libraryName = 'admin-cabinet';
     }
-}
+}
diff --git a/src/AdminCabinet/Controllers/AsteriskManagersController.php b/src/AdminCabinet/Controllers/AsteriskManagersController.php
@@ -20,7 +20,8 @@
 namespace MikoPBX\AdminCabinet\Controllers;
 
 use MikoPBX\AdminCabinet\Forms\AsteriskManagerEditForm;
-use MikoPBX\Common\Models\{AsteriskManagerUsers, NetworkFilters};
+use MikoPBX\Common\Models\AsteriskManagerUsers;
+use MikoPBX\Common\Models\NetworkFilters;
 use Phalcon\Mvc\Model\Resultset;
 
 class AsteriskManagersController extends BaseController
@@ -135,7 +136,7 @@ public function saveAction(): void
                 $manager->$name.= ($data[$name . '_write'] === 'on') ? 'write' : '';
                 continue;
             }
-            if ( ! array_key_exists($name, $data)) {
+            if (! array_key_exists($name, $data)) {
                 continue;
             }
             $manager->$name = $data[$name];
@@ -179,4 +180,4 @@ public function availableAction(string $username): void
         $this->view->setVar('nameAvailable', $result);
         $this->view->setVar('success', true);
     }
-}
+}
diff --git a/src/AdminCabinet/Controllers/BaseController.php b/src/AdminCabinet/Controllers/BaseController.php
@@ -23,11 +23,14 @@
 use MikoPBX\Common\Providers\PBXConfModulesProvider;
 use MikoPBX\Common\Providers\SentryErrorHandlerProvider;
 use MikoPBX\Modules\Config\WebUIConfigInterface;
-use MikoPBX\Common\Models\{PbxExtensionModules, PbxSettings};
+use MikoPBX\Common\Models\PbxExtensionModules;
+use MikoPBX\Common\Models\PbxSettings;
 use Phalcon\Filter\Filter;
 use Phalcon\Flash\Exception;
 use Phalcon\Http\ResponseInterface;
-use Phalcon\Mvc\{Controller, Dispatcher, View};
+use Phalcon\Mvc\Controller;
+use Phalcon\Mvc\Dispatcher;
+use Phalcon\Mvc\View;
 use Phalcon\Tag;
 
 /**
@@ -67,7 +70,7 @@ public function initialize(): void
     }
 
     /**
-     * Prepares the view by setting necessary variables and configurations.
+     * Prepares the view by setting the necessary variables and configurations.
      *
      * @return void
      */
@@ -94,11 +97,11 @@ protected function prepareView(): void
         // Set the title based on the current action
         $title = 'MikoPBX';
         switch ($this->actionName) {
-            case'index':
-            case'delete':
-            case'save':
-            case'modify':
-            case'*** WITHOUT ACTION ***':
+            case 'index':
+            case 'delete':
+            case 'save':
+            case 'modify':
+            case '*** WITHOUT ACTION ***':
                 $title .= '|' . $this->translation->_("Breadcrumb$this->controllerName");
                 break;
             default:
@@ -120,7 +123,7 @@ protected function prepareView(): void
         $this->view->MetaTegHeadDescription = $this->translation->_('MetaTegHeadDescription');
         $this->view->isExternalModuleController = $this->isExternalModuleController;
 
-        if ($this->controllerClass!==SessionController::class){
+        if ($this->controllerClass!==SessionController::class) {
             $this->view->setTemplateAfter('main');
         }
 
@@ -167,11 +170,11 @@ public function beforeExecuteRoute(Dispatcher $dispatcher): void
         // Add module variables into view if it is an external module controller
         if (str_starts_with($this->dispatcher->getNamespaceName(), 'Modules')) {
             $this->view->pick("Modules/{$this->getModuleUniqueId()}/$this->controllerName/$this->actionName");
-        } else  {
+        } else {
             $this->view->pick("$this->controllerName/$this->actionName");
         }
 
-        PBXConfModulesProvider::hookModulesMethod(WebUIConfigInterface::ON_BEFORE_EXECUTE_ROUTE,[$dispatcher]);
+        PBXConfModulesProvider::hookModulesMethod(WebUIConfigInterface::ON_BEFORE_EXECUTE_ROUTE, [$dispatcher]);
     }
 
     /**
@@ -198,8 +201,8 @@ public function afterExecuteRoute(Dispatcher $dispatcher): ResponseInterface
                 $data['message'] = $data['message'] ?? $this->flash->getMessages();
 
                 // Let's add information about the last error to display a dialog window for the user.
-                $sentry =  $this->di->get(SentryErrorHandlerProvider::SERVICE_NAME,['admin-cabinet']);
-                if ($sentry){
+                $sentry =  $this->di->get(SentryErrorHandlerProvider::SERVICE_NAME, ['admin-cabinet']);
+                if ($sentry) {
                     $data['lastSentryEventId'] = $sentry->getLastEventId();
                 }
 
@@ -208,7 +211,7 @@ public function afterExecuteRoute(Dispatcher $dispatcher): ResponseInterface
             $this->response->setContent($result);
         }
 
-        PBXConfModulesProvider::hookModulesMethod(WebUIConfigInterface::ON_AFTER_EXECUTE_ROUTE,[$dispatcher]);
+        PBXConfModulesProvider::hookModulesMethod(WebUIConfigInterface::ON_AFTER_EXECUTE_ROUTE, [$dispatcher]);
 
         return $this->response->send();
     }
@@ -222,7 +225,7 @@ public function afterExecuteRoute(Dispatcher $dispatcher): ResponseInterface
     protected function forward(string $uri): void
     {
         $uriParts = explode('/', $uri);
-        if ($this->isExternalModuleController and count($uriParts)>2){
+        if ($this->isExternalModuleController and count($uriParts)>2) {
             $params = array_slice($uriParts, 3);
             $moduleUniqueID = $this->getModuleUniqueId();
             $this->dispatcher->forward(
@@ -297,7 +300,7 @@ private function setLastSentryEventId(): ?\Sentry\EventId
         $result = null;
         // Allow anonymous statistics collection for JS code
         $sentry =  $this->di->get(SentryErrorHandlerProvider::SERVICE_NAME);
-        if ($sentry){
+        if ($sentry) {
             $result = $sentry->getLastEventId();
         }
         return $result;
@@ -322,7 +325,7 @@ private function getModuleUniqueId():string
      * @param mixed $entity The entity to be saved.
      * @return bool True if the entity was successfully saved, false otherwise.
      */
-    protected function saveEntity(mixed $entity, string $reloadPath=''): bool
+    protected function saveEntity(mixed $entity, string $reloadPath = ''): bool
     {
         $success = $entity->save();
 
@@ -331,14 +334,14 @@ protected function saveEntity(mixed $entity, string $reloadPath=''): bool
             $this->flash->error(implode('<br>', $errors));
         } elseif (!$this->request->isAjax()) {
             $this->flash->success($this->translation->_('ms_SuccessfulSaved'));
-            if ($reloadPath!==''){
+            if ($reloadPath!=='') {
                 $this->forward($reloadPath);
             }
         }
 
         if ($this->request->isAjax()) {
             $this->view->success = $success;
-            if ($reloadPath!=='' && $success){
+            if ($reloadPath!=='' && $success) {
                 $this->view->reload = str_replace('{id}', $entity->id, $reloadPath);
             }
         }
@@ -353,7 +356,7 @@ protected function saveEntity(mixed $entity, string $reloadPath=''): bool
      * @param mixed $entity The entity to be deleted.
      * @return bool True if the entity was successfully deleted, false otherwise.
      */
-    protected function deleteEntity(mixed $entity, string $reloadPath=''): bool
+    protected function deleteEntity(mixed $entity, string $reloadPath = ''): bool
     {
         $success = $entity->delete();
 
@@ -362,14 +365,14 @@ protected function deleteEntity(mixed $entity, string $reloadPath=''): bool
             $this->flash->error(implode('<br>', $errors));
         } elseif (!$this->request->isAjax()) {
             // $this->flash->success($this->translation->_('ms_SuccessfulSaved'));
-            if ($reloadPath!==''){
+            if ($reloadPath!=='') {
                 $this->forward($reloadPath);
             }
         }
 
         if ($this->request->isAjax()) {
             $this->view->success = $success;
-            if ($reloadPath!=='' && $success){
+            if ($reloadPath!=='' && $success) {
                 $this->view->reload = $reloadPath;
             }
         }
@@ -438,5 +441,4 @@ public static function sanitizeData(array $data, \Phalcon\Filter\FilterInterface
 
         return $data;
     }
-
 }