Skip to content

Commit

Permalink
Better TOC structure for Core Libraries
Browse files Browse the repository at this point in the history
  • Loading branch information
shama committed Oct 13, 2012
1 parent 439b9d4 commit ef8ae42
Show file tree
Hide file tree
Showing 6 changed files with 96 additions and 62 deletions.
86 changes: 24 additions & 62 deletions en/core-libraries.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
Core Libraries
##############

CakePHP comes with a plethora of built-in functions and classes. These classes
CakePHP comes with a plethora of built-in functions and classes. These classes
and functions try to cover some of the most common features required in web
applications.

General purpose
General Purpose
===============

General purpose libraries are available and reused in many places across
Expand All @@ -14,9 +14,24 @@ CakePHP.
.. toctree::
:maxdepth: 2

core-libraries/global-constants-and-functions
core-libraries/events
core-libraries/collections
core-libraries/toc-general-purpose

.. _core-behaviors:

Behaviors
=========

Behaviors add extra functionality to your models. CakePHP comes
with a number of built-in behaviors such as :php:class:`TreeBehavior`
and :php:class:`ContainableBehavior`.

To learn about creating and using behaviors, read the section
on :doc:`/models/behaviors`.

.. toctree::
:maxdepth: 2

core-libraries/toc-behaviors

.. _core-components:

Expand All @@ -30,14 +45,7 @@ configure and use components.
.. toctree::
:maxdepth: 2

core-libraries/components/access-control-lists
core-libraries/components/authentication
core-libraries/components/cookie
core-libraries/components/email
core-libraries/components/request-handling
core-libraries/components/pagination
core-libraries/components/security-component
core-libraries/components/sessions
core-libraries/toc-components

.. _core-helpers:

Expand All @@ -55,65 +63,19 @@ can create and use your own helpers.
.. toctree::
:maxdepth: 2

core-libraries/helpers/cache
core-libraries/helpers/form
core-libraries/helpers/html
core-libraries/helpers/js
core-libraries/helpers/number
core-libraries/helpers/paginator
core-libraries/helpers/rss
core-libraries/helpers/session
core-libraries/helpers/text
core-libraries/helpers/time
core-libraries/toc-helpers

.. _core-behaviors:

Behaviors
Utilities
=========

Behaviors add extra functionality to your models. CakePHP comes
with a number of built-in behaviors such as :php:class:`TreeBehavior`
and :php:class:`ContainableBehavior`.

To learn about creating and using behaviors, read the section
on :doc:`/models/behaviors`.

.. toctree::
:maxdepth: 2

core-libraries/behaviors/acl
core-libraries/behaviors/containable
core-libraries/behaviors/translate
core-libraries/behaviors/tree

Core Libraries
==============

Beyond the core MVC components, CakePHP includes a great selection of utility
classes that help you do everything from webservice requests, to caching, to
logging, internationalization and more.

.. toctree::
:maxdepth: 2

core-utility-libraries/app
core-libraries/caching
core-utility-libraries/email
core-utility-libraries/number
core-utility-libraries/time
core-utility-libraries/sanitize
core-utility-libraries/file-folder
core-utility-libraries/httpsocket
core-utility-libraries/inflector
core-libraries/internationalization-and-localization
core-libraries/logging
core-utility-libraries/router
core-utility-libraries/security
core-utility-libraries/hash
core-utility-libraries/set
core-utility-libraries/string
core-utility-libraries/xml

core-libraries/toc-utilities

.. meta::
:title lang=en: Core Libraries
Expand Down
10 changes: 10 additions & 0 deletions en/core-libraries/toc-behaviors.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Behaviors
#########

.. toctree::
:maxdepth: 2

behaviors/acl
behaviors/containable
behaviors/translate
behaviors/tree
14 changes: 14 additions & 0 deletions en/core-libraries/toc-components.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Components
##########

.. toctree::
:maxdepth: 2

components/access-control-lists
components/authentication
components/cookie
components/email
components/request-handling
components/pagination
components/security-component
components/sessions
10 changes: 10 additions & 0 deletions en/core-libraries/toc-general-purpose.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
General Purpose
###############

.. toctree::
:maxdepth: 2

global-constants-and-functions
../core-utility-libraries/app
events
collections
16 changes: 16 additions & 0 deletions en/core-libraries/toc-helpers.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
Helpers
#######

.. toctree::
:maxdepth: 2

helpers/cache
helpers/form
helpers/html
helpers/js
helpers/number
helpers/paginator
helpers/rss
helpers/session
helpers/text
helpers/time
22 changes: 22 additions & 0 deletions en/core-libraries/toc-utilities.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Utilities
#########

.. toctree::
:maxdepth: 2

caching
../core-utility-libraries/email
../core-utility-libraries/number
../core-utility-libraries/time
../core-utility-libraries/sanitize
../core-utility-libraries/file-folder
../core-utility-libraries/httpsocket
../core-utility-libraries/inflector
internationalization-and-localization
logging
../core-utility-libraries/router
../core-utility-libraries/security
../core-utility-libraries/hash
../core-utility-libraries/set
../core-utility-libraries/string
../core-utility-libraries/xml

0 comments on commit ef8ae42

Please sign in to comment.