Skip to content

Commit 3c8f4bb

Browse files
committed
small fixes
1 parent 1a3b8af commit 3c8f4bb

7 files changed

Lines changed: 44 additions & 28 deletions

File tree

BeSimpleSsoAuthBundle.php

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,14 @@
66
use Symfony\Component\DependencyInjection\ContainerBuilder;
77
use BeSimple\SsoAuthBundle\DependencyInjection\Compiler\FactoryPass;
88

9+
/**
10+
* @author: Jean-François Simon <contact@jfsimon.fr>
11+
*/
912
class BeSimpleSsoAuthBundle extends Bundle
1013
{
14+
/**
15+
* {@inheritdoc}
16+
*/
1117
public function build(ContainerBuilder $container)
1218
{
1319
parent::build($container);

Exception/ConfigNotFoundException.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@ class ConfigNotFoundException extends NotFoundException
99
{
1010
public function __construct($id, $code = null, $previous = null)
1111
{
12-
parent::__construct('Config', $id, $code, $previous);
12+
parent::__construct($id, 'Config', $code, $previous);
1313
}
1414
}

Exception/ProtocolNotFoundException.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@ class ProtocolNotFoundException extends NotFoundException
99
{
1010
public function __construct($id, $code = null, $previous = null)
1111
{
12-
parent::__construct('Protocol', $id, $code, $previous);
12+
parent::__construct($id, 'Protocol', $code, $previous);
1313
}
1414
}

Exception/ServerNotFoundException.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@ class ServerNotFoundException extends NotFoundException
99
{
1010
public function __construct($id, $code = null, $previous = null)
1111
{
12-
parent::__construct('Server', $id, $code, $previous);
12+
parent::__construct($id, 'Server', $code, $previous);
1313
}
1414
}

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,17 @@ SSO authentication for Symfony2
22
===============================
33

44

5-
*Tests OK!*
5+
This bundle helps you to bring SSO authentication to yous Symfony2 project.
66

77

8-
- Only CAS protocol is implemented for now.
9-
- Documentation in Resources/doc
10-
- License in Resources/meta/LICENSE
8+
It works in two ways:
9+
10+
- **trusted**: authentication is done against a known server (like with CAS)
11+
- **open**: authentication is done with server of user's choice (like with OpenId)
12+
13+
14+
Only CAS protocol is implemented for now, many other are planned.
15+
16+
17+
- [Read documentation](https://github.com/BeSimple/BeSimpleSsoAuthBundle/blob/master/Resources/doc/index.md)
18+
- [See the license](https://github.com/BeSimple/BeSimpleSsoAuthBundle/blob/master/Resources/meta/LICENSE)

Resources/doc/index.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,24 @@
1-
BeSimpleSsoAuthBundle documentation
2-
===================================
1+
BeSimpleSsoAuthBundle documentation summary
2+
===========================================
33

44

5-
This bundle helps you to bring SSO authentication to yous Symfony2 project.
5+
The basics
6+
----------
67

7-
It works in two ways:
8-
9-
- **trusted**: authentication is done against a known server (like with CAS)
10-
- **open**: authentication is done with server of user's choice (like with OpenId)
11-
12-
13-
Documentation summary
14-
---------------------
8+
- [Installation & setup](install.md)
9+
- [Configure trusted SSO](trusted.md)
10+
- Configure open SSO (*to come*)
1511

1612

17-
The basics:
13+
Advanced use
14+
------------
1815

19-
- [Installation & setup](install.md)
20-
- [Configure trusted SSO](trusted.md) *CAS only for now*
16+
- Customize SSO server (*to come*)
17+
- Add a protocol (*to come*)
18+
- Manage users (*to come*)
2119

2220

23-
Reminder:
21+
Some notes
22+
----------
2423

2524
- [Some SSO protocols](protocols.md)

Resources/doc/trusted.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,24 +33,27 @@ Other optional configuration entries are:
3333
**An example in YAML format:**
3434

3535
# security.yml
36+
3637
security:
37-
# ...
3838
firewalls:
3939
my_firewall:
4040
pattern: ^/secured-area/.*$
4141
trusted_sso:
4242
manager: my_manager
4343
login_action: BeSimpleSsoAuthBundle:TrustedSso:login
4444
logout_action: BeSimpleSsoAuthBundle:TrustedSso:logout
45-
# ...
46-
#...
4745

4846

49-
Server configuration
50-
--------------------
47+
Manager configuration
48+
---------------------
49+
50+
51+
Now you must configure your `my_manager` manager.
5152

5253

53-
An example:
54+
**An example in YAML format:**
55+
56+
# config.yml
5457

5558
be_simple_sso_auth:
5659
my_manager:

0 commit comments

Comments
 (0)