Criando um aplicativo direcionado a banco de dados com o PHP

Lição 4: Otimizando o código com classes e objetos

Nesta lição, você otimiza o código para facilitar a manutenção dele no futuro. Isso afeta os arquivos createNewWisher.php e wishlist.php. Além disso, um novo arquivo chamado db.php é criado.

O código do seu aplicativo contém vários blocos de código semelhantes com consultas ao banco de dados. Para facilitar a leitura e a manutenção do código no futuro, você pode extrair esses blocos, implementá-los como funções de uma classe separada chamada WishDB e colocar WishDB em db.php. Depois disso, você pode incluir o arquivo db.php em qualquer arquivo PHP e usar qualquer função de WishDB sem duplicação de código. Essa abordagem garante que quaisquer alterações em consultas ou funções serão feitas em um único local e você não terá que analisar o código inteiro do aplicativo.

Quando usa uma função de WishDB, você não altera o valor de quaisquer variáveis de WishDB. Em vez disso, use a classe WishDB como um plano gráfico para criar um objeto de WishDB, e altere os valores das variáveis nesse objeto. Quando você termina de trabalhar com esse objeto, ele é destruído. Como os valores da classe WishDB em si nunca são alterados, você pode reutilizar a classe por um número ilimitado de vezes. Em alguns casos, talvez você queira ter várias instâncias de uma classe ao mesmo tempo, e em outros casos, talvez você prefira uma classe "única", onde você possui apenas uma instância de cada vez. WishDB neste tutorial é uma classe única.

Observe que o termo para criar um objeto de uma classe é "instanciar" essa classe, e que outra palavra para um objeto é uma "instância" de uma classe. O termo geral para programar com classes e objetos é "programação orientada a objeto" ou OOP. O PHP 5 usa um modelo OOP sofisticado. Consulte php.net para obter mais informações.

Nesse tutorial, a funcionalidade de chamada do banco de dados é movida de arquivos PHP individuais para classes WishDB. Usuários do MySQL podem substituir a chamada mysqli de estilo de procedimento por chamadas orientadas por objetos. Isso é para mantar com o novo projeto orientado por objetos do aplicativo

O documento atual é uma parte do tutorial Criando um aplicativo CRUD no NetBeans IDE para PHP.

Código-fonte do aplicativo da lição anterior

Usuários MySQL: clique aqui para baixar o código-fonte que reflete o estado do projeto depois que a lição anterior estiver concluída.

Usuários do Banco de dados Oracle: Clique aqui para baixar o código-fonte que reflete o estado do projeto depois que a lição anterior estiver concluída.

Criando o arquivo db.php

Crie uma subpasta na pasta Source Files. Nomeie a pasta Includes. Crie uma nova pasta nomeada db.php e coloque em Includes. Posteriormente é possível adicionar mais arquivos para essa pasta que será incluída em outros arquivos PHP.

Para criar o db.php em uma nova pasta:

1. Clique com o botão direito do mouse no nó Arquivos de código-fonte no nó Arquivos de código-fonte e escolha Novo > Pasta no menu de contexto. A caixa de diálogo Nova pasta é aberta.
2. No campo Nome da pasta, digite Includes. A seguir, clique em Terminar.
3. Clique com o botão direito do mouse no nó Inclusões e escolha Novo > Arquivo PHP no menu de contexto. A caixa de diálogo Novo arquivo PHP é aberta.
4. No campo Nome do arquivo, digite db. A seguir, clique em Terminar.

Criando a classe WishDB

Para criar a classe WishDB, você precisa inicializar as variáveis da classe e implementar um construtor da classe. Usuários MySQL observem a classe WishDB extends mysqli. Isso significa que o WishDB herda a função e outras características da classe mysqli PHP. A importância disso é mostrada ao adicionar as funções mysqli à classe.

Abra o arquivo db.php e crie a classe WishDB. Na classe, declare variáveis de configuração de banco de dados para armazenar o nome e a senha do proprietário do banco de dados (usuário), o nome do banco de dados e o host do banco de dados. Todas essas declarações de variável são "privadas", o que significa que os valores iniciais nas declarações não podem ser acessados de fora da classe WishDB (Consulte php.net). Declare também a variável static $instance privada, que armazena a instância do WishDB. A palavra-chave “estática” significa que a função na classe pode acessar a variável mesmo quando não há instância da classe.

Para Banco de dados MySQL:

class WishDB extends mysqli {


    // single instance of self shared among all instances
    private static $instance = null;


    // db connection config vars
    private $user = "phpuser";
    private $pass = "phpuserpw";
    private $dbName = "wishlist";
    private $dbHost = "localhost";
}

Para Banco de dados Oracle

class WishDB {



// single instance of self shared among all instances
private static $instance = null;



// db connection config vars
private $user = "phpuser";
private $pass = "phpuserpw";
private $dbName = "wishlist";
private $dbHost = "localhost/XE";
private $con = null;


}        

Instanciando a classe WishDB

Para outros arquivos PHP usarem funções na classe WishDB, esses arquivos PHP precisam chamar uma função que crie um objeto ("instantiates") da classe WishDB. WishDB é designado como uma classe única, o que significa que somente uma instância da classe existe de cada vez. Portanto, é útil evitar qualquer instanciação externa de WishDB, o que poderia criar instâncias duplas.

Dentro da classe WishDB, digite ou cole o seguinte código:

 //This method must be static, and must return an instance of the object if the object
 //does not already exist.
 public static function getInstance() {
   if (!self::$instance instanceof self) {
     self::$instance = new self;
   }
   return self::$instance;
 }

 // The clone and wakeup methods prevents external instantiation of copies of the Singleton class,
 // thus eliminating the possibility of duplicate objects.
 public function __clone() {
   trigger_error('Clone is not allowed.', E_USER_ERROR);
 }
 public function __wakeup() {
   trigger_error('Deserializing is not allowed.', E_USER_ERROR);
 }

A função getInstance é "pública" e "estática." "Pública" significa que ela pode ser acessada publicamente de fora da classe. "Estática" significa que a função está disponível mesmo quando a classe não tiver sido instanciada. Como a função getInstance é chamada para instanciar a classe, ela deve ser estática. Observe que essa função acessa a variável$instance estática e ajusta os valores como a instância da classe.

Os dois pontos (::), chamados de Operador de resolução de escopo, e a palavra-chave self são usados para acessar funções estáticas. Self é usada na definição da classe para se referir à classe em si. Quando os dois pontos forem usados de fora da definição da classe, o nome da classe será usado em vez de self. Consulte php.net no Operador de resolução de escopo.

Adicionando um construtor à classe WishDB

Uma classe pode conter um método especial conhecido como 'construtor' que é processado automaticamente sempre que uma instância dessa classe é criada. Neste tutorial, você adiciona um construtor ao WishDB que se conecta ao banco de dados sempre que WishDB é instanciado.

Adicione o código seguinte ao WishDB:

Para o banco de dados MySQL:

// private constructor
private function __construct() {
    parent::__construct($this->dbHost, $this->user, $this->pass, $this->dbName);
    if (mysqli_connect_error()) {
        exit('Connect Error (' . mysqli_connect_errno() . ') '
                . mysqli_connect_error());
    }
    parent::set_charset('utf-8');
}

Para o banco de dados Oracle:

// private constructor
private function __construct() {
    $this->con = oci_connect($this->user, $this->pass, $this->dbHost);
    if (!$this->con) {
        $m = oci_error();
        echo $m['message'], "\n";
        exit;
    }
}

Observe o uso da pseudovariável $this em vez das variáveis $con, $dbHost, $user ou $pass. A pseudovariável $this é usada quando um método é chamado de dentro do contexto de um objeto. Ela se refere ao valor de uma variável nesse objeto.

Funções na classe WishDB

Nesta lição, você implementará as seguintes funções da classe WishDB:

• get_wisher_id_by_name para recuperar o id de um criador de lista de desejos com base em seu nome
• get_wishes_by_wisher_id para recuperar uma lista de desejos do criador de lista de desejos com um id específico
• create_wisher para adicionar um novo registro do criador de lista de desejos de código aos criadores da tabela

public function get_wisher_id_by_name($name) {

    $name = $this->real_escape_string($name);

    $wisher = $this->query("SELECT id FROM wishers WHERE name = '"

            . $name . "'");
    if ($wisher->num_rows > 0){
        $row = $wisher->fetch_row();
        return $row[0];
    } else
        return null;  
}

public function get_wisher_id_by_name($name) {
    $query = "SELECT id FROM wishers WHERE name = :user_bv";
    $stid = oci_parse($this->con, $query);
    oci_bind_by_name($stid, ':user_bv', $name);
    oci_execute($stid);
//Because user is a unique value I only expect one row
    $row = oci_fetch_array($stid, OCI_ASSOC);
    if ($row) 
        return $row["ID"];
    else
        return null;  
}

public function get_wishes_by_wisher_id($wisherID) {
    return $this->query("SELECT id, description, due_date FROM wishes WHERE wisher_id=" . $wisherID);
}

public function get_wishes_by_wisher_id($wisherID) {
    $query = "SELECT id, description, due_date FROM wishes WHERE wisher_id = :id_bv";
    $stid = oci_parse($this->con, $query);
    oci_bind_by_name($stid, ":id_bv", $wisherID);
    oci_execute($stid);
    return $stid;
}

public function create_wisher ($name, $password){
    $name = $this->real_escape_string($name);
    $password = $this->real_escape_string($password);
    $this->query("INSERT INTO wishers (name, password) VALUES ('" . $name . "', '" . $password . "')");
}

public function create_wisher($name, $password) {
    $query = "INSERT INTO wishers (name, password) VALUES (:user_bv, :pwd_bv)";
    $stid = oci_parse($this->con, $query);
    oci_bind_by_name($stid, ':user_bv', $name);
    oci_bind_by_name($stid, ':pwd_bv', $password);
    oci_execute($stid);
}