Skip to content

Commit 778ae18

Browse files
committed
docs: update docs
1 parent 23276fe commit 778ae18

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

docs/authentication.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,6 @@ helper method provides the `auth()` command which returns a convenient interface
5454
used functionality within the auth libraries. This must be loaded before it can be used.
5555

5656
```php
57-
helper('auth');
58-
5957
// get the current user
6058
auth()->user();
6159

@@ -65,6 +63,10 @@ auth()->id();
6563
user_id();
6664
```
6765

66+
> **Note**
67+
> The `auth_helper` is autoloaded by Composer. If you want to *override* the functions,
68+
> you need to define them in `app/Common.php`.
69+
6870
## Authenticator Responses
6971

7072
Many of the authenticator methods will return a `CodeIgniter\Shield\Result` class. This provides a consistent

docs/install.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,12 +117,12 @@ class Auth extends ShieldAuth
117117
}
118118
```
119119

120-
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:
120+
2. **Helper Setup** The `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:
121121

122122
```php
123123
public function initController(RequestInterface $request, ResponseInterface $response, LoggerInterface $logger)
124124
{
125-
$this->helpers = array_merge($this->helpers, ['auth', 'setting']);
125+
$this->helpers = array_merge($this->helpers, ['setting']);
126126

127127
// Do Not Edit This Line
128128
parent::initController($request, $response, $logger);

0 commit comments

Comments
 (0)