Merge pull request #368 from kenjis/autoload-helpers

feat: autoload helpers by Composer

Author: kenjis

composer.json

@@ -37,6 +37,10 @@
         },
         "exclude-from-classmap": [
             "**/Database/Migrations/**"
+        ],
+        "files": [
+            "src/Helpers/auth_helper.php",
+            "src/Helpers/email_helper.php"
         ]
     },
     "autoload-dev": {

docs/authentication.md

@@ -54,8 +54,6 @@ helper method provides the `auth()` command which returns a convenient interface
 used functionality within the auth libraries. This must be loaded before it can be used.
 
 ```php
-helper('auth');
-
 // get the current user
 auth()->user();
 
@@ -65,6 +63,10 @@ auth()->id();
 user_id();
 ```
 
+> **Note**
+> The `auth_helper` is autoloaded by Composer. If you want to *override* the functions,
+> you need to define them in `app/Common.php`.
+
 ## Authenticator Responses
 
 Many of the authenticator methods will return a `CodeIgniter\Shield\Result` class. This provides a consistent

docs/install.md

@@ -117,12 +117,12 @@ class Auth extends ShieldAuth
 }
 ```
 
-2. **Helper Setup** The `auth` and `setting` helpers need to be included in almost every page. The simplest way to do this is to add them to the `BaseController::initController` method:
+2. **Helper Setup** The `setting` helper needs to be included in almost every page. The simplest way to do this is to add them to the `BaseController::initController` method:
 
 ```php
 public function initController(RequestInterface $request, ResponseInterface $response, LoggerInterface $logger)
 {
-    $this->helpers = array_merge($this->helpers, ['auth', 'setting']);
+    $this->helpers = array_merge($this->helpers, ['setting']);
 
     // Do Not Edit This Line
     parent::initController($request, $response, $logger);

src/Authentication/Actions/Email2FA.php

@@ -70,7 +70,6 @@ public function handle(IncomingRequest $request)
         }
 
         // Send the user an email with the code
-        helper('email');
         $email = emailer()->setFrom(setting('Email.fromEmail'), setting('Email.fromName') ?? '');
         $email->setTo($user->email);
         $email->setSubject(lang('Auth.email2FASubject'));

src/Authentication/Actions/EmailActivator.php

@@ -40,7 +40,6 @@ public function show(): string
         $code = $this->createIdentity($user);
 
         // Send the email
-        helper('email');
         $email = emailer()->setFrom(setting('Email.fromEmail'), setting('Email.fromName') ?? '');
         $email->setTo($userEmail);
         $email->setSubject(lang('Auth.emailActivateSubject'));

src/Commands/Setup.php

@@ -195,11 +195,44 @@ protected function add(string $file, string $code, string $pattern, string $repl
         }
     }
 
+    /**
+     * @param string $file     Relative file path like 'Controllers/BaseController.php'.
+     * @param array  $replaces [search => replace]
+     */
+    protected function replace(string $file, array $replaces): void
+    {
+        $path      = $this->distPath . $file;
+        $cleanPath = clean_path($path);
+
+        $content = file_get_contents($path);
+
+        $output = $this->replacer->replace($content, $replaces);
+
+        if ($output === $content) {
+            CLI::error("  Skipped {$cleanPath}. It has already been updated.");
+
+            return;
+        }
+
+        if (write_file($path, $output)) {
+            CLI::write(CLI::color('  Updated: ', 'green') . $cleanPath);
+        } else {
+            CLI::error("  Error updating {$cleanPath}.");
+        }
+    }
+
     private function setupHelper(): void
     {
-        $file = 'Controllers/BaseController.php';
+        $file  = 'Controllers/BaseController.php';
+        $check = '$this->helpers = array_merge($this->helpers, [\'setting\']);';
+
+        // Replace old helper setup
+        $replaces = [
+            '$this->helpers = array_merge($this->helpers, [\'auth\', \'setting\']);' => $check,
+        ];
+        $this->replace($file, $replaces);
 
-        $check   = '$this->helpers = array_merge($this->helpers, [\'auth\', \'setting\']);';
+        // Add helper setup
         $pattern = '/(' . preg_quote('// Do Not Edit This Line', '/') . ')/u';
         $replace = $check . "\n\n        " . '$1';
 

src/Controllers/LoginController.php

@@ -8,7 +8,7 @@
 
 class LoginController extends BaseController
 {
-    protected $helpers = ['auth', 'setting'];
+    protected $helpers = ['setting'];
 
     /**
      * Displays the form the login to the site.

src/Controllers/MagicLinkController.php

@@ -89,7 +89,6 @@ public function loginAction()
         ]);
 
         // Send the user an email with the code
-        helper('email');
         $email = emailer()->setFrom(setting('Email.fromEmail'), setting('Email.fromName') ?? '');
         $email->setTo($user->email);
         $email->setSubject(lang('Auth.magicLinkSubject'));

src/Entities/AccessToken.php

@@ -36,8 +36,6 @@ class AccessToken extends Entity
     public function user(): ?User
     {
         if ($this->user === null) {
-            helper('auth');
-
             $users      = auth()->getProvider();
             $this->user = $users->findById($this->user_id);
         }

src/Filters/ChainAuth.php

@@ -33,7 +33,7 @@ class ChainAuth implements FilterInterface
      */
     public function before(RequestInterface $request, $arguments = null)
     {
-        helper(['auth', 'settings']);
+        helper('settings');
 
         $chain = config('Auth')->authenticationChain;