English
资源说明：A Zend Framework 2 module to provide quick & easy security.
# SpiffySecurity Module for Zend Framework 2
SpiffySecurity is an ACL module for Zend Framework 2 geared towards quick & easy setup. Getting ACL
working should take you less than 5 minutes.
## Requirements
- PHP 5.3 or higher
- [Zend Framework 2](http://www.github.com/zendframework/zf2)
## Installation
Installation of SpiffySecurity uses composer. For composer documentation, please refer to
[getcomposer.org](http://getcomposer.org/).
#### Installation steps
1. `cd my/project/directory`
2. create a `composer.json` file with following contents:
```json
{
"require": {
"spiffy/spiffy-security": "dev-master"
}
}
```
3. install composer via `curl -s http://getcomposer.org/installer | php` (on windows, download
http://getcomposer.org/installer and execute it with PHP)
4. run `php composer.phar install`
5. open `my/project/directory/configs/application.config.php` and add the following key to your `modules`:
```php
'SpiffySecurity',
```
## Providers
To configure your roles SpiffySecurity uses what's called "providers." Providers offer a generic way
to assign your roles. Shipped providers include:
- Doctrine DBAL: Uses Doctrine DBAL. Can be used out of the box with DoctrineORMModule.
- PDO: Uses PHP PDO connection.
- InMemory: Primarily used for testing. Allows you to setup roles directly in configuration.
See the module.config.php file for sample setups.
## Firewalls
Firewalls protect your resources by allowing access only to the roles you specify. By default, two
firewall types are provided:
- Route: Protects your routes.
- Controller: Protects controllers.
By default, only controller access is enabled. See the module.config.php file for sample setups.
## Setting the identity provider
The identity provider is a service alias setup to provide a working identity to SpiffySecurity. The default alias is
my_identity_provider but can be changed via the `identity_provider` key in configuration. The object returned by
the identity provider must implement `SpiffySecurity\Identity\IdentityInterface`.
## View helper and controller plugin
An `isGranted($roles)` view helper and controller plugin is available. To use, simply pass an array (or string) of
roles to check for access. If any of the roles passed have access then `isGranted($roles)` returns true.
## Sample configuration
```php
array(
'firewall' => array(
'controller' => array(
array('controller' => 'profile', 'action' => 'view', 'roles' => 'guest')
),
'route' => array(
array('route' => 'profiles/add', 'roles' => 'member'),
array('route' => 'admin/*', 'roles' => 'administrator')
),
),
'provider' => array(
'in_memory' => array(
'test_role' => 'test_parent',
),
'doctrine_dbal' => array(
'connection' => 'doctrine.connection.orm_default',
'table' => 'role',
'role_id_column' => 'id',
'role_name_column' => 'name',
'parent_join_column' => 'parent_role_id'
)
)
),
);
```
## Protecting your services
Protecting your services is as easy as injecting the SpiffySecurity service into your services. You can then use
the provided `isGranted($role)` method to check if access is allowed.
For example,
```php
security = $security;
}
public function createPost()
{
if (!$this->security->isGranted('ROLE_NEWS_MANAGER')) {
// code
}
// code
}
}
```
## Protecting your objects
Coming soon, maybe...
本源码包内暂不包含可直接显示的源代码文件，请下载源码包。
