Previous Next

Estilo de Código

Demarcação de Código PHP

Código PHP deve sempre estar delimitado de forma completa, com tags padrão do PHP:

Tags curtas não são permitidas.

Strings

String Literal

Quando uma string é literal (não contém substituições de variável), deve ser usado apóstrofo ou aspas simples para demarcar o texto.

$a = 'Exemplo de Texto';

String Literal Contendo Apóstrofos

Quando uma string literal contém apóstrofos dentro de si, é permitido demarcar o texto com aspas ou "aspas duplas". Isto é especialmente encorajado para declarações SQL:

$sql = "SELECT `id`, `name` from `people` WHERE `name`='Fred' OR `name`='Susan'";
A sintaxe acima é preferida ao invés de escapar os apóstrofos.

Substituição de Variáveis

A substituição de variáveis é permitida usando qualquer uma das duas formas:

$greeting = "Olá $nome, bem-vindo de volta!";

$greeting = "Olá {$nome}, bem-vindo de volta!";

Por consistência, a forma a seguir não é permitida:

$greeting = "Olá ${nome}, bem-vindo de volta!";

Concatenação de String

Strings devem ser concatenadas usando o operador ".". Um espaço deve sempre ser adicionado antes e depois do operador "." para melhorar a legibilidade:

$company = 'Zend' . 'Technologies';

Quando estiver concatenando strings com o operador ".", é permitido quebrar a declaração em várias linhas para melhorar a legibilidade. Nestes casos, cada linha sucessiva deverá ser colocada num bloco com espaço em branco de forma que o operador "." esteja alinhado abaixo do operador "=":

$sql = "SELECT `id`, `name` FROM `people` "
     . "WHERE `name` = 'Susan' "
     . "ORDER BY `name` ASC ";

Arrays

Arrays Indexados Numericamente

Números negativos não são permitidos como índices.

Um array indexado pode começar com qualquer número não negativo, porém isto é desencorajado. É recomendado que todo array tenha um índice inicial 0.

Quando declarar arrays indexados com o construtor array, um espaço deve ser adicionado depois de cada vírgula para melhorar a legibilidade:

$sampleArray = array(1, 2, 3, 'Zend', 'Studio');

Também é permitido declarar arrays indexados em várias linhas usando o construtor "array". Neste caso, cada linha sucessiva deve ser colocada num bloco com espaços de forma que o início de cada código alinhe-se conforme mostrado abaixo:

$sampleArray = array(1, 2, 3, 'Zend', 'Studio',
            $a, $b, $c,
            56.44, $d, 500);

Arrays Associativos

Quando declarar arrays associativos com o construtor array, é recomendado quebrar a declaração em múltiplas linhas. Neste caso, cada linha sucessiva deve estar num bloco com espaço em branco, de forma que as chaves e valores estejam alinhados:

$sampleArray = array('firstKey'  => 'firstValue',
                     'secondKey' => 'secondValue');

Classes

Declaração de Classes

Classes devem ser nomeadas seguindo a convenção de nomes.

A chave de abertura é sempre escrita embaixo do nome da classe (forma de "uma única chave real").

Toda classe deve ter um bloco de documentação, dentro do padrão do PHPDocumentor.

Todo código dentro de uma classe deve estar indentado com quatro espaços.

Somente uma classe é permitida por arquivo PHP.

Colocar código adicional em um arquivo de classe é permitido mas desencorajado. Nestes arquivos, duas linhas em branco devem separar a classe do código PHP adicional no arquivo.

Este é um exemplo de declaração aceitável de classe :

/**
 * Bloco de documentação aqui
 */
class SampleClass
{
    // conteúdo completo da classe
    // deve estar indentado com quatro espaços
}

Variáveis Membros de Classe

Variáveis membro devem ser nomeadas de acordo com a convenção de nomes de variáveis.

Quaisquer variáveis declaradas numa classe devem ser listadas no topo da classe, antes de declarar qualquer função.

O construtor var não é permitido. Variáveis membro sempre declaram sua visibilidade usando o construtor private, protected ou public. Acessar variáveis membro diretamente tornando-as públicas é permitido mas desencorajado em favor de variáveis de acesso (set/get).

Funções e Métodos

Declaração de Funções e Métodos

Nomes de funções devem seguir a convenção de nomes.

Funções dentro de classes sempre declaram sua visibilidade usando o construtor private, protected ou public.

Como classes, a chave de abertura deve sempre ser escrita abaixo do nome da função (forma de "uma única chave real"). Não há espaços entre o nome da função e os parênteses para os argumentos.

Funções no escopo global são fortemente desencorajadas.

Este é um exemplo de declaração aceitável de função:

/**
 * Bloco de documentação aqui
 */
 class foo

    /**
    * Bloco de documentação aqui
    */
    public function bar()
    {
        // todo conteúdo da função
        // deve ser indentado com quatro espaços
    }
}

NOTA: Passar valores por referência na declaração da função é permitido somente neste caso:

/**
 * Bloco de documentação aqui
 */
 class foo

    /**
    * Bloco de documentação aqui
    */
    public function bar(&$baz)
    {
        // todo conteúdo da função
        // deve ser indentado com quatro espaços
    }
}

Passar valores por referência ao chamar a função é proibido.

O valor de retorno não deve estar entre parênteses. Isto pode impedir a boa legibilidade e pode ainda quebrar o código de um método que seja alterado posteriormente para retornar por referência.

/**
 * Documentation Block Here
 */
class Foo
{
    /**
     * ERRADO
     */
    public function bar()
    {
        return($this->bar);
    }

    /**
     * CERTO
     */
    public function bar()
    {
        return $this->bar;
    }
}

Uso de Funções e Métodos

Argumentos de funções são separados por um espaço simples depois da vírgula. Este é um exemplo de chamada de função que tenha três argumentos:

threeArguments(1, 2, 3);

Passar parâmetros por referência na chamada da função é proibido. Veja a seção de declaração de funções para o modo correto de passar argumentos por referência.

Para funções que permitem arrays nos argumentos, a chamada da função pode incluir o construtor "array" e pode ser dividido em várias linhas para melhorar a legibilidade. Nestes casos, o padrão para escrever arrays também se aplica:

threeArguments(array(1, 2, 3), 2, 3);

threeArguments(array(1, 2, 3, 'Zend', 'Studio',
                     $a, $b, $c,
                     56.44, $d, 500), 2, 3);

Instruções de Controle

If / Else / Elseif

Instruções de controle baseadas nos construtores if e elseif devem ter um espaço simples antes do parêntese de abertura da condição e um espaço simples depois do parêntese de fechamento.

Dentro das declarações condicionais entre os parênteses, operadores devem ser separados por espaços para legibilidade. Parênteses internos são encorajados para melhorar o agrupamento lógico de condicionais extensas.

A chave de abertura é sempre escrita na mesma linha da instrução condicional. A chave de fechamento é sempre escrita em sua própria linha. Qualquer conteúdo dentro das chaves deve ser indentado por quatro espaços.

if ($a != 2) {
    $a = 2;
}

Para instruções "if" que incluem "elseif" ou "else", a formatação deve ser como nos exemplos:

if ($a != 2) {
    $a = 2;
} else {
    $a = 7;
}


if ($a != 2) {
    $a = 2;
} elseif ($a == 3) {
    $a = 4;
} else {
    $a = 7;
}
O PHP permite, em certas circunstâncias, que as instruções sejam escritas sem as chaves. O padrão de código não as diferencia, pois todas instruções "if", "elseif" ou "else" devem utilizar as chaves.

O uso do construtor "elseif" é permitido mas altamente desencorajado em favor da combinação "else if".

Switch

Instruções de controle escritas com o construtor "switch" devem ter um espaço simples antes do parêntese de abertura da instrução condicional e um espaço simples depois do parêntese de fechamento.

Todo conteúdo da instrução "switch" deve ser indentado com quatro espaços. O conteúdo abaixo de cada instrução "case" deve ser indentado com quatro espaços adicionais.

switch ($numPeople) {
    case 1:
        break;

    case 2:
        break;

    default:
        break;
}

O construtor default jamais pode ser omitido da instrução switch.

NOTA: Algumas vezes é útil escrever uma instrução case que entra no próximo case sem incluir um break ou return. Para distinguir aqueles cases dos bugs, qualquer instrução case onde break ou return são omitidos deve conter o comentário "// break intentionally omitted".

Documentação Inline

Formato da Documentação

Todos blocos de documentação ("dockblocks") devem ser compatíveis com o formato do phpDocumentor. A descrição do formato do phpDocumentor está além do escopo deste documento. Para maiores informações, visite: » http://phpdoc.org">

Todo código fonte escrito para o Framework Zend ou que trabalhe com o framework deve conter um bloco de documentação em nível de arquivo no topo de cada arquivo e um bloco de documentação em nível de classe imediatamente acima de cada classe. Abaixo seguem exemplos destes blocos de documentação:

Arquivos

Cada arquivo que contenha código PHP deve ter um bloco de cabeçalho no topo do arquivo que contenha, no mínimo, estas tags do phpDocumentor:

/**
 * Short description for file
 *
 * Long description for file (if any)...
 *
 * LICENSE: Some license information
 *
 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://www.zend.com/license/3_0.txt   PHP License 3.0
 * @version    $Id:$
 * @link       http://dev.zend.com/package/PackageName
 * @since      File available since Release 1.2.0
*/

Classes

Toda classe deve ter um bloco de documentação que contenha, no mínimo, as seguintes tags do phpDocumentor:

/**
 * Short description for class
 *
 * Long description for class (if any)...
 *
 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://www.zend.com/license/3_0.txt   PHP License 3.0
 * @version    Release: @package_version@
 * @link       http://dev.zend.com/package/PackageName
 * @since      Class available since Release 1.2.0
 * @deprecated Class deprecated in Release 2.0.0
 */

Funções

Toda função, incluindo métodos de objetos, deve ter um bloco de documentação que contenha, no mínimo, as seguintes tags:

  • Descrição da função

  • Todos argumentos

  • Todos os possíveis valores de retorno

Não é necessário usar a tag "@access" pois o nível de acesso é conhecido através do construtor "public", "private", ou "protected" usado para declarar a função.

Se uma função/método pode gerar uma excessão, use @throws:

@throws exceptionclass [description]

Previous Next
Introdução ao Zend Framework
Resumo
Instalação
Conhecendo o Zend Framework
Guia Rápido do Zend Framework
Zend Framework & MVC Introduction
Create Your Project
Create A Layout
Create a Model and Database Table
Create A Form
Congratulations!
Auto-carregamento no Zend Framework
Introduction
Goals and Design
Basic Autoloader Usage
Resource Autoloading
Conclusion
Plugins no Zend Framework
Introduction
Using Plugins
Conclusion
Iniciando com o Zend_Layout
Introduction
Using Zend_Layout
Zend_Layout: Conclusions
Iniciando com os Marcadores do Zend_View
Introduction
Basic Placeholder Usage
Standard Placeholders
View Placeholders: Conclusion
Entendendo e Usando os Decoradores do Zend Form
Introduction
Decorator Basics
Layering Decorators
Rendering Individual Decorators
Creating and Rendering Composite Elements
Conclusion
Iniciando com o Zend_Session, Zend_Auth, e Zend_Acl
Building Multi-User Applications With Zend Framework
Managing User Sessions In ZF
Authenticating Users in Zend Framework
Building an Authorization System in Zend Framework
Iniciando com o Zend_Search_Lucene
Zend_Search_Lucene Introduction
Lucene Index Structure
Index Opening and Creation
Indexing
Searching
Supported queries
Search result pagination
Iniciando com o Zend_Paginator
Introduction
Simple Examples
Pagination Control and ScrollingStyles
Putting it all Together
Referência do Zend Framework
Zend_Acl
Introduction
Refining Access Controls
Advanced Usage
Zend_Amf
Introdução
Zend_Amf_Server
Zend_Application
Introdução
Zend_Application Quick Start
Theory of Operation
Examples
Core Functionality
Available Resource Plugins
Zend_Auth
Introduction
Database Table Authentication
Digest Authentication
HTTP Authentication Adapter
LDAP Authentication
Open ID Authentication
Zend_Barcode
Introdução
Criação de código de barras usando a classe Zend_Barcode
Objetos Zend_Barcode
Renderizadores do Zend_Barcode
Zend_Cache
Introduction
The Theory of Caching
Zend_Cache Frontends
Zend_Cache Backends
The Cache Manager
Zend_Captcha
Introdução
Captcha Operation
CAPTCHA Adapters
Zend_CodeGenerator
Introduction
Zend_CodeGenerator Examples
Zend_CodeGenerator Reference
Zend_Config
Introdução
Teoria de Operação
Zend_Config_Ini
Zend_Config_Xml
Zend_Config_Writer
Zend_Config_Writer
Zend_Console_Getopt
Introduction
Declaring Getopt Rules
Fetching Options and Arguments
Configuring Zend_Console_Getopt
Zend_Controller
Guia de Início Rápido do Zend_Controller
O Básico de Zend_Controller
O Front Controller
The Request Object
The Standard Router
The Dispatcher
Action Controllers
Action Helpers
The Response Object
Plugins
Using a Conventional Modular Directory Structure
MVC Exceptions
Zend_Currency
Introduction to Zend_Currency
Using Zend_Currency
Options for currencies
What makes a currency?
Where is the currency?
How does the currency look like?
How much is my currency?
Calculating with currencies
Exchanging currencies
Additional informations on Zend_Currency
Zend_Date
Introduction
Theory of Operation
Basic Methods
Zend_Date API Overview
Creation of Dates
Constants for General Date Functions
Working Examples
Zend_Db
Zend_Db_Adapter
Zend_Db_Statement
Zend_Db_Profiler
Zend_Db_Select
Zend_Db_Table
Zend_Db_Table_Row
Zend_Db_Table_Rowset
Zend_Db_Table Relationships
Zend_Db_Table_Definition
Zend_Debug
Dumping Variables
Zend_Dojo
Introduction
Zend_Dojo_Data: dojo.data Envelopes
Dojo View Helpers
Dojo Form Elements and Decorators
Zend_Dojo build layer support
Zend_Dom
Introdução
Zend_Dom_Query
Zend_Exception
Usando as Exceções
Uso básico
Exceções Anteriores
Zend_Feed
Introduction
Importing Feeds
Retrieving Feeds from Web Pages
Consuming an RSS Feed
Consuming an Atom Feed
Consuming a Single Atom Entry
Modifying Feed and Entry structures
Custom Feed and Entry Classes
Zend_Feed_Reader
Zend_Feed_Writer
Zend_Feed_Pubsubhubbub
Zend_File
Zend_File_Transfer
Validators for Zend_File_Transfer
Filters for Zend_File_Transfer
Zend_Filter
Introduction
Standard Filter Classes
Filter Chains
Writing Filters
Zend_Filter_Input
Zend_Filter_Inflector
Zend_Form
Zend_Form
Zend_Form Quick Start
Creating Form Elements Using Zend_Form_Element
Creating Forms Using Zend_Form
Creating Custom Form Markup Using Zend_Form_Decorator
Standard Form Elements Shipped With Zend Framework
Standard Form Decorators Shipped With Zend Framework
Internationalization of Zend_Form
Advanced Zend_Form Usage
Zend_Gdata
Introduction
Authenticating with AuthSub
Using the Book Search Data API
Authenticating with ClientLogin
Using Google Calendar
Using Google Documents List Data API
Using Google Health
Using Google Spreadsheets
Using Google Apps Provisioning
Using Google Base
Using Picasa Web Albums
Using the YouTube Data API
Catching Gdata Exceptions
Zend_Http
Introduction
Zend_Http_Client - Advanced Usage
Zend_Http_Client - Connection Adapters
Zend_Http_Cookie and Zend_Http_CookieJar
Zend_Http_Response
Zend_InfoCard
Introduction
Zend_Json
Introdução
Uso Básico
Uso Avançado do Zend_Json
Conversão de XML para JSON
Zend_Json_Server - JSON-RPC server
Zend_Layout
Introdução
Guia Rápido Zend_Layout
Opções de Configuração Zend_Layout
Uso Avançado de Zend_Layout
Zend_Ldap
Introduction
API overview
Usage Scenarios
Tools
Object oriented access to the LDAP tree using Zend_Ldap_Node
Getting information from the LDAP server
Serializing LDAP data to and from LDIF
Zend_Loader
Loading Files and Classes Dynamically
The Autoloader
Resource Autoloaders
Loading Plugins
Zend_Locale
Introduction
Using Zend_Locale
Normalization and Localization
Working with Dates and Times
Supported locales
Zend_Log
Overview
Writers
Formatters
Filters
Using the Factory to Create a Log
Zend_Mail
Introduction
Sending via SMTP
Sending Multiple Mails per SMTP Connection
Using Different Transports
HTML E-Mail
Attachments
Adding Recipients
Controlling the MIME Boundary
Additional Headers
Character Sets
Encoding
SMTP Authentication
Securing SMTP Transport
Reading Mail Messages
Zend_Markup
Introduction
Getting Started With Zend_Markup
Zend_Markup Parsers
Zend_Markup Renderers
Zend_Measure
Introduction
Creation of Measurements
Outputting measurements
Manipulating Measurements
Types of measurements
Zend_Memory
Overview
Memory Manager
Memory Objects
Zend_Mime
Zend_Mime
Zend_Mime_Message
Zend_Mime_Part
Zend_Navigation
Introduction
Pages
Containers
Zend_Oauth
Introduction to OAuth
Zend_OpenId
Introduction
Zend_OpenId_Consumer Basics
Zend_OpenId_Provider
Zend_Paginator
Introdução
Usage
Configuração
Advanced usage
Zend_Pdf
Introdução.
Criando e Carregando documentos PDF.
Salvar mudanças no documento PDF.
Document pages.
Drawing.
Interactive Features
Informação do Documento e Metadados.
Zend_Pdf module usage example
Zend_ProgressBar
Zend_ProgressBar
Zend_Queue
Introduction
Example usage
Framework
Adapters
Customizing Zend_Queue
Stomp
Zend_Reflection
Introduction
Zend_Reflection Examples
Zend_Reflection Reference
Zend_Registry
Using the Registry
Zend_Rest
Introduction
Zend_Rest_Client
Zend_Rest_Server
Zend_Search_Lucene
Resumo
Construindo Índices
Pesquisando em um Índice
Query Language
Tipos de Consulta
Conjuntos de Caracteres
Extensibilidade
Interoperando com Java Lucene
Advanced
Best Practices
Zend_Serializer
Introduction
Zend_Serializer_Adapter
Zend_Server
Introdução
Zend_Server_Reflection
Zend_Service
Introdução
Zend_Service_Akismet
Zend_Service_Amazon
Zend_Service_Amazon_Ec2
Zend_Service_Amazon_Ec2: Instances
Zend_Service_Amazon_Ec2: Windows Instances
Zend_Service_Amazon_Ec2: Reserved Instances
Zend_Service_Amazon_Ec2: CloudWatch Monitoring
Zend_Service_Amazon_Ec2: Amazon Machine Images (AMI)
Zend_Service_Amazon_Ec2: Elastic Block Storage (EBS)
Zend_Service_Amazon_Ec2: Elastic IP Addresses
Zend_Service_Amazon_Ec2: Keypairs
Zend_Service_Amazon_Ec2: Regions and Availability Zones
Zend_Service_Amazon_Ec2: Security Groups
Zend_Service_Amazon_S3
Zend_Service_Amazon_Sqs
Zend_Service_Audioscrobbler
Zend_Service_Delicious
Zend_Service_DeveloperGarden
Zend_Service_Flickr
Zend_Service_LiveDocx
Zend_Service_Nirvanix
Zend_Service_ReCaptcha
Zend_Service_Simpy
Zend_Service_SlideShare
Zend_Service_StrikeIron
Zend_Service_StrikeIron: Bundled Services
Zend_Service_StrikeIron: Advanced Uses
Zend_Service_Technorati
Zend_Service_Twitter
Zend_Service_WindowsAzure
Zend_Service_Yahoo
Zend_Session
Introduction
Basic Usage
Advanced Usage
Global Session Management
Zend_Session_SaveHandler_DbTable
Zend_Soap
Zend_Soap_Server
Zend_Soap_Client
WSDL Accessor
AutoDiscovery
Zend_Tag
Introduction
Zend_Tag_Cloud
Zend_Test
Introdução
Zend_Test_PHPUnit
Zend_Test_PHPUnit_Db
Zend_Text
Zend_Text_Figlet
Zend_Text_Table
Zend_TimeSync
Introduction
Working with Zend_TimeSync
Zend_Tool
Using Zend_Tool On The Command Line
Extending Zend_Tool
Zend_Tool_Framework
Introduction
Using the CLI Tool
Architecture
Creating Providers to use with Zend_Tool_Framework
Shipped System Providers
Extending and Configuring Zend_Tool_Framework
Zend_Tool_Project
Introduction
Create A Project
Zend_Tool Project Providers
Zend_Tool_Project Internals
Zend_Translate
Introduction
Adapters for Zend_Translate
Using Translation Adapters
Creating source files
Additional features for translation
Plural notations for Translation
Zend_Uri
Zend_Uri
Zend_Validate
Introduction
Standard Validation Classes
Validator Chains
Writing Validators
Validation Messages
Zend_Version
Obtendo a Versão do Zend Framework
Zend_View
Introdução
Scripts Controladores
Scripts de Visualização
Assistentes de Visualização (Modificadores)
Zend_View_Abstract
Zend_Wildfire
Zend_Wildfire
Zend_XmlRpc
Introduction
Zend_XmlRpc_Client
Zend_XmlRpc_Server
ZendX_Console_Process_Unix
ZendX_Console_Process_Unix
ZendX_JQuery
Introduction
ZendX_JQuery View Helpers
ZendX_JQuery Form Elements and Decorators
Pré-requisitos do Zend Framework
Introdução
Notas de Migração do Zend Framework
Zend Framework 1.10
Zend Framework 1.9
Zend Framework 1.8
Zend Framework 1.7
Zend Framework 1.6
Zend Framework 1.5
Zend Framework 1.0
Zend Framework 0.9
Zend Framework 0.8
Zend Framework 0.6
Padrões de Codificação do Framework Zend para PHP
Visão Geral
Formato do Arquivo PHP
Convenções de Nomes
Estilo de Código
Zend Framework Documentation Standard
Overview
Documentation File Formatting
Recommendations
Recommended Project Structure for Zend Framework MVC Applications
Overview
Recommended Project Directory Structure
Module Structure
Rewrite Configuration Guide
Guia de Desempenho do Zend Framework
Introdução
Class Loading
Zend_Db Performance
Internationalization (i18n) and Localization (l10n)
View Rendering
Informações Sobre Direitos Autorais