Welcome to the Cookbook

O CookBook depende de contribuições de pessoas como você. Esta aplicação foi desenvolvida para permitir que qualquer um possa recomendar e adicionar alterações conforme necessário. Se você estiver começando com o CakePHP, você pode fazer a diferença e você é uma das melhores pessoas para sugerir alguma alteração na documentação. Submissões são revisadas por membros da equipe de documentação para manutenção da consistência, corretude e dos termos empregados.

Mas antes que você se entusiasme e reescreva o livro todo, há alguns avisos e recomendações a ter em mente:

A comunidade CakePHP depende de contribuições de pessoas como você. A documentação foi concebido para permitir que qualquer um possa recomendar e adicionar as alterações conforme necessário. Antes de você fazer, há algumas diretrizes que você deve seguir:

• Seja sucinto. As pessoas estão à procura de respostas de forma rápida e não querem ler grandes blocos de texto para obter a resposta.
• Você pode enviar texto simples, que será automaticamente formatado em html
• Enxugue seu conteúdo. Quebre-o para torná-la mais fácil de digitalizar. Utilize subseções, código blocos, listas, tabelas e adequadamente.
• Delimite código inline com as tags <code>. Não use aspas em torno do código. Por exemplo, em "A variável <code>$uses</code> especifica os models a serem utilizados."
• Delimite blocos de código <pre> tags. Por exemplo:
  

      <pre>
  	$this->functionName();
  	$this->otherFunctionName();
      </pre>
  

  Não é mais necessário escapar o conteúdo dentro de tags pre

• Arquivo e caminhos de URLs devem ser delimitados por tags <kbd>.
• Utilize exemplo.com quando um nome de domínio genérico deve ser referenciado. Seu objetivo é ser genérico e nunca será ligada a um spam ou site pornô.
• Links para outros recursos no livro deve ser referenciados sem o domínio. P.ex., /view/181/built-in-helpers
• Código exemplos devem corresponder aos Padrões de Codificação do CakePHP.
• Use classes predefinidas para estilização de métodos, alertas e notas.
• E finalmente: Verifique o preview! Se ele não aparecer certo para você - não vai aparecer certo quando for revisto.

Existem alguns elementos que podem receber uma estilização especial, visando chamar a atenção do leitor. Para aplicar essa estilização é necessário que algumas classes CSS especiais sejam aplicadas ao elemento.

Avisos devem ser usados para deixar o usuário ciente sobre algo que é importante, como a indicação de que um método ou propriedade está em desuso. Podem também ser usados para apontar onde o uso pode criar efeitos adversos.

Exemplo:

Este método está em desuso. Use nomeMetodo.

<p class="warning">Este método está em desuso. Use <a href="#">nomeMetodo</a>.</p>

1. <p class="warning">Este método está em desuso. Use <a href="#">nomeMetodo</a>.</p>

Alternativamente, se você tem um aviso que se estende por vários elementos do bloco, em seguida, use uma DIV para envolver todos os elementos.

Exemplo:

<p>Esta abordagem pode criar séria degradação de desempenho. Considerar abordagens alternativas:</p>
   <ul>
      <li>Abordagem A</li>
      <li> Abordagem B</li>
   </ul>
</div>

1. <p>Esta abordagem pode criar séria degradação de desempenho. Considerar abordagens alternativas:</p>
2. <ul>
3. <li>Abordagem A</li>
4. <li> Abordagem B</li>
5. </ul>
6. </div>

Uma nota pode ser utilizada para destacar informações que o leitor deve saber ou ser alertado quando estiver desenvolvendo sua aplicação.

Exemplo:

Você pode adicionar condições a qualquer um dos métodos para limitar os resultados.

<p class="note">Você pode adicionar condições a qualquer um dos métodos para limitar os resultados.</p>

1. <p class="note">Você pode adicionar condições a qualquer um dos métodos para limitar os resultados.</p>

Uma nota que precisa ser dividida em múltiplos blocos de elementos deve utilizar uma DIV que agrega todos os elementos. Veja a secção anterior, por exemplo.

There is no translation yet for this section. Please help out and translate this.. More information about translations

The method class should be used to wrap the method statement, parameters, and return value. The class is only applied to a single paragraph element.

Example:

string render (array $options = array())

<p class="method">
   <code>string render (array $options = array())</code>
</p>

1. <p class="method">
2. <code>string render (array $options = array())</code>
3. </p>

There is no translation yet for this section. Please help out and translate this.. More information about translations

Pre tags are assumed to contain php code unless otherwise specified

There are however other classes which can be used for pre tags specifcally:

plain for plain text. I.e. entering:

<pre class="plain">
Plain text
With self entered carriage return
</pre>

Gives:

Plain text
With self entered carriage return

shell for shell commands. I.e. entering:

<pre class="shell">
$ cake bake shell code
</pre>

Gives:

$ cake bake shell code

There is no translation yet for this section. Please help out and translate this.. More information about translations

The cookbook's fixed texts are stored in the application itself, and are not editable via the website. If you'd like to, for example, change the text for a menu item for your language - find the po file in the source repository fork the cakebook project, make your changes and let someone know in #cakephp-docs so that your changes can be pulled into the main repository.

Stub - update me

Se uma sessão do CookBook não foi traduzida para seu idioma irá aparecer em Inglês. O Cookbook depende colaborações dos usuários como você para compartilhar e adicionar a informação acumulada aqui. Consulte contribuindo com o Cookbook para orientações gerais sobre contribuições.

There is no translation yet for this section. Please help out and translate this.. More information about translations

The following is a list of shortcuts which point to custom queries on the CakePHP Lighthouse (ticket tracking) site. These queries help break down the mass of tickets into smaller groups, categorized by subject matter. These links point only to tickets which are currently open, sorted from oldest to newest.

"Tiny URLs" for the queries are provided (in addition to the direct URLs) as a convenience for copying and pasting into the various communication channels used by the community.

• Por favor, esteja ciente de que desde o Please be advised that further to anúncion de Nate, todos os tíquetes sobre melhorias para o CakePHP 1.2 criados a partir de 18 de maio de 2008 estarão sendo programados para a versão 2.0.
• Por favor, perceba que tíquetes de melhoria não são mais aceitos para CakePHP 1.1, uma vez que esta já é uma versão estável.

A melhor maneira de ajudar é criando testes e correções (patches), a serem submetidos aos tíquetes via trac. Isso irá facilitar o trabalho da equipe de desenvolvimento. Leia a seção sobre Testes do Cookbook que mostra como instalar o SimpleTest e como criar casos de teste. É importante que seus testes sejam feitos em cima da versão mais recente do CakePHP, disponível via SVN.

Se você se sentir mais confortável ou se se achar mais capacitado numa das categorias abaixo, inclua o link em seus favoritos e confira os tíquetes dessa categoria. É possível submeter casos de teste e correções para os tíquetes de outras pessoas desde que você esteja cadastrado no site do Trac - o que ajudar na solução ou numa melhor compreensão de algum bug ou ainda contribuir para alguma melhoria em geral no framework.

Você deve estar cadastrado em code.cakephp.org para poder submeter um tíquete. Cadastre-se aqui.

• Solicite ajuda para alguém no canal do IRC para confirmar se se trata de fato de um bug ou se não é apenas um mal entendimento sobre como o framework funciona.
• Procure nos arquivos do Google Groups para ver se alguém já resolveu o problema.
• Envie um e-mail (mande uma mensagem) para a lista de discussão no Google Groups para ver se mais alguém enfrentou o mesmo problema.
• Confira os tíquetes atuais para ver se o bug já foi reportado.
• Procure nos tíquetes ou confira a Linha do tempo para ver se o problema que você encontrou já não tenha sido solucionado.
• Verifique sua versão do CakePHP. Se você não estiver usando a versão mais recente (https://svn.cakephp.org/repo/branches/1.2.x.x) experimente atualizar para ver se o problema ainda persiste nesta versão mais atual.

Há um número pequeno de pessoas que desenvolvem o CakePHP atualmente. Entre documentar, planejar, responder a dúvidas, implementar os recursos para os próximos releases e ainda ter em mente que eles se dedicam a outras coisas em suas vidas além do CakePHP, correção de bugs tende a ser a última coisa de uma longa lista de coisas a fazer. Para despertar a atenção de um desses poucos voluntários para o bug que você estiver reportando, você precisa entender algumas coisas para reportar um bug de forma que eles possam ajudá-lo mais efetivamente.

Por favor, atente para a palavra voluntário :). As pessoas que deverão ajudar você com algum bug são voluntárias. Elas não estão sendo pagas para ajudá-lo. Então, seja gentil com elas.

Além desta regra de ouro, o que seguem são algumas dicas adicionais sobre como melhorar a qualidade de seu reporte de bug para que você também possa receber ajuda de melhor qualidade.

Estas são as três informações básicas para se reportar um bug e que podem reduzir consideravelmente o tempo gasto para se encontrar a solução: você precisa ser específico ao descrever o que você fez, o que você estava esperando que acontecesse e qual a diferença entre o que aconteceu e o que você esperava. Se você não incluir estas informações, então teremos que adivinhar e como se sabe, trabalhar assim não funciona muito bem. :)

• Informe um problema em cada reporte de bug.
• Se você encontrou dois bugs que não parecem estar relacionados, crie um novo reporte de bug para cada um deles. Isto facilita para que diferentes pessoas possam ajudar com diferentes bugs.
• Por favor, selecione os valores apropriados para as propriedades do tíquete que correspondam ao seu problema. Atenção especial aos valores de Component, Milestone e Version.
• Casos de teste válidos são uma grande ajuda. Correções (patches) são bem-vindas. De preferência, inclua casos de teste e correções junto com o tíquete

Veja os Tíquetes Atuais

Reporte um bug

A seguir está uma lista de atalhos que apontam para consultas específicas no site do CakePHP Trac (rastreamento de tíquetes). Estas consultas permitem visualizar o conjunto de tíquetes em grupos menores, classificando-os por assunto. Estes links apontam apenas para os tíquetes que estão atualmente abertos, em ordem dos mais antigos para os mais novos.

"URLs curtas" (via Tinyurl) para as consultas estão disponíveis (além das URLs diretas) como uma conveniência para se copiar e colar nos diversos canais de comunicação usados pela comunidade.

1. Relatório de bugs disponíveis
2. Tíquetes relacionados aos sites oficiais do CakePHP [tinyurl]

1. Bugs [tinyurl]
2. Documentação [tinyurl]
3. Aprimoramentos [tinyurl]
4. Otimizações [tinyurl]
5. Outros [tinyurl]

1. ACL e Auth [tinyurl]
2. Console e Shells [tinyurl]
3. Controllers e Components [tinyurl]
4. Núcleo [tinyurl]
   
5. Bases de dados [tinyurl]
6. Models e Behaviors [tinyurl]
7. Plugins e Vendors [tinyurl]
8. Views e Helpers [tinyurl]
9. Administração do servidor web [tinyurl]

1. Bugs [tinyurl]
2. Documentação [tinyurl]
3. Outros [tinyurl]