Skip to content

Commit

Permalink
fix sphinx build errors, only label warning left
Browse files Browse the repository at this point in the history
  • Loading branch information
cake17 committed Sep 12, 2015
1 parent 6023e50 commit ed2f29f
Show file tree
Hide file tree
Showing 32 changed files with 399 additions and 291 deletions.
13 changes: 13 additions & 0 deletions en/contributing/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -353,6 +353,19 @@ Each directive populates the index, and or the namespace index.
Describe an property/attribute on a class.

Prevent Sphinx to Output Warnings
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Sphinx will output warnings if a function is referenced in multiple files. It's
a great way to ensure that you did not add a function two times, but
sometimes, you actually want to write a function in two or more files, eg.
`debug object` is referenced in `/development/debugging` and in
`/core-libraries/global-constants-and-functions`. In this case, you can add
``:noindex:`` under the function debug, and the warnings will stop to alert you::

.. php:function:: debug(mixed $var, boolean $showHtml = null, $showFrom = true)
:noindex:

Cross Referencing
~~~~~~~~~~~~~~~~~

Expand Down
1 change: 1 addition & 0 deletions en/development/debugging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Basic Debugging
===============

.. php:function:: debug(mixed $var, boolean $showHtml = null, $showFrom = true)
:noindex:

:param mixed $var: The contents to print out. Arrays and objects work well.
:param boolean $showHTML: Set to true, to enable escaping. Escaping is enabled
Expand Down
1 change: 0 additions & 1 deletion en/views.rst
Original file line number Diff line number Diff line change
Expand Up @@ -807,7 +807,6 @@ More about Views
views/json-and-xml-views
views/helpers


.. meta::
:title lang=en: Views
:keywords lang=en: view logic,csv file,response elements,code elements,default extension,json,flash object,remote application,twig,subclass,ajax,reply,soap,functionality,cakephp,audience,xml,mvc
120 changes: 60 additions & 60 deletions es/controllers/components.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,28 @@ Componentes
###########

Los componentes son paquetes de logica que es compartida entre controladores.
CakePHP incluye un fantastico set de componentes que puedes usar para ayudarte
CakePHP incluye un fantastico set de componentes que puedes usar para ayudarte
en tareas comunes. También puedes crear tus propios componentes. Si te encontrás
queriendo copiar y pegar cosas entre de un controlador a otro, deberias considerar
crear tu propio componente para obtener esa funcionalidad. Crear componentes ayuda a
mantener el codigo de tus controladores limpio y facilita la reutilización de código
crear tu propio componente para obtener esa funcionalidad. Crear componentes ayuda a
mantener el codigo de tus controladores limpio y facilita la reutilización de código
entre proyectos.

Cada uno de los componentes principales esta detallado en su propio capítulo.
Cada uno de los componentes principales esta detallado en su propio capítulo.
Ver :doc:`/core-libraries/toc-components`.
Esta sección describe como configurar y usar los componentes y como crear tus propios
Esta sección describe como configurar y usar los componentes y como crear tus propios
componentes.

.. _configuring-components:

Configurando componentes
========================

Mucho de los componentes principales requieren configuración. Algunos ejemplos de
componentes que requieren configuración son
Mucho de los componentes principales requieren configuración. Algunos ejemplos de
componentes que requieren configuración son
:doc:`/core-libraries/components/authentication` y :doc:`/core-libraries/components/cookie`.
La configuración para estos componentes, y para los componentes en general, es realizada
usualmente en el array ``$components`` o en el método ``beforeFilter()`` de tú
La configuración para estos componentes, y para los componentes en general, es realizada
usualmente en el array ``$components`` o en el método ``beforeFilter()`` de tú
controlador::

class PostsController extends AppController {
Expand All @@ -38,12 +38,12 @@ controlador::
'Cookie' => array('name' => 'CookieMonster')
);

El fragmento de código anterior sería un ejemplo de configuración de un componente
El fragmento de código anterior sería un ejemplo de configuración de un componente
con el array ``$components``.
Todos los componentes principales permiten que su configuración sea
seteada de ésta forma. A su vez, es posible configurar el componente
a través del método ``beforeFilter()`` de tú controlador.
Esto es útil cuando necesitas asignar los resultados de una función a la propiedad de
Todos los componentes principales permiten que su configuración sea
seteada de ésta forma. A su vez, es posible configurar el componente
a través del método ``beforeFilter()`` de tú controlador.
Esto es útil cuando necesitas asignar los resultados de una función a la propiedad de
un componente. El código anterior también podría ser expresado como::

public function beforeFilter() {
Expand All @@ -56,20 +56,20 @@ un componente. El código anterior también podría ser expresado como::
$this->Cookie->name = 'CookieMonster';
}

Sin embargo, es posible que un componente requiera que cierta configuración
antes que el método ``beforeFilter()`` del controlador sea ejecutado.
Con éste fin, algunos componentes permiten que las opciones de configuración
Sin embargo, es posible que un componente requiera que cierta configuración
antes que el método ``beforeFilter()`` del controlador sea ejecutado.
Con éste fin, algunos componentes permiten que las opciones de configuración
sean seteadas en el array ``$components``::

public $components = array(
'DebugKit.Toolbar' => array('panels' => array('history', 'session'))
);

Consulte la documentación relevante para determinar que opción de configuración provee
Consulte la documentación relevante para determinar que opción de configuración provee
cada componente.

Una opcion común es el uso de ``className``, la cual le permite ponerle un alias a un
componente. Esta caracteristica es útil cuando se quiere reemplazar ``$this->Auth``
Una opcion común es el uso de ``className``, la cual le permite ponerle un alias a un
componente. Esta caracteristica es útil cuando se quiere reemplazar ``$this->Auth``
o la referencia de otro componente común con una implementación propia::

// app/Controller/PostsController.php
Expand All @@ -87,19 +87,19 @@ o la referencia de otro componente común con una implementación propia::
// Add your code to override the core AuthComponent
}

El código anterior aplicaría un *alias* ``MyAuthComponent`` a ``$this->Auth`` en tús
El código anterior aplicaría un *alias* ``MyAuthComponent`` a ``$this->Auth`` en tús
controladores.

.. note::

Usar un alias en un componente reemplaza esa instancia en cualquier lugar que ese componente sea
Usar un alias en un componente reemplaza esa instancia en cualquier lugar que ese componente sea
usado, incluyendo dentro de otros componentes.

Usando Componentes
==================

Una vez que has incluido algunos componentes en tús controladores, usarlos
es bastante sensillo. Cada componente que use es expuesto como una propiedad
Una vez que has incluido algunos componentes en tús controladores, usarlos
es bastante sensillo. Cada componente que use es expuesto como una propiedad
en tú controlador. Si ha cargado :php:class:`SessionComponent` y
:php:class:`CookieComponent` en su controlador, accederia a ellos de esta forma::

Expand All @@ -115,46 +115,46 @@ en tú controlador. Si ha cargado :php:class:`SessionComponent` y

.. note::

Ya que tanto modelos como componentes son agregados a los controladores
como propiedades, comparten el mismo 'namespace'. Asegurese de no darles
Ya que tanto modelos como componentes son agregados a los controladores
como propiedades, comparten el mismo 'namespace'. Asegurese de no darles
el mismo nombre a un modelo y componente.

Cargar modelos en el acto
-------------------------

Tal vez no necesite todos los componentes disponibles en cada acción de su
controlador. En situaciones como esta puede cargar un componente en tiempo de
ejecucion usando :doc:`Component Collection </core-libraries/collections>`.
Tal vez no necesite todos los componentes disponibles en cada acción de su
controlador. En situaciones como esta puede cargar un componente en tiempo de
ejecucion usando :doc:`Component Collection </core-libraries/collections>`.
Desde dentro de un método de un controlador se puede::

$this->OneTimer = $this->Components->load('OneTimer');
$this->OneTimer->getTime();

.. note::

Tenga en cuenta que cargar un componente en tiempo de ejecución no
llamara el método initialize de el componente.
Tenga en cuenta que cargar un componente en tiempo de ejecución no
llamara el método initialize de el componente.


Callbacks de componentes
========================

Los componentes también ofrecen varios callbacks que permiten aumentar
el ciclo del request. Vea :ref:`component-api` para más información
Los componentes también ofrecen varios callbacks que permiten aumentar
el ciclo del request. Vea :ref:`component-api` para más información
sobre los callbacks que ofrecen los componentes.

.. _creating-a-component:

Creando componentes
===================

Suponga que nuestra aplicación online necesita llevar a cabo una
operación matemática compleja en diferentes partes de la aplicación.
En este caso, crearíamos un componente que albergue esta lógica
Suponga que nuestra aplicación online necesita llevar a cabo una
operación matemática compleja en diferentes partes de la aplicación.
En este caso, crearíamos un componente que albergue esta lógica
compartida para usar en diferentes controladores.

El primer paso es crear un nuevo archivo y clase de componente.
Cree el archivo en ``app/Controller/Component/MathComponent.php``. La estructura
El primer paso es crear un nuevo archivo y clase de componente.
Cree el archivo en ``app/Controller/Component/MathComponent.php``. La estructura
básica para un componente es::

App::uses('Component', 'Controller');
Expand All @@ -166,27 +166,27 @@ básica para un componente es::

.. note::

Todos los componentes deben extender :php:class:`Component`. Si no lo hacen
Todos los componentes deben extender :php:class:`Component`. Si no lo hacen
se disparará una excepción.

Incluyendo tús componentes en un controlador
--------------------------------------------

Una vez que nuestro componente está terminado, podemos usarlo en un
controlador agregando el nombre del componente (sin la parte de "Component") en
el array ``$components``. El controlador recibirá automáticamente un nuevo
atributo llamado como este componente a través del cual podemos acceder a una
Una vez que nuestro componente está terminado, podemos usarlo en un
controlador agregando el nombre del componente (sin la parte de "Component") en
el array ``$components``. El controlador recibirá automáticamente un nuevo
atributo llamado como este componente a través del cual podemos acceder a una
instancia del componente::

/* Hacer disponible el nuevo componente $this->Math,
y el standard $this->Session */
public $components = array('Math', 'Session');

Los componentes declarados en ``AppController`` serám combinados con aquellos
en otros controladores. Por lo que no hay necesidad de re-declarar un componente
Los componentes declarados en ``AppController`` serám combinados con aquellos
en otros controladores. Por lo que no hay necesidad de re-declarar un componente
mas de una vez.

Al incluír componentes en un controlador también podemos declarar un grupo de
Al incluír componentes en un controlador también podemos declarar un grupo de
parametros que serán pasados al constructor del componente.
Estos parametros pueden ser manejados por el componente::

Expand All @@ -198,17 +198,17 @@ Estos parametros pueden ser manejados por el componente::
'Session', 'Auth'
);

El código anterior pasará un array que contiene precision y randomGenerator a
``MathComponent::__construct()`` como el segundo parámetro. Por convención
si los keys de un array son iguales a las propiedades públicas de un componente,
El código anterior pasará un array que contiene precision y randomGenerator a
``MathComponent::__construct()`` como el segundo parámetro. Por convención
si los keys de un array son iguales a las propiedades públicas de un componente,
las propiedades seran actualizadas con los valores de esas keys.


Usando otros componentes en tús componentes
-------------------------------------------

A veces, algunos de tus componentes pueden necesitar usar otros componentes.
En estos casos se puede incluir otros componentes en tús componentes de la
En estos casos se puede incluir otros componentes en tús componentes de la
misma forma que se incluyen en un controlador::

// app/Controller/Component/CustomComponent.php
Expand Down Expand Up @@ -236,7 +236,7 @@ misma forma que se incluyen en un controlador::
}

.. note::
En contraste con los componentes incluidos en un controlador
En contraste con los componentes incluidos en un controlador
ningún callback va a ser disparado en el componente de un componente.

.. _component-api:
Expand All @@ -247,15 +247,15 @@ API Componentes
.. php:class:: Component
La clase base Component ofrece varios métodos para cargar otros componentes
a través de :php:class:`ComponentCollection` así como para tratar con
configuraciones comunes. También provee prototipos para todos los callbacks de los
a través de :php:class:`ComponentCollection` así como para tratar con
configuraciones comunes. También provee prototipos para todos los callbacks de los
componentes.

.. php:method:: __construct(ComponentCollection $collection, $settings = array())
Constructor para la clase base component. Todos los ``$settings`` que
Constructor para la clase base component. Todos los ``$settings`` que
también tengan propiedades públicas serán actualizados para coincidir con
``$settings``.
``$settings``.

Callbacks
---------
Expand All @@ -266,12 +266,12 @@ Callbacks

.. php:method:: startup(Controller $controller)
Es llamado despues de el método beforeFilter pero antes que el
Es llamado despues de el método beforeFilter pero antes que el
controlador ejecute la actual acción.

.. php:method:: beforeRender(Controller $controller)
Es llamada luego que el controlador ejecute la acción de la vista
Es llamada luego que el controlador ejecute la acción de la vista
solicitada, pero antes que el controlador renderice la vista.

.. php:method:: shutdown(Controller $controller)
Expand All @@ -280,9 +280,9 @@ Callbacks

.. php:method:: beforeRedirect(Controller $controller, $url, $status=null, $exit=true)
Es llamado cuando el método de redireccion del controlador es llamado,
pero antes de acción alguna. Si este método devuelve false el controlador
no continuará hacia el redireccionamiento.
Es llamado cuando el método de redireccion del controlador es llamado,
pero antes de acción alguna. Si este método devuelve false el controlador
no continuará hacia el redireccionamiento.

.. meta::
:title lang=es: Components
Expand Down
4 changes: 4 additions & 0 deletions es/core-utility-libraries/string.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ String

.. php:class:: String
.. start-string
.. note::
La documentación no es compatible actualmente con el idioma español en esta página.

Expand All @@ -12,6 +14,8 @@ String
Usted puede hacer referencia a la versión en Inglés en el menú de selección superior
para obtener información sobre el tema de esta página.

.. end-string
.. meta::
:title lang=es: String
:keywords lang=es: array php,array name,string options,data options,result string,class string,string data,string class,placeholders,default method,key value,markup,rfc,replacements,convenience,templates
4 changes: 4 additions & 0 deletions es/core-utility-libraries/time.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ CakeTime

.. php:class:: CakeTime()
.. start-caketime
.. note::
La documentación no es compatible actualmente con el idioma español en esta página.

Expand All @@ -12,6 +14,8 @@ CakeTime
Usted puede hacer referencia a la versión en Inglés en el menú de selección superior
para obtener información sobre el tema de esta página.

.. end-caketime
.. meta::
:title lang=es: CakeTime
:description lang=es: CakeTime class helps you format time and test time.
Expand Down
Loading

0 comments on commit ed2f29f

Please sign in to comment.