Skip to content

Commit 2e19f3d

Browse files
dereuromarkdereuromark
committed
Relax the return type.
1 parent 25b8340 commit 2e19f3d

File tree

7 files changed

+204
-77
lines changed

7 files changed

+204
-77
lines changed

‎src/Auth/AclTrait.php‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
namespace TinyAuth\Auth;
44

5+
use ArrayAccess;
56
use BackedEnum;
67
use Cake\Core\Configure;
78
use Cake\Core\Exception\CakeException;
@@ -83,12 +84,12 @@ protected function _loadAclAdapter($adapter) {
8384
*
8485
* Allows single or multi role based authorization
8586
*
86-
* @param array<string, mixed> $user User data
87+
* @param \ArrayAccess|array<string, mixed> $user User data
8788
* @param array<string, mixed> $params Request params
8889
* @throws \Cake\Core\Exception\CakeException
8990
* @return bool Success
9091
*/
91-
protected function _checkUser(array $user, array $params) {
92+
protected function _checkUser(ArrayAccess|array $user, array $params): bool {
9293
if ($this->getConfig('includeAuthentication') && $this->_isPublic($params)) {
9394
return true;
9495
}
@@ -512,19 +513,18 @@ protected function _getRolesFromDb(string $rolesTableKey): array {
512513
* - direct lookup in the pivot table (to support both Configure and Model
513514
* in multi-role mode)
514515
*
515-
* @param array $user The user to get the roles for
516-
* @throws \Cake\Core\Exception\CakeException
516+
* @param \ArrayAccess|array $user The user to get the roles for
517517
* @return array<string, int|string> List with all role ids belonging to the user
518518
*/
519-
protected function _getUserRoles(array $user) {
519+
protected function _getUserRoles(ArrayAccess|array $user) {
520520
// Single-role from session
521521
if (!$this->getConfig('multiRole')) {
522522
$roleColumn = $this->getConfig('roleColumn');
523523
if (!$roleColumn) {
524524
throw new CakeException('Invalid TinyAuth config, `roleColumn` config missing.');
525525
}
526526

527-
if (!array_key_exists($roleColumn, $user)) {
527+
if (!array_key_exists($roleColumn, (array)$user)) {
528528
throw new CakeException(sprintf('Missing TinyAuth role id field (%s) in user session', 'Auth.User.' . $this->getConfig('roleColumn')));
529529
}
530530
if (!isset($user[$this->getConfig('roleColumn')])) {

‎src/Auth/AuthUserTrait.php‎

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22

33
namespace TinyAuth\Auth;
44

5+
use ArrayAccess;
56
use Cake\Utility\Hash;
7+
use InvalidArgumentException;
8+
use Traversable;
69

710
/**
811
* Convenience wrapper to access Auth data and check on rights/roles.
@@ -42,7 +45,7 @@ trait AuthUserTrait {
4245
*
4346
* This can be used anywhere to check if a user is logged in.
4447
*
45-
* @return mixed User id if existent, null otherwise.
48+
* @return string|int|null User id if existent, null otherwise.
4649
*/
4750
public function id() {
4851
$field = $this->getConfig('idColumn');
@@ -57,7 +60,7 @@ public function id() {
5760
* @param string|int $userId
5861
* @return bool
5962
*/
60-
public function isMe($userId) {
63+
public function isMe($userId): bool {
6164
$field = $this->getConfig('idColumn');
6265

6366
return $userId && (string)$userId === (string)$this->user($field);
@@ -69,7 +72,7 @@ public function isMe($userId) {
6972
* @param string|null $key Key in dot syntax.
7073
* @return mixed Data
7174
*/
72-
public function user($key = null) {
75+
public function user(?string $key = null) {
7376
$user = $this->_getUser();
7477
if ($key === null) {
7578
return $user;
@@ -86,7 +89,7 @@ public function user($key = null) {
8689
*
8790
* @return array Array of roles
8891
*/
89-
public function roles() {
92+
public function roles(): array {
9093
$user = $this->user();
9194
if (!$user) {
9295
return [];
@@ -133,7 +136,7 @@ public function hasRole($expectedRole, $providedRoles = null) {
133136
* @param mixed|null $providedRoles
134137
* @return bool Success
135138
*/
136-
public function hasRoles($expectedRoles, $oneRoleIsEnough = true, $providedRoles = null) {
139+
public function hasRoles($expectedRoles, $oneRoleIsEnough = true, $providedRoles = null): bool {
137140
if ($providedRoles !== null) {
138141
$roles = $providedRoles;
139142
} else {
@@ -166,4 +169,26 @@ public function hasRoles($expectedRoles, $oneRoleIsEnough = true, $providedRoles
166169
return false;
167170
}
168171

172+
/**
173+
* @param \ArrayAccess|array $identity
174+
* @return array
175+
*/
176+
protected function _toArray(ArrayAccess|array $identity): array {
177+
if (is_array($identity)) {
178+
return $identity;
179+
}
180+
181+
if (method_exists($identity, 'toArray')) {
182+
return $identity->toArray();
183+
}
184+
if ($identity instanceof Traversable) {
185+
return iterator_to_array($identity);
186+
}
187+
if (!$identity instanceof \Countable) {
188+
throw new InvalidArgumentException('You cannot use a pure ArrayAccess object as identity. Use Entity or ArrayObject at least.');
189+
}
190+
191+
return (array)$identity;
192+
}
193+
169194
}

‎src/Controller/Component/AuthUserComponent.php‎

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
namespace TinyAuth\Controller\Component;
44

5+
use ArrayAccess;
56
use Authentication\Identity;
67
use Cake\Controller\Component;
78
use Cake\Controller\ComponentRegistry;
8-
use Cake\Datasource\EntityInterface;
99
use Cake\Event\EventInterface;
1010
use TinyAuth\Auth\AclTrait;
1111
use TinyAuth\Auth\AllowTrait;
@@ -44,19 +44,17 @@ public function beforeRender(EventInterface $event) {
4444
}
4545

4646
/**
47-
* @return \Cake\Datasource\EntityInterface|null
47+
* @return \ArrayAccess|array|null
4848
*/
49-
public function identity(): ?EntityInterface {
49+
public function identity(): ArrayAccess|array|null {
5050
/** @var \Authorization\Identity|\Authentication\Identity|null $identity */
5151
$identity = $this->getController()->getRequest()->getAttribute('identity');
5252
if (!$identity) {
5353
return null;
5454
}
5555

56-
/** @var \Cake\Datasource\EntityInterface $data */
57-
$data = $identity->getOriginalData();
58-
59-
return $data;
56+
/** @var \ArrayAccess|array|null */
57+
return $identity->getOriginalData();
6058
}
6159

6260
/**
@@ -80,13 +78,11 @@ public function hasAccess(array $url): bool {
8078
/**
8179
* @return array
8280
*/
83-
protected function _getUser() {
81+
protected function _getUser(): array {
8482
if (class_exists(Identity::class)) {
85-
/** @var \Cake\ORM\Entity|null $identity */
8683
$identity = $this->identity();
87-
if ($identity) {
88-
return $identity->toArray();
89-
}
84+
85+
return $identity ? $this->_toArray($identity) : [];
9086
}
9187

9288
// We skip for new plugin(s)

‎src/View/Helper/AuthUserHelper.php‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
use ArrayAccess;
66
use Authentication\Identity;
77
use Cake\Core\Exception\CakeException;
8-
use Cake\Datasource\EntityInterface;
98
use Cake\Routing\Router;
109
use Cake\View\Helper;
1110
use Cake\View\View;
@@ -40,16 +39,16 @@ public function __construct(View $View, array $config = []) {
4039
}
4140

4241
/**
43-
* @return \Cake\Datasource\EntityInterface|null
42+
* @return \ArrayAccess|array|null
4443
*/
45-
public function identity(): ?EntityInterface {
44+
public function identity(): ArrayAccess|array|null {
4645
/** @var \Authorization\Identity|\Authentication\Identity|null $identity */
4746
$identity = $this->_View->getRequest()->getAttribute('identity');
4847
if (!$identity) {
4948
return null;
5049
}
5150

52-
/** @var \Cake\Datasource\EntityInterface */
51+
/** @var \ArrayAccess|array|null */
5352
return $identity->getOriginalData();
5453
}
5554

@@ -159,20 +158,19 @@ protected function _default($title, array $options) {
159158
* @throws \Cake\Core\Exception\CakeException
160159
* @return array
161160
*/
162-
protected function _getUser() {
161+
protected function _getUser(): array {
163162
if (class_exists(Identity::class)) {
164163
$identity = $this->identity();
165-
if ($identity) {
166-
return $identity->toArray();
167-
}
164+
165+
return $identity ? $this->_toArray($identity) : [];
168166
}
169167

170168
$authUser = $this->_View->get('_authUser');
171169
if ($authUser === null) {
172170
throw new CakeException('TinyAuth.AuthUser helper needs TinyAuth.AuthUser component to function. Please make sure it is loaded in your controller.');
173171
}
174172

175-
return $authUser;
173+
return (array)$authUser;
176174
}
177175

178176
}

0 commit comments

Comments
 (0)