Skip to content

Commit

Permalink
Moving files into core-libraries.
Browse files Browse the repository at this point in the history
  • Loading branch information
markstory committed Mar 19, 2011
1 parent cd8e6cc commit 1cbbaf9
Show file tree
Hide file tree
Showing 46 changed files with 65 additions and 54 deletions.
2 changes: 1 addition & 1 deletion en/appendices/migrating-from-cakephp-1-2-to-1-3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,7 @@ This feature was also undocumented, and untested.


- ``Object::$_log`` has been removed. ``CakeLog::write`` is now
called statically. See :doc:`/common-tasks-with-cakephp/logging`
called statically. See :doc:`/core-libraries/logging`
for more information on changes made to logging.

**Sanitize**
Expand Down
2 changes: 1 addition & 1 deletion en/appendices/new-features-in-cakephp-1-3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ helpers to share names and not create collisions.

**New JsHelper and new features in HtmlHelper**

See :doc:`JsHelper documentation </core-helpers/js>` for more information
See :doc:`JsHelper documentation </core-libraries/core-helpers/js>` for more information

**Pagination Helper**

Expand Down
3 changes: 0 additions & 3 deletions en/common-tasks-with-cakephp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,10 @@ Common Tasks With CakePHP
.. toctree::
:maxdepth: 1

common-tasks-with-cakephp/caching
common-tasks-with-cakephp/data-sanitization
common-tasks-with-cakephp/data-validation
common-tasks-with-cakephp/debugging
common-tasks-with-cakephp/error-handling
common-tasks-with-cakephp/internationalization-and-localization
common-tasks-with-cakephp/logging
common-tasks-with-cakephp/pagination
common-tasks-with-cakephp/rest
common-tasks-with-cakephp/testing
2 changes: 1 addition & 1 deletion en/common-tasks-with-cakephp/data-validation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ we’ll cover in this section is the model side of things.
Essentially: what happens when you call the save() method of your
model. For more information about how to handle the displaying of
validation errors, check out
:doc:`/core-helpers/form`.
:doc:`/core-libraries/core-helpers/form`.

The first step to data validation is creating the validation rules
in the Model. To do that, use the Model::validate array in the
Expand Down
2 changes: 1 addition & 1 deletion en/common-tasks-with-cakephp/testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -657,7 +657,7 @@ files:
Initializing the component
~~~~~~~~~~~~~~~~~~~~~~~~~~

Since :doc:`/developing-with-cakephp/components`
Since :doc:`/controllers/components`
we need a controller to access the data in the model.

If the startup() function of the component looks like this:::
Expand Down
4 changes: 1 addition & 3 deletions en/contents.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,9 @@ Contents
controllers
views
models
core-libraries
common-tasks-with-cakephp
core-behaviors
core-components
core-console-applications
core-helpers
core-utility-libraries
developing-with-cakephp
deployment
Expand Down
4 changes: 2 additions & 2 deletions en/controllers/components.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ Configuring Components

Many of the core components require configuration. Some examples of
components requiring configuration are
:doc:`/core-components/authentication`, :doc:`/core-components/cookie`
and :doc:`/core-components/email`. Configuration for these
:doc:`/core-libraries/core-components/authentication`, :doc:`/core-libraries/core-components/cookie`
and :doc:`/core-libraries/core-components/email`. Configuration for these
components, and for components in general, is usually done in the
``$components`` array or your controller's ``beforeFilter()``
method.
Expand Down
17 changes: 17 additions & 0 deletions en/core-libraries.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Core Libraries
##############

Talk about how CakePHP comes with a bunch of batteries included that provide a good set of re-usable and common code.

Contents
========

.. toctree::

core-libraries/global-constants-and-functions
core-libraries/core-components
core-libraries/core-helpers
core-libraries/core-behaviors
core-libraries/logging
core-libraries/caching
core-libraries/internationalization-and-localization
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Caching
Caching can be made use of on various levels within a CakePHP
application. See
`how to disable browser caching <http://docs.cakephp.org/view/988/disableCache>`_,
:doc:`/core-helpers/cache`,
:doc:`/core-libraries/core-helpers/cache`,
`per-request query caching <http://docs.cakephp.org/view/1069/cacheQueries>`_ or
:doc:`/core-utility-libraries/cache` for more
:doc:`/core-libraries/caching` for more
info.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,7 @@ more easily.

You can change ContainableBehavior settings at run time by
reattaching the behavior as seen in
:doc:`/developing-with-cakephp/models/additional-methods-and-properties`
:doc:`/models/additional-methods-and-properties`

ContainableBehavior can sometimes cause issues with other behaviors
or queries that use aggregate functions and/or GROUP BY statements.
Expand Down
File renamed without changes.
File renamed without changes.
14 changes: 7 additions & 7 deletions en/core-components.rst → en/core-libraries/core-components.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,28 @@ Core Components
CakePHP has a number of built-in components. They provide out of
the box functionality for several commonly used tasks.

:doc:`/core-components/access-control-lists`
:doc:`/core-libraries/core-components/access-control-lists`
The Acl component provides an easy to use interface for database
and ini based access control lists.
:doc:`/core-components/authentication`
:doc:`/core-libraries/core-components/authentication`
The auth component provides an easy to use authentication system
using a variety of authentication processes, such as controller
callbacks, Acl, or Object callbacks.
:doc:`/core-components/cookie`
:doc:`/core-libraries/core-components/cookie`
The cookie component behaves in a similar fashion to the
SessionComponent in that it provides a wrapper for PHP's native
cookie support.
:doc:`/core-components/email`
:doc:`/core-libraries/core-components/email`
An interface that can be used to send emails using one of several
mail transfer agents including php's mail() and smtp.
:doc:`/core-components/request-handling`
:doc:`/core-libraries/core-components/request-handling`
The request handler allows you to introspect further into the
requests your visitors and inform your application about the
content types and requested information.
:doc:`/core-components/security-component`
:doc:`/core-libraries/core-components/security-component`
The security component allows you to set tighter security and use
and manage HTTP authentication.
:doc:`/core-components/sessions`
:doc:`/core-libraries/core-components/sessions`
The session component provides a storage independent wrapper to
PHP's sessions.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -439,7 +439,7 @@ permissions information between the two trees).

If you're curious about how Cake stores tree information in these
tables, read up on modified database tree traversal. The ACL
component uses CakePHP's :doc:`/core-behaviors/tree`
component uses CakePHP's :doc:`/core-libraries/core-behaviors/tree`
to manage the trees' inheritances. The model class files for ACL
are all compiled in a single file
`db\_acl.php <http://api.cakephp.org/file/cake/libs/model/db_acl.php>`_.
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,7 @@ field.

Besides the specific input options found below you can specify any
html attribute (for instance onfocus). For more information on
$options and $htmlAttributes see :doc:`/core-helpers/html`.
$options and $htmlAttributes see :doc:`/core-libraries/core-helpers/html`.

And to round off, here's an example for creating a
hasAndBelongsToMany select. Assume that User hasAndBelongsToMany
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ function to accomplish an oft-used task, it's here.
.. note::

Check out the
:doc:`/common-tasks-with-cakephp/internationalization-and-localization`
:doc:`/core-libraries/internationalization-and-localization`
section for more information.

.. php:function:: am(array $one, $two, $three...)
Expand Down
File renamed without changes.
1 change: 0 additions & 1 deletion en/developing-with-cakephp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ Developing with CakePHP
.. toctree::
:maxdepth: 1

developing-with-cakephp/global-constants-and-functions
developing-with-cakephp/configuration
developing-with-cakephp/the-cakephp-console
developing-with-cakephp/plugins
Expand Down
2 changes: 1 addition & 1 deletion en/developing-with-cakephp/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ datasource
'prefix\_'.

At this point, you might want to take a look at the
:doc:`/basic-principles-of-cakephp/cakephp-conventions`. The correct
:doc:`/getting-started/cakephp-conventions`. The correct
naming for your tables (and the addition of some columns) can score
you some free functionality and help you avoid configuration. For
example, if you name your database table big\_boxes, your model
Expand Down
2 changes: 1 addition & 1 deletion en/models/behaviors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ Behaviors that are attached to Models get their callbacks called
automatically. The callbacks are similar to those found in Models:
beforeFind, afterFind, beforeSave, afterSave, beforeDelete,
afterDelete and onError - see
:doc:`/developing-with-cakephp/models/callback-methods`.
:doc:`/models/callback-methods`.

Your behaviors should be placed in ``app/models/behaviors``. It's
often helpful to use a core behavior as a template when creating
Expand Down
2 changes: 1 addition & 1 deletion en/models/model-attributes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ on the database, this can cause SQL errors.

For more information on the ``virtualFields`` property, its proper
usage, as well as limitations, see
:doc:`/developing-with-cakephp/models/virtual-fields`.
:doc:`/models/virtual-fields`.

name
====
Expand Down
6 changes: 3 additions & 3 deletions en/models/retrieving-your-data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ of by some find types, behaviors and of course possible with your
own model methods

More information about model callbacks is available
:doc:`/developing-with-cakephp/models/callback-methods`
:doc:`/models/callback-methods`

.. _model-find-first:

Expand Down Expand Up @@ -306,14 +306,14 @@ model data to build nested results. Below are a couple of simple

.. tip::

It is not necessary to use :doc:`/core-behaviors/tree`
It is not necessary to use :doc:`/core-libraries/core-behaviors/tree`
to use this method - but all desired results must be possible to be
found in a single query.

In the above code example, ``$allCategories`` will contain a nested
array representing the whole category structure. The second example
makes use of the data structure used by the
:doc:`/core-behaviors/tree` the return a partial, nested,
:doc:`/core-libraries/core-behaviors/tree` the return a partial, nested,
result for ``$aCategory`` and everything below it. The results of a
call to ``find('threaded')`` will be of the following form::

Expand Down
8 changes: 4 additions & 4 deletions en/tutorials-and-examples/blog/part-two.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ The ``$name`` variable is always a good idea to add, and is used to
overcome some class name oddness in PHP4.

For more on models, such as table prefixes, callbacks, and
validation, check out the :doc:`/developing-with-cakephp/models` chapter of the
validation, check out the :doc:`/models` chapter of the
Manual.


Expand Down Expand Up @@ -105,7 +105,7 @@ automatically available at ``$this->Post`` because we've followed
Cake's naming conventions.

To learn more about Cake's controllers, check out Chapter
"Developing with CakePHP" section: :doc:`controllers`.
"Developing with CakePHP" section: :doc:`/controllers`.

Creating Post Views
===================
Expand Down Expand Up @@ -392,7 +392,7 @@ The ``$this->Form->end()`` call generates a submit button and ends
the form. If a string is supplied as the first parameter to
``end()``, the FormHelper outputs a submit button named accordingly
along with the closing form tag. Again, refer to
:doc:`/developing-with-cakephp/helpers` for more on helpers.
:doc:`/views/helpers` for more on helpers.

Now let's go back and update our ``/app/views/posts/index.ctp``
view to include a new "Add Post" link. Before the ``<table>``, add
Expand Down Expand Up @@ -659,4 +659,4 @@ These are common tasks people learning CakePHP usually want to study next:
2. :ref:`view-elements` Including and reusing view snippets
3. :doc:`/controllers/scaffolding`: Prototyping before creating code
4. :doc:`/core-console-applications/code-generation-with-bake` Generating basic CRUD code
5. :doc:`/core-components/authentication`: User registration and login
5. :doc:`/core-libraries/core-components/authentication`: User registration and login
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ Simple Acl controlled Application
#################################

In this tutorial you will create a simple application with
:doc:`/core-components/authentication` and
:doc:`/core-components/access-control-lists`. This
:doc:`/core-libraries/core-components/authentication` and
:doc:`/core-libraries/core-components/access-control-lists`. This
tutorial assumes you have read the :doc:`/tutorials-and-examples/blog/blog`
tutorial, and you are familiar with
:doc:`/core-console-applications/code-generation-with-bake`. You should have
Expand Down
6 changes: 3 additions & 3 deletions en/views.rst
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ Caching Elements
You can take advantage of CakePHP view caching if you supply a
cache parameter. If set to true, it will cache for 1 day.
Otherwise, you can set alternative expiration times. See
:doc:`/common-tasks-with-cakephp/caching` for more information on setting
:doc:`/core-libraries/caching` for more information on setting
expiration.

::
Expand Down Expand Up @@ -381,8 +381,8 @@ To call any view method use ``$this->method()``
directly to the layout. Keep in mind that scripts added from the
layout, or elements in the layout will not be added to
``$scripts_for_layout``. This method is most often used from inside
helpers, like the :doc:`/core-helpers/js` and
:doc:`/core-helpers/html` Helpers.
helpers, like the :doc:`/core-libraries/core-helpers/js` and
:doc:`/core-libraries/core-helpers/html` Helpers.

More about Views
================
Expand Down
26 changes: 13 additions & 13 deletions en/views/helpers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ shared between many views, elements, or layouts. This chapter will
show you how to create your own helpers, and outline the basic
tasks CakePHP’s core helpers can help you accomplish. For more
information on core helpers, check out
:doc:`/core-helpers`.
:doc:`/core-libraries/core-helpers`.

Using Helpers
=============
Expand Down Expand Up @@ -190,34 +190,34 @@ CakePHP features a number of helpers that aid in view creation.
They assist in creating well-formed markup (including forms), aid
in formatting text, times and numbers, and can even speed up Ajax
functionality. Here is a summary of the built-in helpers. For more
information, check out :doc:`/core-helpers`.
information, check out :doc:`/core-libraries/core-helpers`.

CakePHP Helper
Description
:doc:`/core-utility-libraries/cache`
:doc:`/core-libraries/core-helpers/cache`
Used by the core to cache view content.
:doc:`/core-helpers/form`
:doc:`/core-libraries/core-helpers/form`
Creates HTML forms and form elements that self populate and handle
validation problems.
:doc:`/core-helpers/html`
:doc:`/core-libraries/core-helpers/html`
Convenience methods for crafting well-formed markup. Images, links,
tables, header tags and more.
:doc:`/core-helpers/js`
:doc:`/core-libraries/core-helpers/js`
Used to create Javascript compatible with various Javascript
libraries. Replaces JavascriptHelper and AjaxHelper with a more
flexible solution.
:doc:`/core-helpers/number`
:doc:`/core-libraries/core-helpers/number`
Number and currency formatting.
:doc:`/core-helpers/paginator`
:doc:`/core-libraries/core-helpers/paginator`
Model data pagination and sorting.
:doc:`/core-helpers/rss`
:doc:`/core-libraries/core-helpers/rss`
Convenience methods for outputting RSS feed XML data.
:doc:`/core-helpers/session`
:doc:`/core-libraries/core-helpers/session`
Access for reading session values in views.
:doc:`/core-helpers/text`
:doc:`/core-libraries/core-helpers/text`
Smart linking, highlighting, word smart truncation.
:doc:`/core-helpers/time`
:doc:`/core-libraries/core-helpers/time`
Proximity detection (is this next year?), nice string
formatting(Today, 10:30 am) and time zone conversion.
:doc:`/core-helpers/xml`
:doc:`/core-libraries/core-helpers/xml`
Convenience methods for creating XML headers and elements.

0 comments on commit 1cbbaf9

Please sign in to comment.