<?xml version="1.0"?>
<document title="XtPHP" description="Biblioteca de classes que facilitam a vida do programador.">
<class name="XtMysql">
<description>XtMysql oferece formas de interação com o SGBD Mysql.</description>
<methods>
<method name="connect" visibility="public" example="mysql_connection.php">
<description>Realiza uma conexão com o servidor Mysql.</description>
<params>
<param type="string" name="$host" optional="false" default="">Host do servidor. p.e. localhost:3306</param>
<param type="string" name="$user" optional="false" default="">Usuário para acesso ao Mysql.</param>
<param type="string" name="$pass" optional="false" default="">Senha do usuário.</param>
<param type="string" name="$db" optional="false" default="">Nome do banco de dados (schema) para conexão.</param>
</params>
<return type="boolean">Retorna true em caso de sucesso ou false em caso de falha na conexão.</return>
</method>
<method name="qry" visibility="public" example="mysql_qry.php">
<description>Executa uma consulta SQL no Mysql.</description>
<params>
<param type="string" name="$sql" optional="false" default="">Uma string de consulta SQL. p.e. SELECT * FROM table_name.</param>
</params>
<return type="mixed">Retorna um Resource ou false em caso de falha.</return>
</method>
<method name="select" visibility="public" example="mysql_select.php">
<description>Facilita a seleção de dados no banco de dados.</description>
<params>
<param type="mixed" name="$table" optional="false" default="">O nome da tabela ou um array com nomes de tabelas.</param>
<param type="mixed" name="$fields" optional="true" default="*">Um array com os nomes de campos a serem selecionados ou uma string com esses nomes.</param>
<param type="string" name="$complex" optional="true" default="">Uma string com cláusula WHERE, ORDER, GROUP etc para tornar mais complexa a consulta. É colocada após o nome das tabelas na string de consulta.</param>
</params>
<return type="array">Retorna um Store.</return>
</method>
<method name="insert" visibility="public" example="mysql_insert.php">
<description>Facilita a inserção de dados no banco de dados.</description>
<params>
<param type="string" name="$table" optional="false" default="">O nome da tabela que receberá os dados.</param>
<param type="array" name="$data" optional="false" default="">Um array bidimensional com os dados a serem inseridos</param>
<param type="array" name="$fields" optional="true" default="">Um array com os nomes dos campos da tabela, caso sejam diferentes dos campos de $data. A chave do array é no nome do campo em $data e o valor do array né o nome do campo no Mysql.</param>
</params>
<return type="array">Retorna true ou um array com os informações dos erros ocorridos.</return>
</method>
<method name="update" visibility="public" example="mysql_update.php">
<description>Facilita a atualização de dados no banco de dados.</description>
<params>
<param type="string" name="$table" optional="false" default="">O nome da tabela que receberá os dados.</param>
<param type="array" name="$data" optional="false" default="">Um array bidimensional com os dados a serem inseridos</param>
<param type="string" name="$ref" optional="false" default="">O nome do campo que servirá de base para filtragem dos dados a serem atualizados.</param>
</params>
<return type="array">Retorna true ou um array com os informações dos erros ocorridos.</return>
</method>
<method name="delete" visibility="public" example="mysql_delete.php">
<description>Facilita a deleção de dados no banco de dados.</description>
<params>
<param type="string" name="$table" optional="false" default="">O nome da tabela que terá os dados apagados.</param>
<param type="string" name="$ref" optional="true" default="false">o nome do campo que servirá de referência para filtragem dos dados. Se não especificado, todos os dados serão apagados.</param>
<param type="array" name="$delete" optional="true" default="false">array com os valores que servirão de referẽncia para filtrar os dados a serem apagados.</param>
</params>
<return type="array">Retorna true ou um array com os informações dos erros ocorridos.</return>
</method>
<method name="truncate" visibility="public" example="mysql_truncate.php">
<description>Apaga toda a tabela, reiniciando a autonumeração.</description>
<params>
<param type="string" name="$table" optional="false" default="">O nome da tabela que será truncada.</param>
</params>
<return type="bool">Retorna true ou false.</return>
</method>
<method name="dumpTableFromODBC" visibility="public" example="mysql_dumptablefromodbc.php">
<description>Cria um "DUMP" de uma tabela via ODBC para o Mysql.</description>
<params>
<param type="resource" name="$conn" optional="false" default="">Um identificador de conexão.</param>
<param type="string" name="$db" optional="false" default="">O nome do banco de dados.</param>
<param type="string" name="$schema" optional="false" default="">O nome do schema.</param>
<param type="string" name="$table" optional="false" default="">O nome da tabela.</param>
<param type="bool" name="$data" optional="true" default="true">False importa apenas a estrutura da tabela. True importa os dados junto.</param>
</params>
<return type="array">Retorna um array onde cada linha é uma string de execução SQL com o dump da tabela.</return>
</method>
<method name="dumpDbFromODBC" visibility="public" example="mysql_dumpdbfromodbc.php">
<description>Cria um "DUMP" de um banco de dados via ODBC para o Mysql.</description>
<params>
<param type="resource" name="$conn" optional="false" default="">Um identificador de conexão.</param>
<param type="string" name="$db" optional="false" default="">O nome do banco de dados.</param>
<param type="string" name="$schema" optional="false" default="">O nome do schema.</param>
<param type="bool" name="$data" optional="true" default="true">False importa apenas a estrutura da tabela. True importa os dados junto.</param>
</params>
<return type="array">Retorna um array onde cada linha é uma string de execução SQL com o dump do banco de dados.</return>
</method>
</methods>
</class>
</document>
|
Download
