brFormExtraPlugin
1.0.5stable
for sf 1.4sf 1.3sf 1.2 and Doctrine
LGPL
brFormExtraPlugin
Widgets e validadores para Comunidade Brasileira do Symfony.
Widgets and validators to symfony Brazilian Community.
- sfWidgetFormChoiceUFBR
- sfWidgetFormSelectCheckboxStates
- sfWidgetFormInputCep
- sfWidgetFormI18nNumber
- sfValidatorCpfCnpj
- sfValidatorChoiceStates
- sfValidatori18nDate
- sfValidatorI18nNumber
Developers
License
http://www.gnu.org/licenses/lgpl-3.0.txt
GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
This version of the GNU Lesser General Public License incorporates
the terms and conditions of version 3 of the GNU General Public
License, supplemented by the additional permissions listed below.
0. Additional Definitions.
As used herein, "this License" refers to version 3 of the GNU Lesser
General Public License, and the "GNU GPL" refers to version 3 of the GNU
General Public License.
"The Library" refers to a covered work governed by this License,
other than an Application or a Combined Work as defined below.
An "Application" is any work that makes use of an interface provided
by the Library, but which is not otherwise based on the Library.
Defining a subclass of a class defined by the Library is deemed a mode
of using an interface provided by the Library.
A "Combined Work" is a work produced by combining or linking an
Application with the Library. The particular version of the Library
with which the Combined Work was made is also called the "Linked
Version".
The "Minimal Corresponding Source" for a Combined Work means the
Corresponding Source for the Combined Work, excluding any source code
for portions of the Combined Work that, considered in isolation, are
based on the Application, and not on the Linked Version.
The "Corresponding Application Code" for a Combined Work means the
object code and/or source code for the Application, including any data
and utility programs needed for reproducing the Combined Work from the
Application, but excluding the System Libraries of the Combined Work.
1. Exception to Section 3 of the GNU GPL.
You may convey a covered work under sections 3 and 4 of this License
without being bound by section 3 of the GNU GPL.
2. Conveying Modified Versions.
If you modify a copy of the Library, and, in your modifications, a
facility refers to a function or data to be supplied by an Application
that uses the facility (other than as an argument passed when the
facility is invoked), then you may convey a copy of the modified
version:
a) under this License, provided that you make a good faith effort to
ensure that, in the event an Application does not supply the
function or data, the facility still operates, and performs
whatever part of its purpose remains meaningful, or
b) under the GNU GPL, with none of the additional permissions of
this License applicable to that copy.
3. Object Code Incorporating Material from Library Header Files.
The object code form of an Application may incorporate material from
a header file that is part of the Library. You may convey such object
code under terms of your choice, provided that, if the incorporated
material is not limited to numerical parameters, data structure
layouts and accessors, or small macros, inline functions and templates
(ten or fewer lines in length), you do both of the following:
a) Give prominent notice with each copy of the object code that the
Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the object code with a copy of the GNU GPL and this license
document.
4. Combined Works.
You may convey a Combined Work under terms of your choice that,
taken together, effectively do not restrict modification of the
portions of the Library contained in the Combined Work and reverse
engineering for debugging such modifications, if you also do each of
the following:
a) Give prominent notice with each copy of the Combined Work that
the Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the Combined Work with a copy of the GNU GPL and this license
document.
c) For a Combined Work that displays copyright notices during
execution, include the copyright notice for the Library among
these notices, as well as a reference directing the user to the
copies of the GNU GPL and this license document.
d) Do one of the following:
0) Convey the Minimal Corresponding Source under the terms of this
License, and the Corresponding Application Code in a form
suitable for, and under terms that permit, the user to
recombine or relink the Application with a modified version of
the Linked Version to produce a modified Combined Work, in the
manner specified by section 6 of the GNU GPL for conveying
Corresponding Source.
1) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (a) uses at run time
a copy of the Library already present on the user's computer
system, and (b) will operate properly with a modified version
of the Library that is interface-compatible with the Linked
Version.
e) Provide Installation Information, but only if you would otherwise
be required to provide such information under section 6 of the
GNU GPL, and only to the extent that such information is
necessary to install and execute a modified version of the
Combined Work produced by recombining or relinking the
Application with a modified version of the Linked Version. (If
you use option 4d0, the Installation Information must accompany
the Minimal Corresponding Source and Corresponding Application
Code. If you use option 4d1, you must provide the Installation
Information in the manner specified by section 6 of the GNU GPL
for conveying Corresponding Source.)
5. Combined Libraries.
You may place library facilities that are a work based on the
Library side by side in a single library together with other library
facilities that are not Applications and are not covered by this
License, and convey such a combined library under terms of your
choice, if you do both of the following:
a) Accompany the combined library with a copy of the same work based
on the Library, uncombined with any other library facilities,
conveyed under the terms of this License.
b) Give prominent notice with the combined library that part of it
is a work based on the Library, and explaining where to find the
accompanying uncombined form of the same work.
6. Revised Versions of the GNU Lesser General Public License.
The Free Software Foundation may publish revised and/or new versions
of the GNU Lesser General Public License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the
Library as you received it specifies that a certain numbered version
of the GNU Lesser General Public License "or any later version"
applies to it, you have the option of following the terms and
conditions either of that published version or of any later version
published by the Free Software Foundation. If the Library as you
received it does not specify a version number of the GNU Lesser
General Public License, you may choose any version of the GNU Lesser
General Public License ever published by the Free Software Foundation.
If the Library as you received it specifies that a proxy can decide
whether future versions of the GNU Lesser General Public License shall
apply, that proxy's public statement of acceptance of any version is
permanent authorization for you to choose that version for the
Library.
brFormExtraPlugin
Widgets e validadores para comunidade brasileira do symfony.
Online DEMO: http://symfony.rgou.net/br_form_extra_demo ou http://rgou.net/symfony/br_form_extra_demo.
Requisitos
O Widget sfWidgetFormInputCep necessita do jQuery 1.4.2 ou superior (não funciona com 1.3.2).
Uma boa forma de obtê-lo é instalar o plugin :
php symfony plugin:install sfJqueryReloadedPlugin
E configurar no apps/SUA_APLICACAO/config/settings.yml:
all:
.settings:
jquery_core: jquery-1.4.2.min.js
Instalação
Para instalar o plugin num projeto symfony, utilize a linha de comando usual do symfony:
php symfony plugin:install brFormExtraPlugin
E está feito.
Alternativamente, se você não tem o PEAR instalado, pode baixar o último pacote anexado à pagina wiki deste plugin e extraÃ-lo no diretório de plugins do projeto.
Neste caso, ative o plugin em seu ProjectConfiguration.class.php.
class ProjectConfiguration extends sfProjectConfiguration
{
public function setup()
{
$this->enablePlugins(..., 'brFormExtraPlugin', ...);
Limpe o cache para habilitar ao autoloading encontrar as classes:
php symfony cc
E, por último, publique os assets.
php symfony plugin:publish-assets
Cep Brasil
É preciso habilitar o módulo que recebe as requisições AJAX editando o arquivo apps/SUA_APLICACAO/config/settings.yml e
acrescentando a enabled_modules
all:
.settings:
enabled_modules: [default, ( ... ), br_cep]
Utilizando brFormExtraPlugin
sfWidgetFormChoiceUFBR , sfValidatorChoiceStates
- sfWidgetFormChoiceUFBR:
Renderiza um SELECT com lista de estados (UFs - Unidades da Federação) brasileiros
- sfValidatorChoiceStates:
Valida lista de estados (UFs - Unidades da Federação) brasileiros
Exemplo 1
<?php
$form->setWidget("uf1", new sfWidgetFormChoiceUFBR(array("add_empty"=>"Escolha UF")));
$form->getWidgetSchema()->setLabel("uf1", "Estado (UF)");
$form->setValidator("uf1", new sfValidatorChoiceStates());
?>
<p>
<?php echo $form["uf1"]->renderError() ?>
<?php echo $form["uf1"]->renderLabel() ?>
<?php echo $form["uf1"] ?>
</p>
Exemplo 2
<?php
$form->setWidget("uf2", new sfWidgetFormChoiceUFBR());
$form->getWidgetSchema()->setLabel("uf2", "Estado (UF)");
$form->setValidator("uf2", new sfValidatorChoiceStates());
?>
<p>
<?php echo $form["uf2"]->renderError() ?>
<?php echo $form["uf2"]->renderLabel() ?>
<?php echo $form["uf2"] ?>
</p>
Opções
- add_empty:
Whether to add a first empty value or not (false by default)
If the option is not a Boolean, the value will be used as the text value
- multiple:
true if the select tag must allow multiple selections
- expanded:
true to display an expanded widget
if expanded is false, then the widget will be a select
if expanded is true and multiple is false, then the widget will be a list of radio
if expanded is true and multiple is true, then the widget will be a list of checkbox
- renderer_class:
The class to use instead of the default ones
- renderer_options:
The options to pass to the renderer constructor
- renderer:
A renderer widget (overrides the expanded and renderer_options options)
The choices option must be: new sfCallable($thisWidgetInstance, "getChoices"")
sfWidgetFormSelectCheckboxStates , sfValidatorChoiceStates
- sfWidgetFormSelectCheckboxStates:
Renderiza checkboxes com lista de estados (UFs - Unidades da Federação) brasileiros,
agrupados por região e permitindo selecionar por região e todos
Exemplo
<?php
$form->setWidget("uf_checkbox", new sfWidgetFormSelectCheckboxStates());
$form->getWidgetSchema()->setLabel("uf_checkbox", "Estados (UF)");
$form->setValidator("uf_checkbox", new sfValidatorChoiceStates(array("min"=>5, "max"=>10)));
?>
<p>
<?php echo $form["uf_checkbox"]->renderError() ?>
<?php echo $form["uf_checkbox"]->renderLabel() ?>
<?php echo $form["uf_checkbox"] ?>
</p>
Opções
- label_separator:
The separator to use between the input checkbox and the label
- class:
The class to use for the main
<
ul> tag
- separator:
The separator to use between each input checkbox
- formatter:
A callable to call to format the checkbox choices
The formatter callable receives the widget and the array of inputs as arguments
- template:
The template to use when grouping option in groups (%group% %options%)
Dica: o melhor é configurar no arquivo YAML.
plugins/brFormExtraPlugin/config/state.yml
# a label or false
all_checkbox: "Todo o Brasil"
separator: ";"
regions:
norte:
label: "Região Norte"
states:
AC: Acre
AP: Amapá
AM: Amazonas
PA: Pará
RO: Rondônia
RR: Roraima
TO: Tocantins
nordeste:
label: "Região Nordeste"
states:
AL: Alagoas
BA: Bahia
CE: Ceará
MA: Maranhão
PB: ParaÃba
PE: Pernambuco
PI: PiauÃ
RN: Rio Grande do Norte
SE: Sergipe
centrooeste:
label: "Região Centro-Oeste"
states:
DF: Distrito Federal
GO: Goiás
MG: Mato Grosso
MS: Mato Grosso do Sul
sudeste:
label: "Região Sudeste"
states:
ES: EspÃrito Santo
MG: Minas Gerais
RJ: Rio de Janeiro
SP: São Paulo
sul:
label: "Região Sul"
states:
PR: Paraná
RS: Rio Grande do Sul
SC: Santa Catarina
Usando em conjunto com ORM - Propel e Doctrine
Para que o widget possa trabalhar adequadamente com o ORN, deve receber os valores em forma de array.
Da mesma forma, o armazenamento é em apenas um campo VARCHAR. Considerando que são
27 estados + DF, 2 caracteres cada mais o separador, o máximo do campo é de 80 caracteres
Propel
# config/schema.yml
cadastro:
uf: { phpName: Uf, type: VARCHAR, size: '80' }
// (...)
// Seu model, como lib/model/Cadastro.php
public function getUf()
{
return sfWidgetFormSelectCheckboxStates::getExplodedValue($this->uf);
}
public function setUf($v)
{
parent::setUf(sfWidgetFormSelectCheckboxStates::getImplodedValue($v));
}
// (...)
Doctrine
# config/doctrine/schema.yml
Cadastro:
columns:
uf: { type: string(100) }
// (...)
// Seu model, como lib/model/doctrine/Cadastro.php
public function getUf()
{
return sfWidgetFormSelectCheckboxStates::getExplodedValue($this->_get('uf'));
}
public function setUf($v)
{
parent::_set('uf',sfWidgetFormSelectCheckboxStates::getImplodedValue($v));
}
// (...)
sfValidatorCpfCnpj
Valida uma entrada em formato de CPF ou CNPJ. Permite retorna o valor sem formatação (padrão)
ou formatado (formated=>true) para armazenamento em banco de dados.
Exemplo CPF
<?php
$form->setWidget("cpf", new sfWidgetFormInputText());
$form->getWidgetSchema()->setLabel("cpf", "CPF");
$form->setValidator("cpf", new sfValidatorCpfCnpj(array("type"=>"cpf")));
?>
<p>
<?php echo $form["cpf"]->renderError() ?>
<?php echo $form["cpf"]->renderLabel() ?>
<?php echo $form["cpf"] ?>
</p>
Exemplo CNPJ
<?php
$form->setWidget("cnpj", new sfWidgetFormInputText());
$form->getWidgetSchema()->setLabel("cnpj", "CNPJ");
$form->setValidator("cnpj", new sfValidatorCpfCnpj(array("type"=>"cnpj")));
?>
<p>
<?php echo $form["cnpj"]->renderError() ?>
<?php echo $form["cnpj"]->renderLabel() ?>
<?php echo $form["cnpj"] ?>
</p>
Exemplo CPF/CNPJ
<?php
$form->setWidget("cpfcnpj", new sfWidgetFormInputText());
$form->getWidgetSchema()->setLabel("cpfcnpj", "CPF/CNPJ");
$form->setValidator("cpfcnpj", new sfValidatorCpfCnpj(array("type"=>"cpfcnpj")));
?>
<p>
<?php echo $form["cpfcnpj"]->renderError() ?>
<?php echo $form["cpfcnpj"]->renderLabel() ?>
<?php echo $form["cpfcnpj"] ?>
</p>
Opções
- type:
Type of validation (cpfcnpj, cpf, cnpj - default: cpfcnpj)
- formated:
If true "clean" method returns a formated value, i.e. 000.000.000-00 (default: false)
Use to store formated value in DB
sfWidgetFormI18nNumber, sfValidatorI18nNumber
Widget e validador para número com casas decimais no padrão do idioma do usuário.
Utiliza o sfContext para recuperar a "culture" do "user".
Importados do plugin http://www.symfony-project.org/plugins/sfFormI18nNumberPlugin
É necessário definir o idioma (culture) do usuário para a desejada. A forma mais simples é editar o
arquivo apps/SUA_APLICACAO/config/settings.yml e acrescentar:
all:
.settings:
i18n: true
default_culture: pt_BR
Exemplo
<?php
$form->setWidget("numero_i18n", new sfWidgetFormI18nNumber());
$form->getWidgetSchema()->setLabel("numero_i18n", "Data i18n");
$form->setValidator("numero_i18n", new sfValidatorI18nNumber());
?>
<p>
<?php echo $form["numero_i18n"]->renderError() ?>
<?php echo $form["numero_i18n"]->renderLabel() ?>
<?php echo $form["numero_i18n"] ?>
</p>
Opções
sfValidatori18nDate
Valida uma data enviada por um input text contra o padrão do idioma do usuário.
Utiliza o sfContext para recuperar a "culture" do "user".
Este validador foi copiado de: (http://trac.symfony-project.org/attachment/ticket/6256/sfValidatorL10nDate.class.php),
enviado por logistiker. Realizei apenas ajustes cosméticos, como mudança do nome.
É necessário definir o idioma (culture) do usuário para a desejada. A forma mais simples é editar o
arquivo apps/SUA_APLICACAO/config/settings.yml e acrescentar:
all:
.settings:
i18n: true
default_culture: pt_BR
Exemplo
<?php
$form->setWidget("data_i18n", new sfWidgetFormInputText());
$form->getWidgetSchema()->setLabel("data_i18n", "Data i18n");
$form->setValidator("data_i18n", new sfValidatori18nDate());
?>
<p>
<?php echo $form["data_i18n"]->renderError() ?>
<?php echo $form["data_i18n"]->renderLabel() ?>
<?php echo $form["data_i18n"] ?>
</p>
Opções
As opções são as mesmas da classe pai, sfValidatorDate, acrescidas do "context" - que
não precisa ser enviado, é recuperado automaticamente se não informado.
- date_format:
A regular expression that dates must match
- with_time:
true if the validator must return a time, false otherwise
- date_output:
The format to use when returning a date (default to Y-m-d)
- datetime_output:
The format to use when returning a date with time (default to Y-m-d H:i:s)
- date_format_error:
The date format to use when displaying an error for a bad_format error
(use date_format if not provided)
- max:
The maximum date allowed (as a timestamp)
- min:
The minimum date allowed (as a timestamp)
- date_format_range_error:
The date format to use when displaying an error for min/max (default to d/m/Y H:i:s)
- context:
The symfony application context
*
Códigos de erro
sfWidgetFormInputCep , sfValidatorCep
- sfWidgetFormInputCep:
Input com busca de CEP
- sfValidatorCep:
Valida CEP remotamente
Utiliza ou o serviço do site CEPLivre (http://republicavirtual.com.br/cep/ - aparentemente mais atualizado)
ou do site Republica Virtual (http://ceplivre.pc2consultoria.com/index.php).
Exemplo
<?php
$fields_for_cep = array(
"logradouro" => "demo_logradouro",
"bairro" => "demo_bairro",
"cidade" => "demo_cidade",
"uf" => "demo_uf_cep",
"cep" => "demo_cep",
"codigo_ibge" => "demo_codibge",
);
$this->form->setWidget("cep", new sfWidgetFormInputCep( array("fields" => $fields_for_cep) ));
$this->form->getWidgetSchema()->setLabel("cep", "CEP");
$form->setValidator("cep", new sfValidatorCep());
$this->form->setWidget("logradouro", new sfWidgetFormInput());
$this->form->getWidgetSchema()->setLabel("logradouro", "Logradouro");
$form->setValidator("logradouro", new sfValidatorString());
$this->form->setWidget("bairro", new sfWidgetFormInput());
$this->form->getWidgetSchema()->setLabel("bairro", "Bairro");
$form->setValidator("bairro", new sfValidatorString());
$this->form->setWidget("cidade", new sfWidgetFormInput());
$this->form->getWidgetSchema()->setLabel("cidade", "Cidade");
$form->setValidator("cidade", new sfValidatorString());
$this->form->setWidget("uf_cep", new sfWidgetFormChoiceUFBR());
$this->form->getWidgetSchema()->setLabel("uf_cep", "UF");
$form->setValidator("uf_cep", new sfValidatorString());
$this->form->setWidget("codibge", new sfWidgetFormInput());
$this->form->getWidgetSchema()->setLabel("codibge", "Código IBGE");
$form->setValidator("codibge", new sfValidatorString());
?>
<p>
<?php echo $form["cep"]->renderError() ?>
<?php echo $form["cep"]->renderLabel() ?>
<?php echo $form["cep"] ?>
<br/>
<?php echo $form["logradouro"]->renderError() ?>
<?php echo $form["logradouro"]->renderLabel() ?>
<?php echo $form["logradouro"] ?>
<br/>
<?php echo $form["bairro"]->renderError() ?>
<?php echo $form["bairro"]->renderLabel() ?>
<?php echo $form["bairro"] ?>
<br/>
<?php echo $form["cidade"]->renderError() ?>
<?php echo $form["cidade"]->renderLabel() ?>
<?php echo $form["cidade"] ?>
<br/>
<?php echo $form["uf_cep"]->renderError() ?>
<?php echo $form["uf_cep"]->renderLabel() ?>
<?php echo $form["uf_cep"] ?>
<br/>
<?php echo $form["codibge"]->renderError() ?>
<?php echo $form["codibge"]->renderLabel() ?>
<?php echo $form["codibge"] ?>
</p>
Opções
- fields
Fields to feed with the response
plugins/brFormExtraPlugin/config/state.yml
all:
br_cep:
# Buscar na base local (Cep Brasil importado)
# Utilizar format: republicavirtual
local_search: false
# Array com lista de IPs que podem acessar remotamente
# ou false para acesso público
# Exemplo
#client_ips: ['200.217.64.146', '200.217.64.147']
client_ips: false
# Fonte: http://ceplivre.pc2consultoria.com
# -----------------------------------------
format: ceplivre
remote_url: 'http://ceplivre.pc2consultoria.com/index.php'
remote_query: 'module=cep&formato=xml&cep='
# Do not change remote_fields to http://rceplivre.pc2consultoria.com
remote_fields:
resultado: sucesso
tipo_logradouro: tipo_logradouro
logradouro: logradouro
uf: estado_sigla
uf_descricao: estado
cidade: cidade
bairro: bairro
cep: cep
codigo_ibge: codigo_ibge
form_fields:
logradouro: logradouro
estado_sigla: uf
cidade: cidade
bairro: bairro
cep: cep
codigo_ibge: codibge
# Fonte: http://republicavirtual.com.br
# -------------------------------------
# format: republicavirtual
# remote_url: 'http://republicavirtual.com.br/web_cep.php'
# remote_query: 'formato=json&cep='
#
# # Do not change remote_fields to http://rceplivre.pc2consultoria.com
# remote_fields:
# resultado: resultado
# uf: uf
# cidade: cidade
# bairro: bairro
# tipo_logradouro: tipo_logradouro
# logradouro: logradouro
# cep: cep
# form_fields:
# uf: uf
# cidade: cidade
# bairro: bairro
# tipo_logradouro: tipo_logradouro
# logradouro: logradouro
# cep: cep
Usando base local
Para utilizar uma base local, baixe o atualizado do República Virtual,
renomeie o arquivo plugins/brFormExtraPlugin/config/doctrine/schema_cep.yml.tmpl
para plugins/brFormExtraPlugin/config/doctrine/schema_cep.yml
mv plugins/brFormExtraPlugin/config/doctrine/schema_cep.yml.tmpl \
plugins/brFormExtraPlugin/config/doctrine/schema_cep.yml
Baixe e crie a tabela do CEP Brazil
wget http://www.republicavirtual.com.br/cep/download/cep.sql.bz2
bunzip cep.sql.bz2
mysql BANCO -u USUARIO -p < cep.sql
mysql BANCO -u USUARIO -p
O último comando é para acessar o banco. Crie o campo ID como autoincrement na tabela.
mysql> ALTER TABLE `CEP_Brazil` ADD `id` INT( 8 ) NOT NULL AUTO_INCREMENT PRIMARY KEY FIRST ;
E configure no seu apps/SUA_APLICACAO/config/app.yml
all:
br_cep:
local_search: true
client_ips: false # Caso queira limitar o acesso, um array com os IPS permitidos
# format: não é necessário
# remote_url: não é necessário
# remote_query: não é necessário
remote_fields:
resultado: resultado
uf: uf
cidade: cidade
bairro: bairro
tipo_logradouro: tipo_logradouro
logradouro: logradouro
cep: cep
form_fields:
uf: uf
cidade: cidade
bairro: bairro
tipo_logradouro: tipo_logradouro
logradouro: logradouro
cep: cep
Configurando um servidor de CEP para suas aplicações
Uma vez instalado o servidor local como acima, basta, nas aplicações,
instalar o brFormExtraPlugin e configurar o remote_url:
all:
br_cep:
local_search: false
client_ips: false
format: republicavirtual
remote_url: 'http://meuservidorlocal.com.br/br_cep/buscar/'
remote_query: 'cep='
remote_fields:
resultado: resultado
uf: uf
cidade: cidade
bairro: bairro
tipo_logradouro: tipo_logradouro
logradouro: logradouro
cep: cep
form_fields:
uf: uf
cidade: cidade
bairro: bairro
tipo_logradouro: tipo_logradouro
logradouro: logradouro
cep: cep
Evidentemente, é preciso limpar o cache.
php symfony clear:cache
Demonstração
Habilite a demonstração editando o arquivo apps/SUA_APLICACAO/config/settings.yml e
acrescentando a enabled_modules
all:
.settings:
enabled_modules: [default, ( ... ), br_form_extra_demo]
Rafael Goulart 