Ver índice de contenidos del libro

3.3. Encuentra la documentación más rápido

Como Symfony es un framework grande y con muchas características, no siempre resulta fácil acordarse de todas sus opciones de configuración o de todas las clases y métodos disponibles. Como se explicó anteriormente, utilizar un IDE puede facilitar tu trabajo mediante el autocompletado. A continuación se explica cómo sacar partido a las herramientas existentes para encontrar las respuestas lo más rápido posible.

3.3.1. API online

La forma más rápida de encontrar documentación sobre una clase o método consiste en navegar la API online de Symfony.

Más interesante todavía es el buscador que incluye la propia API, ya que permite encontrar rápidamente cualquier clase o método escribiendo sólo unos pocos caracteres. En la página de la API, introduce algunas letras en el cuadro de búsqueda para que aparezca una caja con sugerencias útiles actualizadas en tiempo real.

Se puede buscar escribiendo el principio del nombre de una clase:

Búsqueda de la API

Figura 3.1 Búsqueda de la API

o el principio del nombre de un método:

Búsqueda de la API

Figura 3.2 Búsqueda de la API

o el nombre de una clase seguido por :: para mostrar el listado de todos sus métodos:

Búsqueda de la API

Figura 3.3 Búsqueda de la API

o el nobre de un método para refinar aún más las posibilidades:

Búsqueda de la API

Figura 3.4 Búsqueda de la API

Si quieres ver todas las clases de un paquete, escribe el nombre del paquete y envía tu petición.

Incluso puedes integrar el buscador de la API de Symfony en tu propio navegador. De esta forma, no es necesario que visites el sitio web de Symfony cuando quieras hacer una búsqueda. Esto es posible porque el sitio dispone de soporte nativo de OpenSearch para la API de Symfony.

Si utilizas Firefox, los buscadores de la API de Symfony aparecen automáticamente en el menú de búsqueda del navegador. También puedes pinchar sobre el enlace "API OpenSearch" incluido en la documentación de la API para añadir ese buscador en tu navegador de forma permanente.

Nota El blog oficial publicó hace tiempo un un screencast que muestra cómo se integra el buscador de la API de Symfony con Firefox: ver screencast.

3.3.2. Cheat Sheets o chuletas

Si quieres resúmenes sobre las partes más importantes del framework, puedes descargar un montón de cheat sheets:

Nota Algunas de estas cheat sheets no han sido actualizadas para Symfony 1.3.

3.3.3. Documentación offline

La guía de referencia de Symfony es la mejor forma de responder a las preguntas relativas a las opciones de configuración. Se trata de un libro imprescindible cuando desarrollas aplicaciones Symfony. Este libro es la forma más rápida de encontrar cualquier opción de configuración disponible gracias a su detallado índice de contenidos, su índice alfabético, las referencias cruzadas en cada capítulo, las tablas, etc.

Puedes leer esta guía en Internet, puedes comprar una versión impresa e incluso descargar su versión en PDF.

3.3.4. Herramientas online

Como se ha mostrado al inicio de este capítulo, Symfony incluye muchas herramientas útiles para que empieces a crear tu aplicación lo antes posible. Por eso, en poco tiempo habrás acabado tu proyecto y será el momento de pasarlo a producción.

Para comprobar si tu sitio está listo para pasarlo a producción, puedes hacer uso de las siguiente lista de comprobación. Este sitio web muestra las comprobaciones esenciales que debes realizar antes de pasar el sitio a producción.