Drupal: Convenções de nomenclatura

O uso de padrões de escrita e nomenclatura no desenvolvimento de sistemas é algo primordial quando queremos melhorar a qualidade dos nossos códigos. Trago alguns exemplos para ser usado na plataforma Drupal.

  • Classes: UpperCamelCase
  • Métodos: lowerCamelCase
  • Propriedades: lowerCamelCase
  • Funções: snake_case
  • Variáveis: snake_case

É comum na utilização do Drupal CMS a criação de tipos de conteúdo personalizado (CT), e quando usamos este fantástico recurso do CMS, precisamos adicionar campos (fields) dentro deste CT.

Vamos criar um CT de filmes, e alguns exemplos de fields seria:

  • Título: Texto
  • Sinopse: Texto (formatado, longo)
  • Capa: Imagem
  • Elenco: Referência

O Drupal guarda esse tipo de informação com um nome de máquina (machine name), este deve ser único no sistema. Como estes fields poderão ser referenciados em outros lugares, é de grande importância para o desenvolvedor saber de qual CT aquele field pertence. Então colocamos os seguintes machine names em nossos fileds:

  • Título: field_filmes_titulo_texto
  • Sinopse: field_filmes_sinopse_texto
  • Capa: field_filmes_capa_imagem
  • Elenco: field_filmes_elenco_referencia

Colocar o tipo de dado que o field contém também é uma dica bem útil.

Deixe uma resposta

O seu endereço de e-mail não será publicado. Campos obrigatórios são marcados com *