Skip to content

Commit 7a4321b

Browse files
tvdijensgomez
tvdijen
authored and
sgomez
committed
Added PHPdoc headers and PSR-12 code style (#32)
Added: * PHPdoc * PHPdoc tests * PSR-12 code style
1 parent 9eedd12 commit 7a4321b

File tree

75 files changed

+1492
-84
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+1492
-84
lines changed

‎hooks/hook_cron.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ function oidc_hook_cron(&$croninfo)
3939

4040
$croninfo['summary'][] = 'Module `oidc` clean up. Removed expired entries from storage.';
4141
} catch (Exception $e) {
42-
$message = 'Module `oidc` clean up cron script failed: '.$e->getMessage();
42+
$message = 'Module `oidc` clean up cron script failed: ' . $e->getMessage();
4343
\SimpleSAML\Logger::warning($message);
4444
$croninfo['summary'][] = $message;
4545
}

‎lib/ClaimTranslatorExtractor.php

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919

2020
class ClaimTranslatorExtractor extends ClaimExtractor
2121
{
22+
/** @var array */
2223
protected $translationTable = [
2324
'sub' => [
2425
'eduPersonPrincipalName',
@@ -84,6 +85,7 @@ class ClaimTranslatorExtractor extends ClaimExtractor
8485
],
8586
];
8687

88+
8789
/**
8890
* ClaimTranslatorExtractor constructor.
8991
*
@@ -104,13 +106,18 @@ public function __construct($claimSets = [], $translationTable = [])
104106
parent::__construct($claimSets);
105107
}
106108

109+
110+
/**
111+
* @param array $samlAttributes
112+
* @return array
113+
*/
107114
private function translateSamlAttributesToClaims($samlAttributes): array
108115
{
109116
$claims = [];
110117

111118
foreach ($this->translationTable as $claim => $samlMatches) {
112119
foreach ($samlMatches as $samlMatch) {
113-
if (\array_key_exists($samlMatch, $samlAttributes)) {
120+
if (array_key_exists($samlMatch, $samlAttributes)) {
114121
$claims[$claim] = current($samlAttributes[$samlMatch]);
115122
break;
116123
}
@@ -120,6 +127,12 @@ private function translateSamlAttributesToClaims($samlAttributes): array
120127
return $claims;
121128
}
122129

130+
131+
/**
132+
* @param array $scopes
133+
* @param array $samlAttributes
134+
* @return array
135+
*/
123136
public function extract(array $scopes, array $samlAttributes)
124137
{
125138
$claims = $this->translateSamlAttributesToClaims($samlAttributes);

‎lib/Controller/ClientCreateController.php

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,18 +31,27 @@ class ClientCreateController
3131
use GetClientFromRequestTrait;
3232

3333
/**
34-
* @var TemplateFactory
34+
* @var \SimpleSAML\Modules\OpenIDConnect\Factories\TemplateFactory
3535
*/
3636
private $templateFactory;
37+
3738
/**
38-
* @var FormFactory
39+
* @var \SimpleSAML\Modules\OpenIDConnect\Factories\FormFactory
3940
*/
4041
private $formFactory;
42+
4143
/**
42-
* @var SessionMessagesService
44+
* @var \SimpleSAML\Modules\OpenIDConnect\Services\SessionMessagesService
4345
*/
4446
private $messages;
4547

48+
49+
/**
50+
* @param \SimpleSAML\Modules\OpenIDConnect\Repositories\ClientRepository $clientRepository
51+
* @param \SimpleSAML\Modules\OpenIDConnect\Factories\TemplateFactory $templateFactory
52+
* @param \SimpleSAML\Modules\OpenIDConnect\Factories\FormFactory $formFactory
53+
* @param \SimpleSAML\Modules\OpenIDConnect\Services\SessionMessagesService $messages
54+
*/
4655
public function __construct(
4756
ClientRepository $clientRepository,
4857
TemplateFactory $templateFactory,
@@ -55,6 +64,11 @@ public function __construct(
5564
$this->messages = $messages;
5665
}
5766

67+
68+
/**
69+
* @param \Zend\Diactoros\ServerRequest $request
70+
* @return \Zend\Diactoros\Response\RedirectResponse|\SimpleSAML\XHTML\Template
71+
*/
5872
public function __invoke(ServerRequest $request)
5973
{
6074
$form = $this->formFactory->build(ClientForm::class);

‎lib/Controller/ClientDeleteController.php

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,21 @@ class ClientDeleteController
2828
use GetClientFromRequestTrait;
2929

3030
/**
31-
* @var TemplateFactory
31+
* @var \SimpleSAML\Modules\OpenIDConnect\Factories\TemplateFactory
3232
*/
3333
private $templateFactory;
34+
3435
/**
35-
* @var SessionMessagesService
36+
* @var \SimpleSAML\Modules\OpenIDConnect\Services\SessionMessagesService
3637
*/
3738
private $messages;
3839

40+
41+
/**
42+
* @param \SimpleSAML\Modules\OpenIDConnect\Repositories\ClientRepository $clientRepository
43+
* @param \SimpleSAML\Modules\OpenIDConnect\Factories\TemplateFactory $templateFactory
44+
* @param \SimpleSAML\Modules\OpenIDConnect\Services\SessionMessagesService $messages
45+
*/
3946
public function __construct(
4047
ClientRepository $clientRepository,
4148
TemplateFactory $templateFactory,
@@ -46,6 +53,11 @@ public function __construct(
4653
$this->messages = $messages;
4754
}
4855

56+
57+
/**
58+
* @param \Zend\Diactoros\ServerRequest $request
59+
* @return \Zend\Diactoros\Response\RedirectResponse|\SimpleSAML\XHTML\Template
60+
*/
4961
public function __invoke(ServerRequest $request)
5062
{
5163
$client = $this->getClientFromRequest($request);

‎lib/Controller/ClientEditController.php

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,16 +32,26 @@ class ClientEditController
3232
/**
3333
* @var TemplateFactory
3434
*/
35+
3536
private $templateFactory;
3637
/**
3738
* @var FormFactory
3839
*/
3940
private $formFactory;
41+
4042
/**
4143
* @var SessionMessagesService
4244
*/
4345
private $messages;
4446

47+
48+
49+
/**
50+
* @param \SimpleSAML\Modules\OpenIDConnect\Repositories\ClientRepository $clientRepository
51+
* @param \SimpleSAML\Modules\OpenIDConnect\Factories\TemplateFactory $templateFactory
52+
* @param \SimpleSAML\Modules\OpenIDConnect\Factories\FormFactory $formFactory
53+
* @param \SimpleSAML\Modules\OpenIDConnect\Services\SessionMessagesService $messages
54+
*/
4555
public function __construct(
4656
ClientRepository $clientRepository,
4757
TemplateFactory $templateFactory,
@@ -54,6 +64,11 @@ public function __construct(
5464
$this->messages = $messages;
5565
}
5666

67+
68+
/**
69+
* @param \Zend\Diactoros\ServerRequest $request
70+
* @return \Zend\Diactoros\Response\RedirectResponse|\SimpleSAML\XHTML\Template
71+
*/
5772
public function __invoke(ServerRequest $request)
5873
{
5974
$client = $this->getClientFromRequest($request);

‎lib/Controller/ClientIndexController.php

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,17 +24,28 @@ class ClientIndexController
2424
* @var ClientRepository
2525
*/
2626
private $clientRepository;
27+
2728
/**
2829
* @var TemplateFactory
2930
*/
3031
private $templateFactory;
3132

33+
34+
/**
35+
* @param \SimpleSAML\Modules\OpenIDConnect\Repositories\ClientRepository $clientRepository
36+
* @param \SimpleSAML\Modules\OpenIDConnect\Factories\TemplateFactory $templateFactory
37+
*/
3238
public function __construct(ClientRepository $clientRepository, TemplateFactory $templateFactory)
3339
{
3440
$this->clientRepository = $clientRepository;
3541
$this->templateFactory = $templateFactory;
3642
}
3743

44+
45+
/**
46+
* @param \Zend\Diactoros\ServerRequest $request
47+
* @return \SimpleSAML\XHTML\Template
48+
*/
3849
public function __invoke(ServerRequest $request)
3950
{
4051
$clients = $this->clientRepository->findAll();

‎lib/Controller/ClientResetSecretController.php

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,22 @@ class ClientResetSecretController
3232
*/
3333
private $messages;
3434

35+
36+
/**
37+
* @param \SimpleSAML\Modules\OpenIDConnect\Repositories\ClientRepository $clientRepository
38+
* @param \SimpleSAML\Modules\OpenIDConnect\Services\SessionMessagesService $messages
39+
*/
3540
public function __construct(ClientRepository $clientRepository, SessionMessagesService $messages)
3641
{
3742
$this->clientRepository = $clientRepository;
3843
$this->messages = $messages;
3944
}
4045

46+
47+
/**
48+
* @param \Zend\Diactoros\ServerRequest $request
49+
* @return \Zend\Diactoros\Response\RedirectResponse
50+
*/
4151
public function __invoke(ServerRequest $request)
4252
{
4353
$client = $this->getClientFromRequest($request);

‎lib/Controller/ClientShowController.php

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,22 @@ class ClientShowController
2828
*/
2929
private $templateFactory;
3030

31+
32+
/**
33+
* @param \SimpleSAML\Modules\OpenIDConnect\Repositories\ClientRepository $clientRepository
34+
* @param \SimpleSAML\Modules\OpenIDConnect\Factories\TemplateFactory $templateFactory
35+
*/
3136
public function __construct(ClientRepository $clientRepository, TemplateFactory $templateFactory)
3237
{
3338
$this->clientRepository = $clientRepository;
3439
$this->templateFactory = $templateFactory;
3540
}
3641

42+
43+
/**
44+
* @param \Zend\Diactoros\ServerRequest $request
45+
* @return \SimpleSAML\XHTML\Template
46+
*/
3747
public function __invoke(ServerRequest $request)
3848
{
3949
$client = $this->getClientFromRequest($request);

‎lib/Controller/OAuth2AccessTokenController.php

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,20 @@ class OAuth2AccessTokenController
2525
*/
2626
private $authorizationServer;
2727

28+
29+
/**
30+
* @param \League\OAuth2\Server\AuthorizationServer $authorizationServer
31+
*/
2832
public function __construct(AuthorizationServer $authorizationServer)
2933
{
3034
$this->authorizationServer = $authorizationServer;
3135
}
3236

37+
38+
/**
39+
* @param \Zend\Diactoros\ServerRequest $request
40+
* @return \Psr\Http\Message\ResponseInterface
41+
*/
3342
public function __invoke(ServerRequest $request)
3443
{
3544
return $this->authorizationServer->respondToAccessTokenRequest($request, new Response());

‎lib/Controller/OAuth2AuthorizationController.php

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,18 @@ class OAuth2AuthorizationController
2929
* @var AuthenticationService
3030
*/
3131
private $authenticationService;
32+
3233
/**
3334
* @var AuthorizationServer
3435
*/
3536
private $authorizationServer;
3637

38+
39+
/**
40+
* @param \SimpleSAML\Modules\OpenIDConnect\Repositories\ClientRepository $clientRespository
41+
* @param \SimpleSAML\Modules\OpenIDConnect\Services\AuthenticationService $authenticationService
42+
* @param \League\OAuth2\Server\AuthorizationServer $authorizationServer
43+
*/
3744
public function __construct(
3845
ClientRepository $clientRepository,
3946
AuthenticationService $authenticationService,
@@ -44,6 +51,11 @@ public function __construct(
4451
$this->authorizationServer = $authorizationServer;
4552
}
4653

54+
55+
/**
56+
* @param \Zend\Diactoros\ServerRequest $request
57+
* @return \Psr\Http\Message\ResponseInterface
58+
*/
4759
public function __invoke(ServerRequest $request)
4860
{
4961
$authSource = $this->getClientFromRequest($request)->getAuthSource();

0 commit comments

Comments
 (0)