Annotations

Annotations - Mapeamento objeto-relacional

A API funciona de uma maneira bem simples, primeiramente você deve criar seus objetos de modelo de dados inserindo acima da declaração de classe o nome da tabela a qual esse objeto vai representar e acima de suas propriedades a correspondente coluna da tabela no banco de dados.

Para isso você deve iniciar um bloco de comentário e entre as marcações adicionar @Table, @Id ou @Collumn conforme o caso.

Por exemplo:

/** @Table(name='foo_in_db') */
class Foo{
    /** @Id(name='ident') */
    private $id;
    /** @Collumn(name='name_of_foo',type='A',notnull='true') */
    private $name;

    public function getId() {
        return $this->id;
    }

    public function setId($id) {
        $this->id = $id;
    }

    public function getName() {
        return $this->name;
    }

    public function setName($name) {
        $this->name = $name;
    }


}

No código acima aparecem anotações precedidos pelo "@" nos comentários imediatamente acima de atributos e nome da classe. Estas anotações indicam por meio de atributos ou mesmo o próprio nome, que atributos estão vinculados a que colunas.

Anotação	Atributo
@Table - Indica que esta classe esta mapeada	"name" - O nome corespondente a tabela que este objeto mapeia
@Id - Indica que este atributo é uma chave no banco de dados	"name" - O nome corespondente a coluna da chave
@Collumn - Indica que determinada propriedade(atributo) esta mapeada	"name" - Nome correspondente na tabela(coluna) , "type" - Tipo que pode ser 'A' (Alfanumérico) ou 'N' (Numérico) , 'notnull' - Valor booleano que vai ser usado mais tarde para reconstruir a estrutura da tabela a partir do modelo de dados

Além de anotar seus campos corretamente é necessário que os métodos de acesso (gets e sets) sejam devidamente criados, conforme no exemplo acima.

Esta API utiliza uma biblioteca chamada ADDENDUM. Para mais informações acesse a wiki do projeto addendum(em inglês).