Integrating the "rightsservice" with Splash

This package is part of the Mouf PHP framework and contains the @RequiresRight annotation that integrates the Splash MVC framework with the RightsService.

This package provides one useful filter:

The @RequiresRight annotation

This filter can be used in any action. If you put this annotation, the user will be denied access if he does not possess the specified right.

/**
 * A sample default action that requires to have the "ACCESS_ADMIN_RIGHT" right.
 *
 * @URL /admin
 * @RequiresRight(name="ACCESS_ADMIN_RIGHT")
 */
public function index() { ... }

The @RequiresRight annotation requires an instance of RightsService to exist. The name of the instance must be "rightsService". If your RightsService instance is not named "rightsService" (or if you want to use several RightsService instances, you can specify the instance of UserService to use in parameter of the annotation:

/**
 * A sample default action that requires to have the "ACCESS_ADMIN_RIGHT" right.
 *
 * @URL /admin
 * @RequiresRight(name="ACCESS_ADMIN_RIGHT",instance="myRightService")
 */
public function index() { ... }

Found a typo? Something is wrong in this documentation? Just fork and edit it!