Docs For Class model

Description

O objeto que extender esta classe deve obrigatoriamente possuir as

propriedades: * $pk com o nome do campo que armazena a chave primária do objeto

public $pk = 'PK_DA_TABELA';

São propriedades opcionais do objeto: * $strOrdCampo que define o campo de ordenação das listagens por padrão caso não solicitado. Caso esta propriedade não seja definida será utilizado o $pk.

public $strOrdCampo = 'NO_NOME_NA_TABELA';

Além destas, cada objeto pode ainda implementar suas próprias propriedades e métodos auxiliares.

abstract:

Located in /model.classe.php (line 33)

Direct descendents

Class	Description
usuario	Define um usuário no sistema
idioma	Define o algoritmo para definição do idioma e métodos para busca de strings conforme mecanismo solicitado no config.
perms	Classe de permissões de acesso
grupo	Define um grupo no sistema

Variable Summary

boolean $_boolUserDb

string $_strFldNo

string $_strFldPk

string $_strTable

Method Summary

model __construct ()

void Delete ([array $arrPks = array()])

array Find (mixed $where)

object getDb ()

array getFields ()

object initPage ([integer $intPag = 1], [integer $idListagem = 1], [ $useUserDb = false])

void Load (mixed $who)

object Page ( &$lista, [array $arrDados = false], object $lista)

void Save ()

void Set (array $row)

Variables

boolean $_boolUserDb = false (line 50)

var: define se deve-se utilizar a conexão db de usuários
access: protected

Redefined in descendants as:

string $_strFldNo (line 46)

var: nome do campo com o nome
access: protected

Redefined in descendants as:

string $_strFldPk (line 42)

var: nome do campo com o pk
access: protected

Redefined in descendants as:

string $_strTable (line 38)

var: nome da tabela com os dados
access: protected

Redefined in descendants as:

Methods

Constructor __construct (line 56)

Construtor

Inicializa as propriedades do objeto com os campos do db

access: public

model __construct ()

Redefined in descendants as:

usuario::__construct() : Construtor
usuarioX::__construct() : Construtor
idioma::__construct() : Define o idioma a ser utilizado pelo framework
grupo::__construct() : Construtor

Delete (line 220)

Remove do banco de dados um ou mais registros

access: public

void Delete ([array $arrPks = array()])

array $arrPks: pks a serem removidos

Redefined in descendants as:

grupo::Delete() : Overload do método Delete

Find (line 188)

Lista todos os registros de uma tabela que atendam a um critério

return: array de objetos
access: public

array Find (mixed $where)

mixed $where
: pode ser:
- string com a cláusula where completa ou valor vazio que implica em tudo
- numeric com um pk a procurar
- array com valores de pk a procurar

getDb (line 116)

Retorna o objeto de banco de dados a ser utilizado

return: objeto adodb com a conexão ou false se erro.
access: public

object getDb ()

getFields (line 105)

Retorna as colunas do DB para informar seus tamanhos

return: lista dos campos e respectivas informações
access: public

array getFields ()

initPage (line 72)

Lista registros com todos os dados necessários para paginação

return: objeto de listagem com as propriedades de páginas, registros, e array com os objetos da lista em si.
access: public

object initPage ([integer $intPag = 1], [integer $idListagem = 1], [ $useUserDb = false])

integer $intPag: número da página solicitada
integer $idListagem: identificador da listagem para o caso de múltiplas listagens do mesmo objeto na mesma tela.
$useUserDb

Load (line 137)

Carrega os dados do objeto

access: public

void Load (mixed $who)

mixed $who: pk ou nome do objeto a ser carregado

Redefined in descendants as:

usuario::Load() : Carrega os dados do usuário

Page (line 88)

Processa a paginação de acordos com a solicitação

return: o objeto de listagem com os dados
access: public

object Page ( &$lista, [array $arrDados = false], object $lista)

object $lista: o objeto de listagem
array $arrDados: array de dados a serem paginados ou critério de filtragem
&$lista

Save (line 165)

Salva um registro no banco de dados Caso o objeto possua um pk, atualiza seus dado, caso contrário insere um novo registro.

access: public

void Save ()

Redefined in descendants as:

usuario::Save() : Overload do método original do adodb para salvar grupos relacionados

Set (line 245)

Define as propriedades de um objeto baseado em um array associativo

access: public

void Set (array $row)

array $row: array com os dados