Permalink
Browse files

Retirada documentacao do README. A documentacao encontra-se na wiki d…

…o github.
  • Loading branch information...
jrbasso committed Aug 17, 2010
1 parent 45ca330 commit 42f0aa85486627f47dce138c8fd73363218f395a
Showing with 2 additions and 313 deletions.
  1. +2 −313 README.textile
View
@@ -5,317 +5,6 @@ Caso você tenha dúvidas, elogios, reclamações, sugestões, etc., acesse o
Este plugin foi desenvolvido para a versão 1.3 do CakePHP.
-h2. Instruções gerais
+Sobre a utilização deste plugin, consulte a documentação no GitHub:http://wiki.github.com/jrbasso/cake_ptbr/
-Copie todos os diretórios deste diretório para dentro da pasta app/plugins/cake_ptbr (crie a pasta se necessário).
-
-Para instalar as mensagens de core e as inflections em português, adicione a seguinte linha no arquivo
-app/config/bootstrap.php:
-
-<pre>
-require APP . 'plugins' . DS . 'cake_ptbr' . DS . 'config' . DS . 'bootstrap.php';
-</pre>
-
-O código anterior não é necessário para utilização dos behaviors e helpers.
-
-Todos os recursos possuem testes unitários.
-
-h2. Recursos disponíveis no plugin
-
-h3. Traduzindo as mensagens do core - "Referência":http://kiss.souagil.com.br/2008/09/traduzindo-o-core-de-sua-aplicacao-cakephp/
-
-Ao incluir a linha no bootstrap (conforme as instruções nas informações gerais), as mensagens geradas pelo CakePHP serão traduzidas
-para português brasileiro. Frases de estar faltando controller, view, etc. são exemplos de frases que serão traduzidas.
-
-h3. Inflections - "Referência":http://blog.cakephp-brasil.org/2008/05/25/inflections-em-portugues/
-
-Inflections são regras de como as palavras serão pluralizadas e singualizadas. O CakePHP nativamente trás as regras para o inglês,
-porém as palavras em português ficam erradas. Por exemplo, nativamente o CakePHP considera a palavra 'computadors' como o plural de
-'computador'.
-
-As inflections afetam também as palavras usadas como nome de tabelas no banco de dados.
-
-h3. EstadoBrasileiro (Model)
-
-O model EstadoBrasileiro contém informações sobre os estados brasileiros, podendo ser utilizado para auxiliar ou associar com outros
-modelos. Também poderá servir de base para outros modelos.
-
-h4. Instalação e Utilização
-
-Utilizar no controller:
-
-<pre>
-class XxxsController extends AppController {
- var $name = 'Xxxs';
- var $uses = array('Xxx', 'CakePtbr.EstadoBrasileiro');
-
- function index() {
- $this->EstadoBrasileiro->find('list');
- }
-}
-</pre>
-
-Criando uma model:
-
-<pre>
-App::import('Model', 'CakePtbr.EstadoBrasileiro');
-
-class Estado extends EstadoBrasileiro {
-...
-}
-</pre>
-
-A model EstadoBrasileiro estende a AppModel. Logo, todos os métodos utilizados na sua AppModel serão aplicados neste novo model.
-
-Métodos disponíveis no model:
-
-* listaEstados($incluirDF = true)
-** Gera uma lista com os estados, sendo a chave a sigla e o valor o nome do estado.
-* todosEstados($incluirDF = true)
-** Lista os estados, mas no formato array('EstadoBrasileiro' => array(array('sigla' => 'SC', 'nome' => 'Santa Catarina'), ...)).
-* estadoPorSigla($sigla)
-** Informa o nome do estado através da sigla. Por exemplo, passando 'SC' como parâmetro, é retornado 'Santa Catarina'.
-* siglaPorEstado($estado)
-** Inverso do método anterior.
-* estadosDoSul()
-** Apresenta uma lista com os estados da região sul. A lista virá no mesmo formato de listaEstados.
-* estadosDoSudeste()
-** Idem estadosDoSul, mas para região sudeste.
-* estadosDoCentroOeste($incluirDF = true)
-** Idem estadosDoSul, mas para região centro-oeste. É possível informar se será incluído o Distrito Federal.
-* estadosDoNorte()
-** Idem estadosDoSul, mas para região norte.
-* estadosDoNordeste()
-** Idem estadosDoSul, mas para região nordeste.
-
-h3. Validação (Behavior) - "Referência":http://blog.cakephp-brasil.org/2009/04/18/validacoes-brasileiras/
-
-Este behaviour foi descontinuado. Veja agora o "plugin oficial de internacionalização do CakePHP":http://github.com/cakephp/localized
-
-h3. Correios (Behavior) - "Referência":http://blog.cakephp-brasil.org/2009/04/21/behavior-com-metodos-dos-correios/
-
-Métodos para acessar recursos dos Correios brasileiro.
-
-h4. Instalação
-
-Adicione o behavior 'CakePtbr.Correios' no seu model através da variável actsAs. Exemplo:
-
-<pre>
-class Entrega extends AppModel {
- var $name = 'Entrega';
- var $actsAs = array('CakePtbr.Correios');
-}
-</pre>
-
-h4. Utilização
-
-h5. Cálculo de valor de frete
-
-O método para calcular o frete chama-se 'valorFrete' e tem os seguintes parâmetros:
-
-* servico: define o tipo de serviço que será feito. Os valores válidos são através das constantes: CORREIOS_SEDEX, CORREIOS_SEDEX_A_COBRAR, CORREIOS_SEDEX_10, CORREIOS_SEDEX_HOJE, CORREIOS_E_SEDEX, CORREIOS_ENCOMENDA_NORMAL, CORREIOS_PAC.
-* cepOrigem: Cep de origem no formato XXXXX-XXX.
-* cepDestino: Cep de destino no formato XXXXX-XXX.
-* peso: Peso, em quilos, do item a ser transportado. O valor deve ser um número e não deve ultrapassar 30.
-* maoPropria:(opcional. Padrão falso) Valor boleano para indicar se o transporte é com mão prórpria.
-* valorDeclarado: (opcional. Padrão 0.00) Valor do item a ser transportado.
-* avisoRecebimento: (opcional. Padrão falso) Calculo com aviso de recebimento.
-
-O retorno será negativo em caso de erro, que podem ser as constantes:
-
-* ERRO_CORREIOS_PARAMETROS_INVALIDOS: Um ou mais parâmetros com formato ou conteúdo inválido.
-* ERRO_CORREIOS_EXCESSO_PESO: Peso acima do limite (30 Kg).
-* ERRO_CORREIOS_FALHA_COMUNICACAO: Problema de comunicação com o site dos Correios.
-* ERRO_CORREIOS_CONTEUDO_INVALIDO: O conteúdo retornado pelo Correios não é o esperado.
-
-Em caso de sucesso, será retornado um array com os seguintes indices:
-
-* ufOrigem: UF da Origem
-* ufDestino: UF do Destino
-* capitalOrigem: Valor booleano indicando se a origem é considerada capital
-* capitalDestino: Valor booleando indicando se o destino é considerado capital
-* valorMaoPropria: Valor, em reais, da mão própria
-* valorTarifaValorDeclarado: Valor da tarifa pelo valor declarado
-* valorFrete: Valor apenas do frente, sem incluir os valores de mão própria e tarifa do valor declarado
-* valorTotal: Soma de todos os valores anteriores
-
-Exemplo de uso:
-
-<pre>
-class Entrega extends AppModel {
- var $name = 'Entrega';
- var $actsAs = array('CakePtbr.Correios');
-
- function frete($cepDestino) {
- // Supondo que é uma loja que transporta produtos pequenos (até 1Kg)
- return $this->valorFrete(CORREIOS_SEDEX, Configure::read('Loja.CEP'), $cepDestino, 1.0);
- }
-}
-</pre>
-
-h5. Endereço de um CEP
-
-O método 'endereco' informa o endereço baseado em algum CEP. O único parâmetro é o CEP no formato XXXXX-XXX. Os valores de retorno podem
-ser as constantes ERRO_CORREIOS_PARAMETROS_INVALIDOS, ERRO_CORREIOS_FALHA_COMUNICACAO ou ERRO_CORREIOS_CONTEUDO_INVALIDO em caso de erro.
-Em caso de sucesso, o retorno será um array com os indices logradouro, bairro, cidade e uf.
-
-Exemplo de uso:
-
-<pre>
-class Endereco extends AppModel {
- var $name = 'Endereco';
- var $actsAs = array('CakePtbr.Correios');
-
- function beforeSave($options) {
- $endereco = $this->endereco($this->data['Endereco']['CEP']);
- if ($endereco < 0) {
- return false;
- }
- $this->data['Endereco'] = array_merge($this->data['Endereco'], $endereco); // Aqui serão incluídas as informações de logradouro, bairro, cidade e uf.
- }
-}
-</pre>
-
-h3. AjusteData (Behavior)
-
-Behavior para ajustar as horas no formato dd/mm/yyyy para o formato SQL (yyyy-mm-dd).
-
-h4. Instalação
-
-Adicione o behavior 'CakePtbr.AjusteData' no seu model através da variável actsAs, porém neste behavior tem uma diferença em relação aos demais.
-É possível adicionar o behavior de três maneiras:
-
-* Não informando os campos: Neste caso, o behavior buscará automaticamente todos os campos do tipo date no model, exceto os campos update,
-create e modified;
-* Informando como string: Será considerado apenas o campo da string;
-* Informando um array: Cada item do array será considerado um campo para alteração do formato.
-
- Exemplo:
-
-<pre>
-class Noticia extends AppModel {
- var $name = 'Noticia';
- var $actsAs = array('CakePtbr.AjusteData'); // Primeiro caso
- var $actsAs = array('CakePtbr.AjusteData' => 'campo_data'); // Segundo caso
- var $actsAs = array('CakePtbr.AjusteData' => array('publicado', 'informado')); // Terceiro caso
-}
-</pre>
-
-h4. Utilização
-
-A utilização é automática.
-
-h4. Funcionamento
-
-Na sua view, o usuário vai preencher um campo com o formato dd/mm/yyyy, porém este campo deve ser alterado para ser cadastrado no banco
-de dados. Para evitar que isto seja no controller ou num beforeSave de vários models, basta incluir este behavior.
-
-Antes de cada save o behavior ajusta as datas dos campos informados (ou encontrados automaticamente) e então envia para o banco de dados
-com os valores corretos.
-
-Ao resgatar o registro do banco, este behavior NÃO transforma para o formato brasileiro, pois o model manipula dados e não formatações.
-Caso você vá exibir a data, use o helper de formatação deste plugin.
-
-h3. AjusteFloat (Behavior)
-
-Behavior para ajustar os números floats no formato 1.200,10 para o formato SQL (1200.10).
-
-h4. Instalação
-
-Adicione o behavior 'CakePtbr.AjusteFloat' no seu model através da variável actsAs.
-
- Exemplo:
-
-<pre>
-class Produto extends AppModel {
- var $name = 'Produto';
- var $actsAs = array('CakePtbr.AjusteFloat');
-}
-</pre>
-
-h4. Utilização
-
-A utilização é automática.
-
-h3. Formatação (Helper) - "Referência":http://blog.cakephp-brasil.org/2009/04/22/formatacao-no-estilo-brasileiro/
-
-Helper para formatação de datas e números no formato brasileiro.
-
-h4. Instalação
-
-Adicione o helper 'CakePtbr.Formatacao' no seu controller através da variável helpers. Exemplo:
-
-<pre>
-class PedidosControllers extends AppController {
- var $name = 'Pedidos';
- var $helpers = array('CakePtbr.Formatacao');
-
- function index() {
- // Qualquer código...
- }
-}
-</pre>
-
-h4. Utilização
-
-Abaixo segue a lista dos métodos existentes no helper, com os parâmetros esperados e uma breve descrição.
-
-* data($data = null)
-** Formata uma data timestamp no formato dd/mm/YYYY. Se não for informada a data, será utilizada a data atual
-* dataHora($dataHora = null, $segundos = true)
-** Idem anterior, porém com a informação da hora junto.
-* dataCompleta($dataHora = null)
-** Mostra a data completa. Exemplo: ‘terça-feira, 21 de abril de 2009, 10:00:00′.
-* precisao($numero, $casasDecimais = 3)
-** Similar ao método precision do helper Time, mostrando os números no formato brasileiro.
-* porcentagem($numero, $casasDecimais = 2)
-** Mostra o valor em porcentos, similar ao toPorcentage do TimeHelper.
-* moeda($valor, $opcoes = array())
-** Mostra o valor em reais. Exemplo: R$ 10,20.
-* moedaPorExtenso($numero)
-** Escreve o valor por extenso, em reais.
-
-h3. Estados (Helper)
-
-Helper para apresentar os estados brasileiros.
-
-h4. Instalação
-
-Adicione o helper 'CakePtbr.Estados' no seu controller através da variável helpers. Exemplo:
-
-<pre>
-class PedidosControllers extends AppController {
- var $name = 'Pedidos';
- var $helpers = array('CakePtbr.Estados');
-
- function index() {
- // Qualquer código...
- }
-}
-</pre>
-
-h4. Utilização
-
-Na sua view, utilizar da forma similar ao método select do helper Form, exceto pelo parâmetro options. Exemplo:
-
-<pre>
-echo $estados->select('Model.uf'); // Exibirá um select com todos os estados
-echo $estados->select('Model.uf', 'SC'); // Exibirá um select com todos os estados, deixando Santa Catarina como selecionada
-echo $estados->select('Model.uf', null, array('uf' => true)); // Exibirá o select. O valor que irá aparecer serão apenas as siglas
-</pre>
-
-Em todos os casos anteriores, o valor do campo será a sigla (2 caracteres). Vale lembrar que é possível
-utilizar todos os mesmos parâmetros do "select do form":http://book.cakephp.org/pt/view/728/select , exceto o campo @$options@, que foi
-suprimido. Além disso, o valor padrão de @$showEmpty@ agora é @false@ ao invés de @''@ (ou seja, não irá apresentar campo vazio).
-
-h3. Templates para o bake
-
-Gerar os models, controllers e views traduzidas no bake.
-
-h4. Instalação
-
-Não é necessário fazer nada. O bake identifica automaticamente o template.
-
-h4. Utilização
-
-Basta usar o bake normalmente.
+Se você usa o Ohloh, diga que usa o projeto: http://www.ohloh.net/p/cake_ptbr

0 comments on commit 42f0aa8

Please sign in to comment.