Remove trailing whitespace from comments

See http://groups.google.com/d/topic/cakephp-core/fuHTYMKVJno/discussion
This commit is contained in:
Adam Taylor 2012-10-15 18:19:22 -06:00
parent 2a803ea412
commit 4090c2e932
35 changed files with 91 additions and 91 deletions

View file

@ -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, ...))
*
@ -42,7 +42,7 @@
* '/controllers/invoices/delete'
*
* as ACO.
*
*
* If the configured map looks like
*
* $config['map'] = array(
@ -50,17 +50,17 @@
* '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,
@ -68,7 +68,7 @@
* '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:
*
@ -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.
@ -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',

View file

@ -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

View file

@ -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');
@ -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';

View file

@ -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();

View file

@ -65,7 +65,7 @@ abstract class CacheEngine {
* Garbage collection
*
* Permanently remove all expired and deleted data
*
*
* @param integer $expires [optional] An expires timestamp, invalidataing all data before.
* @return void
*/

View file

@ -93,7 +93,7 @@ class FileEngine extends CacheEngine {
/**
* 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
*/

View file

@ -56,7 +56,7 @@ class TemplateTask extends AppShell {
*
* 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() {

View file

@ -335,8 +335,8 @@ class TestShell extends Shell {
* 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

View file

@ -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');

View file

@ -120,7 +120,7 @@ class Component extends Object {
}
/**
* 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

View file

@ -143,7 +143,7 @@ class IniAcl extends Object implements AclInterface {
}
/**
* 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

View file

@ -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
@ -46,7 +46,7 @@ class PhpAcl extends Object implements AclInterface {
/**
* Aco Object
*
*
* @var PhpAco
*/
public $Aco = null;
@ -65,8 +65,8 @@ class PhpAcl extends Object implements AclInterface {
/**
* Initialize method
*
* @param AclComponent $Component Component instance
*
* @param AclComponent $Component Component instance
* @return void
*/
public function initialize(Component $Component) {
@ -199,7 +199,7 @@ class PhpAco {
/**
* map modifiers for ACO paths to their respective PCRE pattern
*
*
* @var array
*/
public static $modifiers = array(
@ -263,7 +263,7 @@ class PhpAco {
/**
* allow/deny ARO access to ARO
*
* @return void
* @return void
*/
public function access($aro, $aco, $action, $type = 'deny') {
$aco = $this->resolve($aco);
@ -315,7 +315,7 @@ class PhpAco {
*
* @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();
@ -347,7 +347,7 @@ class PhpAco {
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
@ -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
*/
@ -373,7 +373,7 @@ class PhpAro {
/**
* aliases to map
*
*
* @var array
*/
public $aliases = array();
@ -398,9 +398,9 @@ class PhpAro {
* 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
*/
@ -425,7 +425,7 @@ class PhpAro {
/**
* 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)
@ -527,7 +527,7 @@ class PhpAro {
* 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();

View file

@ -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

View file

@ -155,7 +155,7 @@ class CookieComponent extends Component {
/**
* A reference to the Controller's CakeResponse object
*
*
* @var CakeResponse
*/
protected $_response = null;

View file

@ -23,7 +23,7 @@ App::uses('Hash', 'Utility');
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.

View file

@ -21,8 +21,8 @@ App::uses('Component', 'Controller');
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

View file

@ -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

View file

@ -27,7 +27,7 @@ class CakeEvent {
/**
* Name of the event
*
*
* @var string $name
*/
protected $_name = null;

View file

@ -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
*/
@ -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) {
@ -80,7 +80,7 @@ class CakeEventManager {
}
/**
* 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`

View file

@ -20,8 +20,8 @@
*/
/**
* Behavior to allow for dynamic and atomic manipulation of a Model's associations
* used for a find call. Most useful for limiting the amount of associations and
* Behavior to allow for dynamic and atomic manipulation of a Model's associations
* used for a find call. Most useful for limiting the amount of associations and
* data returned.
*
* @package Cake.Model.Behavior

View file

@ -24,7 +24,7 @@ App::uses('DataSource', 'Model/Datasource');
/**
* Manages loaded instances of DataSource objects
*
* Provides an interface for loading and enumerating connections defined in
* Provides an interface for loading and enumerating connections defined in
* app/Config/database.php
*
* @package Cake.Model

View file

@ -420,7 +420,7 @@ class DataSource extends Object {
/**
* Closes a connection. Override in subclasses
*
*
* @return boolean
* @access public
*/

View file

@ -637,7 +637,7 @@ class Sqlserver extends DboSource {
/**
* Generate a database-native column schema string
*
* @param array $column An array structured like the
* @param array $column An array structured like the
* following: array('name'=>'value', 'type'=>'value'[, options]),
* where options can be 'default', 'length', or 'key'.
* @return string

View file

@ -1035,7 +1035,7 @@ class CakeEmail {
/**
* Send an email using the specified content, template and layout
*
*
* @param string|array $content String with message or array with messages
* @return array
* @throws SocketException
@ -1337,7 +1337,7 @@ class CakeEmail {
/**
* Attach non-embedded files by adding file contents inside boundaries.
*
* @param string $boundary Boundary to use. If null, will default to $this->_boundary
* @param string $boundary Boundary to use. If null, will default to $this->_boundary
* @return array An array of lines to add to the message
*/
protected function _attachFiles($boundary = null) {
@ -1380,7 +1380,7 @@ class CakeEmail {
/**
* Attach inline/embedded files to the message.
*
* @param string $boundary Boundary to use. If null, will default to $this->_boundary
* @param string $boundary Boundary to use. If null, will default to $this->_boundary
* @return array An array of lines to add to the message
*/
protected function _attachInlineFiles($boundary = null) {

View file

@ -102,7 +102,7 @@ class FileEngineTest extends CakeTestCase {
/**
* Test read/write on the same cache key. Ensures file handles are re-wound.
*
*
* @return void
*/
public function testConsecutiveReadWrite() {

View file

@ -64,7 +64,7 @@ class TestShellTest extends CakeTestCase {
/**
* testMapCoreFileToCategory
*
*
* @return void
*/
public function testMapCoreFileToCategory() {
@ -84,7 +84,7 @@ class TestShellTest extends CakeTestCase {
* testMapCoreFileToCase
*
* basics.php is a slightly special case - it's the only file in the core with a test that isn't Capitalized
*
*
* @return void
*/
public function testMapCoreFileToCase() {
@ -102,7 +102,7 @@ class TestShellTest extends CakeTestCase {
/**
* testMapAppFileToCategory
*
*
* @return void
*/
public function testMapAppFileToCategory() {
@ -132,7 +132,7 @@ class TestShellTest extends CakeTestCase {
/**
* testMapPluginFileToCategory
*
*
* @return void
*/
public function testMapPluginFileToCategory() {
@ -162,7 +162,7 @@ class TestShellTest extends CakeTestCase {
/**
* testMapCoreTestToCategory
*
*
* @return void
*/
public function testMapCoreTestToCategory() {
@ -182,7 +182,7 @@ class TestShellTest extends CakeTestCase {
* testMapCoreTestToCase
*
* basics.php is a slightly special case - it's the only file in the core with a test that isn't Capitalized
*
*
* @return void
*/
public function testMapCoreTestToCase() {
@ -200,7 +200,7 @@ class TestShellTest extends CakeTestCase {
/**
* testMapAppTestToCategory
*
*
* @return void
*/
public function testMapAppTestToCategory() {
@ -230,7 +230,7 @@ class TestShellTest extends CakeTestCase {
/**
* testMapPluginTestToCategory
*
*
* @return void
*/
public function testMapPluginTestToCategory() {

View file

@ -53,7 +53,7 @@ class CakeEventTestListener {
/**
* Auxiliary function to help in stopPropagation testing
*
* @param CakeEvent $event
* @param CakeEvent $event
* @return void
*/
public function stopListener($event) {

View file

@ -29,7 +29,7 @@ class TestSource extends DataSource {
/**
* _schema
* @var type
* @var type
*/
protected $_schema = array(
'id' => array(

View file

@ -227,7 +227,7 @@ class CakeTestFixtureTest extends CakeTestCase {
}
/**
* test that init() correctly sets the fixture table when the connection
* test that init() correctly sets the fixture table when the connection
* or model have prefixes defined.
*
* @return void

View file

@ -22,7 +22,7 @@ class CakeTestSuiteTest extends CakeTestCase {
/**
* testAddTestDirectory
*
*
* @return void
*/
public function testAddTestDirectory() {
@ -39,7 +39,7 @@ class CakeTestSuiteTest extends CakeTestCase {
/**
* testAddTestDirectoryRecursive
*
*
* @return void
*/
public function testAddTestDirectoryRecursive() {
@ -57,7 +57,7 @@ class CakeTestSuiteTest extends CakeTestCase {
/**
* testAddTestDirectoryRecursiveWithHidden
*
*
* @return void
*/
public function testAddTestDirectoryRecursiveWithHidden() {
@ -81,7 +81,7 @@ class CakeTestSuiteTest extends CakeTestCase {
/**
* testAddTestDirectoryRecursiveWithNonPhp
*
*
* @return void
*/
public function testAddTestDirectoryRecursiveWithNonPhp() {

View file

@ -16,7 +16,7 @@
App::uses('CakeSchema', 'Model');
/**
* CakeTestFixture is responsible for building and destroying tables to be used
* CakeTestFixture is responsible for building and destroying tables to be used
* during testing.
*
* @package Cake.TestSuite.Fixture

View file

@ -546,7 +546,7 @@ class File {
}
/**
* Get the mime type of the file. Uses the finfo extension if
* Get the mime type of the file. Uses the finfo extension if
* its available, otherwise falls back to mime_content_type
*
* @return false|string The mimetype of the file, or false if reading fails.

View file

@ -100,7 +100,7 @@ class SessionHelper extends AppHelper {
* echo $this->Session->flash('flash', array('element' => 'my_custom_element'));
* }}}
*
* If you want to use an element from a plugin for rendering your flash message you can do that using the
* If you want to use an element from a plugin for rendering your flash message you can do that using the
* plugin param:
*
* {{{

View file

@ -25,7 +25,7 @@ App::uses('View', 'View');
*
* `$this->set(array('posts' => $posts, '_serialize' => 'posts'));`
*
* When the view is rendered, the `$posts` view variable will be serialized
* When the view is rendered, the `$posts` view variable will be serialized
* into JSON.
*
* You can also define `'_serialize'` as an array. This will create a top level object containing
@ -35,7 +35,7 @@ App::uses('View', 'View');
* $this->set(compact('posts', 'users', 'stuff'));
* $this->set('_serialize', array('posts', 'users'));
* }}}
*
*
* The above would generate a JSON object that looks like:
*
* `{"posts": [...], "users": [...]}`
@ -49,9 +49,9 @@ App::uses('View', 'View');
class JsonView extends View {
/**
* JSON views are always located in the 'json' sub directory for a
* JSON views are always located in the 'json' sub directory for a
* controllers views.
*
*
* @var string
*/
public $subDir = 'json';
@ -72,8 +72,8 @@ class JsonView extends View {
* Render a JSON view.
*
* Uses the special '_serialize' parameter to convert a set of
* view variables into a JSON response. Makes generating simple
* JSON responses very easy. You can omit the '_serialize' parameter,
* view variables into a JSON response. Makes generating simple
* JSON responses very easy. You can omit the '_serialize' parameter,
* and use a normal view + layout as well.
*
* @param string $view The view being rendered.

View file

@ -73,7 +73,7 @@ class ViewBlock {
}
/**
* Append to an existing or new block. Appending to a new
* Append to an existing or new block. Appending to a new
* block will create the block.
*
* Calling append() without a value will create a new capturing