Skip to content

Commit

Permalink
Remove trailing whitespace from comments
Browse files Browse the repository at this point in the history
  • Loading branch information
ataylor32 committed Oct 16, 2012
1 parent 2a803ea commit 4090c2e
Show file tree
Hide file tree
Showing 35 changed files with 91 additions and 91 deletions.
36 changes: 18 additions & 18 deletions app/Config/acl.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,18 @@
/**
* Example
* -------
*
*
* Assumptions:
*
* 1. In your application you created a User model with the following properties:
* 1. In your application you created a User model with the following properties:
* username, group_id, password, email, firstname, lastname and so on.
* 2. You configured AuthComponent to authorize actions via
* $this->Auth->authorize = array('Actions' => array('actionPath' => 'controllers/'),...)
*
* 2. You configured AuthComponent to authorize actions via
* $this->Auth->authorize = array('Actions' => array('actionPath' => 'controllers/'),...)
*
* Now, when a user (i.e. jeff) authenticates successfully and requests a controller action (i.e. /invoices/delete)
* that is not allowed by default (e.g. via $this->Auth->allow('edit') in the Invoices controller) then AuthComponent
* will ask the configured ACL interface if access is granted. Under the assumptions 1. and 2. this will be
* done via a call to Acl->check() with
* that is not allowed by default (e.g. via $this->Auth->allow('edit') in the Invoices controller) then AuthComponent
* will ask the configured ACL interface if access is granted. Under the assumptions 1. and 2. this will be
* done via a call to Acl->check() with
*
* array('User' => array('username' => 'jeff', 'group_id' => 4, ...))
*
Expand All @@ -42,33 +42,33 @@
* '/controllers/invoices/delete'
*
* as ACO.
*
*
* If the configured map looks like
*
* $config['map'] = array(
* 'User' => 'User/username',
* 'Role' => 'User/group_id',
* );
*
* then PhpAcl will lookup if we defined a role like User/jeff. If that role is not found, PhpAcl will try to
* find a definition for Role/4. If the definition isn't found then a default role (Role/default) will be used to
* then PhpAcl will lookup if we defined a role like User/jeff. If that role is not found, PhpAcl will try to
* find a definition for Role/4. If the definition isn't found then a default role (Role/default) will be used to
* check rules for the given ACO. The search can be expanded by defining aliases in the alias configuration.
* E.g. if you want to use a more readable name than Role/4 in your definitions you can define an alias like
*
* $config['alias'] = array(
* 'Role/4' => 'Role/editor',
* );
*
*
* In the roles configuration you can define roles on the lhs and inherited roles on the rhs:
*
*
* $config['roles'] = array(
* 'Role/admin' => null,
* 'Role/accountant' => null,
* 'Role/editor' => null,
* 'Role/manager' => 'Role/editor, Role/accountant',
* 'User/jeff' => 'Role/manager',
* );
*
*
* In this example manager inherits all rules from editor and accountant. Role/admin doesn't inherit from any role.
* Lets define some rules:
*
Expand All @@ -87,10 +87,10 @@
* ),
* );
*
* Ok, so as jeff inherits from Role/manager he's matched every rule that references User/jeff, Role/manager,
* Role/editor, Role/accountant and Role/default. However, for jeff, rules for User/jeff are more specific than
* Ok, so as jeff inherits from Role/manager he's matched every rule that references User/jeff, Role/manager,
* Role/editor, Role/accountant and Role/default. However, for jeff, rules for User/jeff are more specific than
* rules for Role/manager, rules for Role/manager are more specific than rules for Role/editor and so on.
* This is important when allow and deny rules match for a role. E.g. Role/accountant is allowed
* This is important when allow and deny rules match for a role. E.g. Role/accountant is allowed
* controllers/invoices/* but at the same time controllers/invoices/delete is denied. But there is a more
* specific rule defined for Role/manager which is allowed controllers/invoices/delete. However, the most specific
* rule denies access to the delete action explicitly for User/jeff, so he'll be denied access to the resource.
Expand All @@ -101,7 +101,7 @@

/**
* The role map defines how to resolve the user record from your application
* to the roles you defined in the roles configuration.
* to the roles you defined in the roles configuration.
*/
$config['map'] = array(
'User' => 'User/username',
Expand Down
2 changes: 1 addition & 1 deletion app/Config/bootstrap.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
/**
* This file is loaded automatically by the app/webroot/index.php file after core.php
*
* This file should load/create any application wide configuration settings, such as
* This file should load/create any application wide configuration settings, such as
* Caching, Logging, loading additional configuration files.
*
* You should also use this file to include any files that provide global functions/constants
Expand Down
4 changes: 2 additions & 2 deletions app/Config/core.php
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@
Configure::write('Acl.database', 'default');

/**
* Uncomment this line and correct your server timezone to fix
* Uncomment this line and correct your server timezone to fix
* any date & time related errors.
*/
//date_default_timezone_set('UTC');
Expand All @@ -236,7 +236,7 @@
* If running via cli - apc is disabled by default. ensure it's available and enabled in this case
*
* Note: 'default' and other application caches should be configured in app/Config/bootstrap.php.
* Please check the comments in boostrap.php for more info on the cache engines available
* Please check the comments in boostrap.php for more info on the cache engines available
* and their setttings.
*/
$engine = 'File';
Expand Down
2 changes: 1 addition & 1 deletion app/Config/routes.php
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
Router::connect('/pages/*', array('controller' => 'pages', 'action' => 'display'));

/**
* Load all plugin routes. See the CakePlugin documentation on
* Load all plugin routes. See the CakePlugin documentation on
* how to customize the loading of plugin routes.
*/
CakePlugin::routes();
Expand Down
2 changes: 1 addition & 1 deletion lib/Cake/Cache/CacheEngine.php
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ public function init($settings = array()) {
* Garbage collection
*
* Permanently remove all expired and deleted data
*
*
* @param integer $expires [optional] An expires timestamp, invalidataing all data before.
* @return void
*/
Expand Down
2 changes: 1 addition & 1 deletion lib/Cake/Cache/Engine/FileEngine.php
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ public function init($settings = array()) {

/**
* Garbage collection. Permanently remove all expired and deleted data
*
*
* @param integer $expires [optional] An expires timestamp, invalidataing all data before.
* @return boolean True if garbage collection was successful, false on failure
*/
Expand Down
2 changes: 1 addition & 1 deletion lib/Cake/Console/Command/Task/TemplateTask.php
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ public function initialize() {
*
* Bake themes are directories not named `skel` inside a `Console/Templates` path.
* They are listed in this order: app -> plugin -> default
*
*
* @return array Array of bake themes that are installed.
*/
protected function _findThemes() {
Expand Down
4 changes: 2 additions & 2 deletions lib/Cake/Console/Command/TestShell.php
Original file line number Diff line number Diff line change
Expand Up @@ -335,8 +335,8 @@ public function available() {
* Find the test case for the passed file. The file could itself be a test.
*
* @param string $file
* @param string $category
* @param boolean $throwOnMissingFile
* @param string $category
* @param boolean $throwOnMissingFile
* @access protected
* @return array(type, case)
* @throws Exception
Expand Down
2 changes: 1 addition & 1 deletion lib/Cake/Console/Templates/skel/Config/core.php
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@
Configure::write('Acl.database', 'default');

/**
* Uncomment this line and correct your server timezone to fix
* Uncomment this line and correct your server timezone to fix
* any date & time related errors.
*/
//date_default_timezone_set('UTC');
Expand Down
2 changes: 1 addition & 1 deletion lib/Cake/Controller/Component.php
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ public function startup(Controller $controller) {
}

/**
* Called before the Controller::beforeRender(), and before
* Called before the Controller::beforeRender(), and before
* the view class is loaded, and before Controller::render()
*
* @param Controller $controller Controller with components to beforeRender
Expand Down
2 changes: 1 addition & 1 deletion lib/Cake/Controller/Component/Acl/IniAcl.php
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ public function check($aro, $aco, $action = null) {
}

/**
* Parses an INI file and returns an array that reflects the
* Parses an INI file and returns an array that reflects the
* INI file's section structure. Double-quote friendly.
*
* @param string $filename File
Expand Down
34 changes: 17 additions & 17 deletions lib/Cake/Controller/Component/Acl/PhpAcl.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
*/

/**
* PhpAcl implements an access control system using a plain PHP configuration file.
* PhpAcl implements an access control system using a plain PHP configuration file.
* An example file can be found in app/Config/acl.php
*
* @package Cake.Controller.Component.Acl
Expand Down Expand Up @@ -46,7 +46,7 @@ class PhpAcl extends Object implements AclInterface {

/**
* Aco Object
*
*
* @var PhpAco
*/
public $Aco = null;
Expand All @@ -65,8 +65,8 @@ public function __construct() {

/**
* Initialize method
*
* @param AclComponent $Component Component instance
*
* @param AclComponent $Component Component instance
* @return void
*/
public function initialize(Component $Component) {
Expand Down Expand Up @@ -199,7 +199,7 @@ class PhpAco {

/**
* map modifiers for ACO paths to their respective PCRE pattern
*
*
* @var array
*/
public static $modifiers = array(
Expand Down Expand Up @@ -263,7 +263,7 @@ public function path($aco) {
/**
* allow/deny ARO access to ARO
*
* @return void
* @return void
*/
public function access($aro, $aco, $action, $type = 'deny') {
$aco = $this->resolve($aco);
Expand Down Expand Up @@ -315,7 +315,7 @@ public function resolve($aco) {
*
* @param array $allow ACO allow rules
* @param array $deny ACO deny rules
* @return void
* @return void
*/
public function build(array $allow, array $deny = array()) {
$this->_tree = array();
Expand Down Expand Up @@ -347,7 +347,7 @@ public function build(array $allow, array $deny = array()) {
class PhpAro {

/**
* role to resolve to when a provided ARO is not listed in
* role to resolve to when a provided ARO is not listed in
* the internal tree
*
* @var string
Expand All @@ -357,12 +357,12 @@ class PhpAro {
/**
* map external identifiers. E.g. if
*
* array('User' => array('username' => 'jeff', 'role' => 'editor'))
* array('User' => array('username' => 'jeff', 'role' => 'editor'))
*
* is passed as an ARO to one of the methods of AclComponent, PhpAcl
* is passed as an ARO to one of the methods of AclComponent, PhpAcl
* will check if it can be resolved to an User or a Role defined in the
* configuration file.
*
* configuration file.
*
* @var array
* @see app/Config/acl.php
*/
Expand All @@ -373,7 +373,7 @@ class PhpAro {

/**
* aliases to map
*
*
* @var array
*/
public $aliases = array();
Expand All @@ -398,9 +398,9 @@ public function __construct(array $aro = array(), array $map = array(), array $a
* From the perspective of the given ARO, walk down the tree and
* collect all inherited AROs levelwise such that AROs from different
* branches with equal distance to the requested ARO will be collected at the same
* index. The resulting array will contain a prioritized list of (list of) roles ordered from
* index. The resulting array will contain a prioritized list of (list of) roles ordered from
* the most distant AROs to the requested one itself.
*
*
* @param string|array $aro An ARO identifier
* @return array prioritized AROs
*/
Expand All @@ -425,7 +425,7 @@ public function roles($aro) {

/**
* resolve an ARO identifier to an internal ARO string using
* the internal mapping information.
* the internal mapping information.
*
* @param string|array $aro ARO identifier (User.jeff, array('User' => ...), etc)
* @return string internal aro string (e.g. User/jeff, Role/default)
Expand Down Expand Up @@ -527,7 +527,7 @@ public function addAlias(array $alias) {
* build an ARO tree structure for internal processing
*
* @param array $aros array of AROs as key and their inherited AROs as values
* @return void
* @return void
*/
public function build(array $aros) {
$this->_tree = array();
Expand Down
2 changes: 1 addition & 1 deletion lib/Cake/Controller/Component/Auth/DigestAuthenticate.php
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ class DigestAuthenticate extends BaseAuthenticate {
* - `realm` The realm authentication is for, Defaults to the servername.
* - `nonce` A nonce used for authentication. Defaults to `uniqid()`.
* - `qop` Defaults to auth, no other values are supported at this time.
* - `opaque` A string that must be returned unchanged by clients.
* - `opaque` A string that must be returned unchanged by clients.
* Defaults to `md5($settings['realm'])`
*
* @var array
Expand Down
2 changes: 1 addition & 1 deletion lib/Cake/Controller/Component/CookieComponent.php
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ class CookieComponent extends Component {

/**
* A reference to the Controller's CakeResponse object
*
*
* @var CakeResponse
*/
protected $_response = null;
Expand Down
2 changes: 1 addition & 1 deletion lib/Cake/Controller/Component/SecurityComponent.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
App::uses('Security', 'Utility');

/**
* The Security Component creates an easy way to integrate tighter security in
* The Security Component creates an easy way to integrate tighter security in
* your application. It provides methods for various tasks like:
*
* - Restricting which HTTP methods your application accepts.
Expand Down
4 changes: 2 additions & 2 deletions lib/Cake/Controller/Component/SessionComponent.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
App::uses('CakeSession', 'Model/Datasource');

/**
* The CakePHP SessionComponent provides a way to persist client data between
* page requests. It acts as a wrapper for the `$_SESSION` as well as providing
* The CakePHP SessionComponent provides a way to persist client data between
* page requests. It acts as a wrapper for the `$_SESSION` as well as providing
* convenience methods for several `$_SESSION` related functions.
*
* @package Cake.Controller.Component
Expand Down
2 changes: 1 addition & 1 deletion lib/Cake/Core/CakePlugin.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
*/

/**
* CakePlugin is responsible for loading and unloading plugins. It also can
* CakePlugin is responsible for loading and unloading plugins. It also can
* retrieve plugin paths and load their bootstrap and routes files.
*
* @package Cake.Core
Expand Down
2 changes: 1 addition & 1 deletion lib/Cake/Event/CakeEvent.php
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ class CakeEvent {

/**
* Name of the event
*
*
* @var string $name
*/
protected $_name = null;
Expand Down
6 changes: 3 additions & 3 deletions lib/Cake/Event/CakeEventManager.php
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ class CakeEventManager {
protected $_listeners = array();

/**
* Internal flag to distinguish a common manager from the sigleton
* Internal flag to distinguish a common manager from the sigleton
*
* @var boolean
*/
Expand All @@ -64,7 +64,7 @@ class CakeEventManager {
*
* If called with a first params, it will be set as the globally available instance
*
* @param CakeEventManager $manager
* @param CakeEventManager $manager
* @return CakeEventManager the global event manager
*/
public static function instance($manager = null) {
Expand All @@ -80,7 +80,7 @@ public static function instance($manager = null) {
}

/**
* Adds a new listener to an event. Listeners
* Adds a new listener to an event. Listeners
*
* @param callback|CakeEventListener $callable PHP valid callback type or instance of CakeEventListener to be called
* when the event named with $eventKey is triggered. If a CakeEventListener instances is passed, then the `implementedEvents`
Expand Down
Loading

0 comments on commit 4090c2e

Please sign in to comment.