Skip to content

Commit

Permalink
mask .: by separating . and ::
Browse files Browse the repository at this point in the history
  • Loading branch information
antograssiot committed Nov 28, 2014
1 parent 00389a0 commit f773909
Show file tree
Hide file tree
Showing 66 changed files with 193 additions and 193 deletions.
2 changes: 1 addition & 1 deletion en/appendices/new-features-in-cakephp-2-1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ When those methods are combined with having the :php:class:`RequestHandlerCompon
enabled in your controller, the component will automatically decide if the
response is already cached in the client and will send a `304 Not Modified`
status code before rendering the view. Skipping the view rendering process saves
CPU cycles and memory.::
CPU cycles and memory. ::

class ArticlesController extends AppController {
public $components = array('RequestHandler');
Expand Down
2 changes: 1 addition & 1 deletion en/cakephp-overview/where-to-get-help.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ The Test Cases
If you ever feel the information provided in the API is not
sufficient, check out the code of the test cases provided with
CakePHP. They can serve as practical examples for function and
data member usage for a class.::
data member usage for a class. ::

lib/Cake/Test/Case

Expand Down
10 changes: 5 additions & 5 deletions en/console-and-shells.rst
Original file line number Diff line number Diff line change
Expand Up @@ -414,7 +414,7 @@ configure the OptionParser to match the expected inputs of your shell.
You can also configure subcommand option parsers, which allow you to
have different option parsers for subcommands and tasks.
The ConsoleOptionParser implements a fluent interface and includes
methods for easily setting multiple options/arguments at once.::
methods for easily setting multiple options/arguments at once. ::

public function getOptionParser() {
$parser = parent::getOptionParser();
Expand Down Expand Up @@ -510,7 +510,7 @@ handle that in your shell.
.. php:method:: addArguments(array $args)
If you have an array with multiple arguments you can use ``$parser->addArguments()``
to add multiple arguments at once.::
to add multiple arguments at once. ::

$parser->addArguments(array(
'node' => array('help' => 'The node to create', 'required' => true),
Expand Down Expand Up @@ -547,7 +547,7 @@ Options or flags are also frequently used in command line tools.
``ConsoleOptionParser`` supports creating options
with both verbose and short aliases, supplying defaults
and creating boolean switches. Options are created with either
``$parser->addOption()`` or ``$parser->addOptions()``.::
``$parser->addOption()`` or ``$parser->addOptions()``. ::

$parser->addOption('connection', array(
'short' => 'c',
Expand All @@ -559,7 +559,7 @@ The above would allow you to use either ``cake myshell --connection=other``,
``cake myshell --connection other``, or ``cake myshell -c other``
when invoking the shell. You can also create boolean switches, these switches do not
consume values, and their presence just enables them in the
parsed parameters.::
parsed parameters. ::

$parser->addOption('no-commit', array('boolean' => true));

Expand All @@ -583,7 +583,7 @@ define the behavior of the option:
.. php:method:: addOptions(array $options)
If you have an array with multiple options you can use ``$parser->addOptions()``
to add multiple options at once.::
to add multiple options at once. ::

$parser->addOptions(array(
'node' => array('short' => 'n', 'help' => 'The node to create'),
Expand Down
2 changes: 1 addition & 1 deletion en/console-and-shells/acl-shell.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ switch 'deny' in for 'grant'.
Check permissions
=================

Use this command to check ACL permissions.::
Use this command to check ACL permissions. ::

./Console/cake acl check Group.1 controllers/Posts read

Expand Down
2 changes: 1 addition & 1 deletion en/controllers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ Flow Control
The flow control method you'll use most often is :php:meth:`~Controller::redirect()`.
This method takes its first parameter in the form of a
CakePHP-relative URL. When a user has successfully placed an order,
you might wish to redirect them to a receipt screen.::
you might wish to redirect them to a receipt screen. ::

public function place_order() {
// Logic for finalizing order goes here
Expand Down
6 changes: 3 additions & 3 deletions en/core-libraries/behaviors/containable.rst
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ by Daniel::
There is an important caveat to using Containable when filtering on a deeper association. In the previous example,
assume you had 3 posts in your database and Daniel had commented on 2 of those posts. The operation
$this->Post->find('all', array('contain' => 'Comment.author = "Daniel"')); would return ALL 3 posts, not
just the 2 posts that Daniel had commented on. It won't return all comments however, just comments by Daniel.::
just the 2 posts that Daniel had commented on. It won't return all comments however, just comments by Daniel. ::

[0] => Array
(
Expand Down Expand Up @@ -315,7 +315,7 @@ just the 2 posts that Daniel had commented on. It won't return all comments howe
)

If you want to filter the posts by the comments, so that posts without a comment by Daniel won't be
returned, the easiest way is to find all the comments by Daniel and contain the Posts.::
returned, the easiest way is to find all the comments by Daniel and contain the Posts. ::

$this->Comment->find('all', array(
'conditions' => 'Comment.author = "Daniel"',
Expand Down Expand Up @@ -421,7 +421,7 @@ reattaching the behavior as seen in
ContainableBehavior can sometimes cause issues with other behaviors
or queries that use aggregate functions and/or GROUP BY statements.
If you get invalid SQL errors due to mixing of aggregate and
non-aggregate fields, try disabling the ``autoFields`` setting.::
non-aggregate fields, try disabling the ``autoFields`` setting. ::

$this->Post->Behaviors->load('Containable', array('autoFields' => false));

Expand Down
10 changes: 5 additions & 5 deletions en/core-libraries/behaviors/translate.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ You can either use the CakePHP console or you can manually create
it. It is advised to use the console for this, because it might
happen that the layout changes in future versions of CakePHP.
Sticking to the console will make sure that you have the correct
layout.::
layout. ::

./cake i18n

Expand All @@ -31,7 +31,7 @@ Attaching the Translate Behavior to your Models
===============================================

Add it to your model by using the ``$actsAs`` property like in the
following example.::
following example. ::

class Post extends AppModel {
public $actsAs = array(
Expand Down Expand Up @@ -115,7 +115,7 @@ Retrieve all translation records for a field

If you want to have all translation records attached to the current
model record you simply extend the **field array** in your behavior
setup as shown below. The naming is completely up to you.::
setup as shown below. The naming is completely up to you. ::

class Post extends AppModel {
public $actsAs = array(
Expand Down Expand Up @@ -183,7 +183,7 @@ using the bindTranslation method
``$fields`` is a named-key array of field and association name,
where the key is the translatable field and the value is the fake
association name.::
association name. ::

$this->Post->bindTranslation(array('title' => 'titleTranslation'));
// need at least recursive 1 for this to work.
Expand Down Expand Up @@ -313,7 +313,7 @@ For this to work you need to create the actual model file in your
models folder. Reason is that there is no property to set the
displayField directly in the model using this behavior yet.

Make sure that you change the ``$displayField`` to ``'field'``.::
Make sure that you change the ``$displayField`` to ``'field'``. ::

class PostI18n extends AppModel {
public $displayField = 'field'; // important
Expand Down
4 changes: 2 additions & 2 deletions en/core-libraries/behaviors/tree.rst
Original file line number Diff line number Diff line change
Expand Up @@ -507,7 +507,7 @@ are a few more tree-orientated permutations at your disposal.


Using the id of "International" getPath will return each of the
parents in turn (starting from the top).::
parents in turn (starting from the top). ::

$parents = $this->Category->getPath(15);

Expand Down Expand Up @@ -671,7 +671,7 @@ Advanced Usage
Reorders the nodes (and child nodes) of the tree according to the
field and direction specified in the parameters. This method does
not change the parent of any node.::
not change the parent of any node. ::

$model->reorder(array(
//id of record to use as top node for reordering, default: $Model->id
Expand Down
4 changes: 2 additions & 2 deletions en/core-libraries/caching.rst
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ directory. If you had a cache engine named ``MyCustomCacheEngine``
it would be placed in either ``app/Lib/Cache/Engine/MyCustomCacheEngine.php``
as an app/libs or in ``$plugin/Lib/Cache/Engine/MyCustomCacheEngine.php`` as
part of a plugin. Cache configs from plugins need to use the plugin
dot syntax.::
dot syntax. ::

Cache::config('custom', array(
'engine' => 'CachePack.MyCustomCache',
Expand Down Expand Up @@ -387,7 +387,7 @@ Cache API
``Cache::set()`` to change the settings for a write, you should
also use ``Cache::set()`` before reading the data back in. If you
fail to do so, the default settings will be used when the cache key
is read.::
is read. ::

Cache::set(array('duration' => '+30 days'));
Cache::write('results', $data);
Expand Down
4 changes: 2 additions & 2 deletions en/core-libraries/components/authentication.rst
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ authentication for example uses ``$_SERVER['PHP_AUTH_USER']`` and
request, these values are used to re-identify the user and ensure they are
valid user. As with authentication object's ``authenticate()`` method the
``getUser()`` method should return an array of user information on success or
``false`` on failure.::
``false`` on failure. ::

public function getUser($request) {
$username = env('PHP_AUTH_USER');
Expand Down Expand Up @@ -320,7 +320,7 @@ Displaying auth related flash messages
In order to display the session error messages that Auth generates, you
need to add the following code to your layout. Add the following two
lines to the ``app/View/Layouts/default.ctp`` file in the body section
preferable before the content_for_layout line.::
preferable before the content_for_layout line. ::

echo $this->Session->flash();
echo $this->Session->flash('auth');
Expand Down
2 changes: 1 addition & 1 deletion en/core-libraries/components/cookie.rst
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ The CookieComponent offers a number of methods for working with Cookies.
.. php:method:: read(mixed $key = null)
This method is used to read the value of a cookie variable with the
name specified by $key.::
name specified by $key. ::

// Outputs "Larry"
echo $this->Cookie->read('name');
Expand Down
2 changes: 1 addition & 1 deletion en/core-libraries/components/security-component.rst
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ Using CSRF protection
Simply by adding the ``SecurityComponent`` to your components array,
you can benefit from the CSRF protection it provides. By default CSRF tokens are
valid for 30 minutes and expire on use. You can control how long tokens last by setting
csrfExpires on the component.::
csrfExpires on the component. ::

public $components = array(
'Security' => array(
Expand Down
14 changes: 7 additions & 7 deletions en/core-libraries/helpers/form.rst
Original file line number Diff line number Diff line change
Expand Up @@ -424,7 +424,7 @@ field. Internally ``input()`` delegates to other methods in FormHelper.
legend and fieldset rendering with the ``fieldset`` and ``legend`` keys.
``$this->Form->inputs(array('legend' => 'My legend'));``
Would generate an input set with a custom legend. You can customize
individual inputs through ``$fields`` as well.::
individual inputs through ``$fields`` as well. ::

echo $this->Form->inputs(array(
'name' => array('label' => 'custom label')
Expand Down Expand Up @@ -1010,7 +1010,7 @@ Ex: name=data[User][username], id=UserUsername

.. php:method:: password(string $fieldName, array $options)
Creates a password field.::
Creates a password field. ::

echo $this->Form->password('password');

Expand Down Expand Up @@ -1049,7 +1049,7 @@ Ex: name=data[User][username], id=UserUsername

.. php:method:: textarea(string $fieldName, array $options)
Creates a textarea input field.::
Creates a textarea input field. ::

echo $this->Form->textarea('notes');

Expand Down Expand Up @@ -1110,7 +1110,7 @@ Ex: name=data[User][username], id=UserUsername
Creates a checkbox form element. This method also generates an
associated hidden form input to force the submission of data for
the specified field.::
the specified field. ::

echo $this->Form->checkbox('done');

Expand Down Expand Up @@ -1163,7 +1163,7 @@ Ex: name=data[User][username], id=UserUsername

* ``$attributes['legend']`` Radio elements are wrapped with a legend and
fieldset by default. Set ``$attributes['legend']`` to false to remove
them.::
them. ::

$options = array('M' => 'Male', 'F' => 'Female');
$attributes = array('legend' => false);
Expand Down Expand Up @@ -1462,7 +1462,7 @@ Creating buttons and submit elements
<div class="submit"><input value="Submit" type="submit"></div>

You can also pass a relative or absolute URL to an image for the
caption parameter instead of caption text.::
caption parameter instead of caption text. ::

echo $this->Form->submit('ok.png');

Expand Down Expand Up @@ -1671,7 +1671,7 @@ Displaying and checking errors
.. php:method:: isFieldError(string $fieldName)
Returns true if the supplied $fieldName has an active validation
error.::
error. ::

if ($this->Form->isFieldError('gender')) {
echo $this->Form->error('gender');
Expand Down
24 changes: 12 additions & 12 deletions en/core-libraries/helpers/html.rst
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ methods of the HtmlHelper and how to use them.
If key 'rel' in ``$options`` array is set to 'import' the stylesheet will be imported.

This method of CSS inclusion assumes that the CSS file specified
resides inside the /app/webroot/css directory if path doesn't start with a '/'.::
resides inside the /app/webroot/css directory if path doesn't start with a '/'. ::

echo $this->Html->css('forms');

Expand All @@ -94,7 +94,7 @@ methods of the HtmlHelper and how to use them.

<link rel="stylesheet" type="text/css" href="/css/forms.css" />

The first parameter can be an array to include multiple files.::
The first parameter can be an array to include multiple files. ::

echo $this->Html->css(array('forms', 'tables', 'menu'));

Expand Down Expand Up @@ -262,7 +262,7 @@ methods of the HtmlHelper and how to use them.

Builds CSS style definitions based on the keys and values of the
array passed to the method. Especially handy if your CSS file is
dynamic.::
dynamic. ::

echo $this->Html->style(array(
'background' => '#633',
Expand All @@ -280,7 +280,7 @@ methods of the HtmlHelper and how to use them.
:param array $options: An array of :term:`html attributes`.

Creates a formatted image tag. The path supplied should be relative
to /app/webroot/img/.::
to /app/webroot/img/. ::

echo $this->Html->image('cake_logo.png', array('alt' => 'CakePHP'));

Expand All @@ -291,7 +291,7 @@ methods of the HtmlHelper and how to use them.
<img src="/img/cake_logo.png" alt="CakePHP" />

To create an image link specify the link destination using the
``url`` option in ``$htmlAttributes``.::
``url`` option in ``$htmlAttributes``. ::

echo $this->Html->image("recipes/6.jpg", array(
"alt" => "Brownies",
Expand Down Expand Up @@ -341,7 +341,7 @@ methods of the HtmlHelper and how to use them.

General purpose method for creating HTML links. Use ``$options`` to
specify attributes for the element and whether or not the
``$title`` should be escaped.::
``$title`` should be escaped. ::

echo $this->Html->link(
'Enter',
Expand Down Expand Up @@ -393,7 +393,7 @@ methods of the HtmlHelper and how to use them.
Delete
</a>

Query strings can also be created with ``link()``.::
Query strings can also be created with ``link()``. ::

echo $this->Html->link('View image', array(
'controller' => 'images',
Expand All @@ -412,7 +412,7 @@ methods of the HtmlHelper and how to use them.
names for ALL parameters in the URL. Using the string syntax for
paramters (i.e. "recipes/view/6/comments:false" will result in
the colon characters being HTML escaped and the link will not work
as desired.::
as desired. ::

<?php
echo $this->Html->link(
Expand All @@ -435,7 +435,7 @@ methods of the HtmlHelper and how to use them.

HTML special characters in ``$title`` will be converted to HTML
entities. To disable this conversion, set the escape option to
false in the ``$options`` array.::
false in the ``$options`` array. ::

<?php
echo $this->Html->link(
Expand All @@ -454,7 +454,7 @@ methods of the HtmlHelper and how to use them.

Setting ``escape`` to false will also disable escaping of attributes of the
link. As of 2.4 you can use the option ``escapeTitle`` to disable just
escaping of title and not the attributes.::
escaping of title and not the attributes. ::

<?php
echo $this->Html->link(
Expand Down Expand Up @@ -660,7 +660,7 @@ methods of the HtmlHelper and how to use them.
<script type="text/javascript" href="http://code.jquery.com/jquery.min.js">
</script>

The first parameter can be an array to include multiple files.::
The first parameter can be an array to include multiple files. ::

echo $this->Html->script(array('jquery', 'wysiwyg', 'scripts'));

Expand Down Expand Up @@ -784,7 +784,7 @@ methods of the HtmlHelper and how to use them.
:param array $thOptions: An array of :term:`html attributes` for the <th> elements

Creates a row of table header cells to be placed inside of <table>
tags.::
tags. ::

echo $this->Html->tableHeaders(array('Date', 'Title', 'Active'));

Expand Down
Loading

0 comments on commit f773909

Please sign in to comment.