::: Manual de uso :::
Manual Referente da versăo 3.0.1
e anteriores
Introduçăo
Esse é um conjunto de classes capaz de mapear um banco de
dados de sua escolha e gerar as classes (em php5) para a manipulaçăo dos
dados entre o banco e o usuário final.
O Sistema é todo baseado em orientaçăo a objetos, ótimo para quem já
possui um conhecimento elevado na área de OO e bom para quem está iniciando.
Atençăo: para quem esta iniciando ira
parecer um pouco complicado mas com o passar do |
Capitulo 1 - Instalando o GetClass
1.1 - Extrai os arquivos no diretório raiz do seu servidor.
1.2 - Ative o apache e
acesse a pasta do sistema pelo navegador, nele ira pedir os dados para a
conexăo com o servidor MySQL, informe os dados e apertem instalar.
Capitulo 2 - Gerando um conjunto de
classes.
2.1 - Após informar os dados para a conexão com o servidor do banco de dados, escolha um banco de dados a ser mapeado.
2.2 - Escolha as tabelas que você deseja mapear, e clique em "Gerar Classes".
2.3 - Classes geradas. Agora acesse a pasta "classes_geradas" dentro desta pasta estará a pasta onde estarão suas classes.
*Nome da pasta foi informado no final da geraçăo das classes.
Capitulo 3 - Configurando o arquivo
DB.php
3.1 - Abra o arquivo "DB.php".
3.2 - Procure a funçăo "__construct". Nela ira conter o seguinte código:
Esses são os dados para a conexão com o banco
Capitulo 4 - Retornando
os dados do banco de dados
4.1 - Primeiro crie um include na sua pagina chamando o arquivo "Principal.php":
Exemplo:
<?php include("classes/Principal.php"); ?> |
Atençăo: Você renomear a pasta para um
nome de sua escolha |
4.2 - Crie uma instancia da classe:
Exemplo:
<?php include("classes/Principal.php"); $principal = new Principal(); ?> |
4.3 - Agora nos vamos chamar os dados que estăo no banco de dados:
4.3.1 -
Formaçăo do nome da funçăo:
A funçăo e composta pelas
seguintes palavras:
"retorna" = palavra fixa para
funçőes de retorno.
"nome da
tabela" = é o nome da tabela de onde serăo retornado os dados.
Atençăo: No nome da tabela sempre ira
começar com um caractere maiúsculo. |
Exemplo:
retornaTbl_usuarios($extra); |
4.3.2 - Parâmetros passados
Repare que o nome da funçăo é formado pela palavra fixa mas o nome da tabela. Além do mais ele pede um parâmetro para ser passado, nesse caso esse parâmetro é opcional, o programador só ira passar parâmetro se desejar uma busca com filtros
4.3.3 - Exemplos de retornos
Exemplo 1: Retornando o nome de todos os usuários da tabela "tbl_usuarios"
<?php include("classes/Principal.php"); $principal = new Principal(); foreach($principal->retornaTbl_usuarios() as $usuario) { echo $usuario->getNome(); } ?> |
Exemplo 2: Retornando o nome dos últimos 5 usuários da tabela tbl_usuarios"
<?php include("classes/Principal.php"); $principal = new Principal(); $extra = "ORDER
BY ID DESC LIMIT 0,5"; foreach($principal->retornaTbl_usuarios($extra) as $usuario) { echo $usuario->getNome(); } ?> |
4.3.4 - Esclarecendo o foreach
Repare que nos chamamos o
retorno dos usuário em um foreach. Porque? O
motivo pelo qual nos passamos o retorno para um foreach é pelo motivo que a
funçăo retorna um array de objetos, repare na variável
"$usuario" onde nos passamos para ela o valor da instancia de
retorno. Que a mesma se refere as classes do tipo "Basicas" que estăo
contidas na pasta "classesBasicas".
Observe
como chamamos o método para exibiçăo do nome do usuário
$usuario->getNome(); |
No caso
desse sistema ele retorna um método que contenha o valor que estava contido no
banco este método e composto da seguinte forma:
"get" = palavra fixa |
"Nome" = nome do campo referente ao retorno
(O primeiro caractere que se refere ao nome do campo deve ser sempre em maiúsculo).
Capitulo 5 - Inserindo dados no banco
5.1 - Chamando a funçăo de inserçăo no banco
Para poder inserir dados no banco é necessário chamar duas funçőes.
Exemplo:
<?php include("classes/Principal.php"); $principal = new Principal(); $principal->tbl_usuarios('', $nome_usuario, $email_usuario, $senha_usuario); $principal->inserirTbl_usuarios(); // retorna um valor boolean true ou false ?> |
Explicaçăo:
Repare
que nas invocamos outro método, nesse caso "tbl_usuarios()";
Esse
método é responsável por alocar os dados temporariamente para que o método de
inserçăo possa inserir no banco de dados.
Após alocarmos os dados nós chamamos o método de inserçăo "inserirTbl_usuarios()"
Atenção: cada tabela tera seu método
restrito. |
Exemplo: tbl_noticias
<?php include("classes/Principal.php"); $principal = new Principal(); $principal->tbl_noticias('', $titulo, $descricao, $data); $principal->inserirTbl_noticias(); // retorna um valor boolean true ou false ?> |
Capitulo 6 - Atualizaçăo de dados
6.1 - Chamando a funçăo para atualizar os dados
A principio para chamar a funçăo será passados os mesmos dados que a funçăo de inserçăo mas com a seguinte diferença de que não será chamado o método de inserçăo mas sim o de atualizaçăo.
Exemplo:
<?php include("classes/Principal.php"); $principal = new Principal(); $principal->tbl_usuarios('', $nome_usuario, $email_usuario, $senha_usuario); $principal->atualizaTbl_usuarios(); // retorna um valor boolean true ou false ?> |
Capitulo 7 - deletando
dados
7.1 - Chamando a funçăo de deletar dados
Essa é a mais facil das funçőes par deletar os dados vocę so precisa passar o id do dado a ser apagado
Exemplo 1: Apagando apenas um registro
<?php include("classes/Principal.php"); $principal = new Principal(); $principal->deletaTbl_usuarios($id_usuario); // retorna um valor boolean true ou false ?> |
Exemplo 1: Apagando todos os registros da tabela "tbl_usuarios"
<?php include("classes/Principal.php"); $principal = new Principal(); foreach($principal->retornaTbl_usuarios() as $usuario) { $principal->deletaTbl_usuarios($usuario->getID()); // retorna um valor true se verdadeiro ou false se não deletar os dados } ?> |
Capitulo 8 - Retornando
a quantidade de dados cadastrados
8.1 - Chamando o método que informa a quantidade de dados que estăo cadastrados
Este método é parecido com o de retorno exceto pelo motivo que ele retorna um número ou false.
Exemplo 1: Informando o total de dados cadastrados
<?php include("classes/Principal.php"); $principal = new Principal(); $principal->retornaQuantidadeRegistrosTbl_usuarios(); // retorna um valor numérico se verdadeiro ou false se não encontrar dados ?> |
Exemplo 2: Informando o total de dados cadastrados que tenham estejam ativados
<?php include("classes/Principal.php"); $principal = new Principal(); $extra =
"WHERE Status='1'"; $principal->retornaQuantidadeRegistrosTbl_usuarios($extra); // retorna um
valor numérico se verdadeiro ou false se não encontrar dados ?> |
Capitulo 9 – Métodos adicionas da
classe
Principal::meuSql() : Query
meuSql(parametro) - executa uma query por conta própria.
<?php include("classes/Principal.php"); $principal = new Principal(); $sql =
"SELECT * FROM tbl_usuarios"; $principal->meuSql($sql); // retorna a
query ?> |
Principal::getMsg() : String
getMsg() – retorna a mensagem das operações feitas.
<?php include("classes/Principal.php"); $principal = new Principal(); $extra =
"WHERE Status='1'"; $principal->retornaQuantidadeRegistrosTbl_usuarios($extra); // retorna um
valor numérico se verdadeiro ou false se não encontrar dados echo $principal->getMsg(); ?> |
Principal::setMsg(): void
setMsg(String) – Escreve uma mensagem.
<?php include("classes/Principal.php"); $principal = new Principal(); $principal->setMsg("Mensagem de teste!"); ?> |
Espero que tenha esclarecido as duvidas!
Caso não ainda tenha dúvidas envie um email para mim.
diegogomesaraujo@hotmail.com