Refactory full

- Added Composer support
giovanniramos · Sep 24, 2013 · 4a0c1be · 4a0c1be
1 parent 8bf27b6
commit 4a0c1be
Show file tree

Hide file tree

Showing 24 changed files with 714 additions and 607 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+composer.lock
+composer.phar
+/vendor
diff --git a/.travis.yml b/.travis.yml
@@ -1,5 +1,12 @@
 language: php
+
 php:
-  - 5.2
   - 5.3
-  - 5.4
+  - 5.4
+  - 5.5
+
+before_script:
+  - curl -s http://getcomposer.org/installer | php
+  - php composer.phar install --prefer-source --no-interaction --dev
+
+script: phpunit
diff --git a/MIT-LICENSE.txt → LICENSE b/MIT-LICENSE.txt → LICENSE
diff --git a/README-pt.md b/README-pt.md
@@ -1,4 +1,4 @@
-*[Read the documentation in English](https://github.com/giovanniramos/PDO4YOU/blob/master/README.md)*
+*[Read the documentation in English](https://github.com/giovanniramos/PDO4You/blob/master/README.md)*
 
 ---
 
@@ -32,64 +32,31 @@ O padrão de projeto Singleton foi adotado para otimizar a conexão, garantindo
 
 
 
-Carregando o arquivo de inicialização
+Introdução
 --------------------------------------------------
 
+O bootstrap é o arquivo responsável por carregar o autoloader e todas as dependências do projeto.
+Se não estiver disponível, será exibida uma mensagem de confirmação para iniciar a instalação com Composer.
+
 ~~~ php
 <?php
 
-// Apenas um arquivo é necessário pelo carregamento dos arquivos responsáveis pelo funcionamento da classe.
-require_once('bootstrap.php');
+// Carrega o autoloader e todas as dependências do projeto
+require __DIR__.'/bootstrap.php';
 
 ?>
 ~~~ 
 
-`PDO4You.class.php`: contém a implementação do objeto PDO de conexão.
+`PDO4You.php`: classe que contém a implementação do objeto PDO de conexão.
 
 `PDO4You.config.php`: arquivo de configuração inicial, de acesso ao servidor e base de dados.
 
-`PDO4You.library.php`: arquivo contendo um autoloading de classes, e funções internas da classe.
-
 `PDO4You.settings.ini`: contém as definições para cada adaptador de conexão com uma base de dados.
 
+`Describe.php`: Describe é uma classe usada para listar todos os campos em uma tabela e o formato de dados de cada campo.
 
+`Pagination.php`: Pagination é uma classe que permite listar os registros de forma paginada, semelhante ao Google.
 
-Drivers suportados pelo servidor
---------------------------------------------------
-
-Execute o método abaixo para verificar se o servidor tem suporte a um driver PDO específico de sua base de dados. 
-Os drivers suportados serão exibidos na tela.
-
-~~~ php
-<?php
-
-// O método abaixo exibe todos os drivers instalados e que são suportados pelo servidor
-PDO4You::getAvailableDrivers();
-
-?>
-~~~
-
-Para habilitar algum driver não instalado, localize o arquivo php.ini, abra e procure por "extension=" sem as aspas, depois descomente as linhas a seguir conforme sua base de dados de preferência, removendo no início de cada linha o "ponto-e-vírgula" e após mudanças, reinicie o servidor.
-
-~~~ html
-;extension=php_pdo.dll                  ; Esta DLL não será necessária a partir do PHP 5.3
-extension=php_pdo_mysql.dll             ; MySQL 3.x/4.x/5.x / MariaDB
-extension=php_pdo_pgsql.dll             ; PostgreSQL
-;extension=php_pdo_cubrid.dll           ; CUBRID
-;extension=php_pdo_oci.dll              ; Oracle Call Interface
-;extension=php_pdo_sqlsrv.dll           ; Microsoft SQL Server / SQL Azure
-;extension=php_pdo_dblib.dll            ; Microsoft SQL Server / Sybase / FreeTDS
-;extension=php_pdo_mssql.dll            ; Microsoft SQL Server "Versão antiga"
-;extension=php_pdo_sqlite.dll           ; SQLite 2/3
-
-~~~
-
-Drivers PDO para o servidor Xampp:<br />
-CUBRID (PHP 5.4): http://bit.ly/PDO_CUBRID-PHP54<br />
-CUBRID (PHP 5.3): http://bit.ly/PDO_CUBRID-PHP53<br />
-MS SQL Server 3.0 (PHP 5.4): http://bit.ly/PDO_SQLSRV-PHP54<br />
-MS SQL Server 2.0 (PHP 5.2/5.3): http://bit.ly/PDO_SQLSRV-PHP53<br />
-MS SQL Server (Versão antiga): http://bit.ly/PDO_MSSQL-PHP53
 
 
 Estabelecendo uma conexão com a base de dados
@@ -100,6 +67,14 @@ Para abstrair nossos mecanismos de acesso aos dados, usamos um DSN (Data Source
 ~~~ php
 <?php
 
+// Carrega todos os arquivos necessários
+require __DIR__.'/bootstrap.php';
+
+// Instância de conexão importada e disponível para uso
+use PDO4You\PDO4You;
+new PDO4You;
+
+
 // Principais meios de se iniciar uma instância de conexão
 
 # PADRÃO 
@@ -142,12 +117,20 @@ Instruções de consulta:
 Abaixo seguem exemplos de como realizar essas operações.
 
 
+
 Selecionando registros na base de dados
 --------------------------------------------------
 
 ~~~ php
 <?php
 
+// Carrega todos os arquivos necessários
+require __DIR__.'/bootstrap.php';
+
+// Instância de conexão importada e disponível para uso
+use PDO4You\PDO4You;
+new PDO4You;
+
 // Iniciando uma instância de conexão. O padrão de conexão é não-persistente
 PDO4You::getInstance();
 
@@ -332,24 +315,63 @@ $result = PDO4You::execute($json);
 
 
 
-Requerimentos
+Drivers suportados pelo servidor
+--------------------------------------------------
+
+Execute o método abaixo para verificar se o servidor tem suporte a um driver PDO específico de sua base de dados. 
+Os drivers suportados serão exibidos na tela.
+
+~~~ php
+<?php
+
+// O método abaixo exibe todos os drivers instalados e que são suportados pelo servidor
+PDO4You::getAvailableDrivers();
+
+?>
+~~~
+
+Para habilitar algum driver não instalado, localize o arquivo php.ini, abra e procure por "extension=" sem as aspas, depois descomente as linhas a seguir conforme sua base de dados de preferência, removendo no início de cada linha o "ponto-e-vírgula" e após mudanças, reinicie o servidor.
+
+~~~ html
+;extension=php_pdo.dll                  ; Esta DLL não será necessária a partir do PHP 5.3
+extension=php_pdo_mysql.dll             ; MySQL 3.x/4.x/5.x / MariaDB
+extension=php_pdo_pgsql.dll             ; PostgreSQL
+;extension=php_pdo_cubrid.dll           ; CUBRID
+;extension=php_pdo_oci.dll              ; Oracle Call Interface
+;extension=php_pdo_sqlsrv.dll           ; Microsoft SQL Server / SQL Azure
+;extension=php_pdo_dblib.dll            ; Microsoft SQL Server / Sybase / FreeTDS
+;extension=php_pdo_mssql.dll            ; Microsoft SQL Server "Versão antiga"
+;extension=php_pdo_sqlite.dll           ; SQLite 2/3
+
+~~~
+
+Drivers PDO para o servidor Xampp:<br />
+CUBRID (PHP 5.4): http://bit.ly/PDO_CUBRID-PHP54<br />
+CUBRID (PHP 5.3): http://bit.ly/PDO_CUBRID-PHP53<br />
+MS SQL Server 3.0 (PHP 5.4): http://bit.ly/PDO_SQLSRV-PHP54<br />
+MS SQL Server 2.0 (PHP 5.2/5.3): http://bit.ly/PDO_SQLSRV-PHP53<br />
+MS SQL Server (Versão antiga): http://bit.ly/PDO_MSSQL-PHP53
+
+
+
+Dependências
 --------------------------------------------------
 
-PHP 5.3 ou superior
+PHP >= 5.3.2
 
 
 
 Colaboradores
 --------------------------------------------------
 
 Giovanni Ramos - <giovannilauro@gmail.com> - <http://twitter.com/giovanni_ramos><br />
-Veja também a lista de [colaboradores](http://github.com/giovanniramos/PDO4YOU/contributors) que participaram deste projeto.
+Veja também a lista de [colaboradores](http://github.com/giovanniramos/PDO4You/contributors) que participaram deste projeto.
 
 
 
 Licença
 --------------------------------------------------
 
-Copyright (c) 2013 [Giovanni Ramos](http://github.com/giovanniramos)
+Copyright (c) 2010-2013 [Giovanni Ramos](http://github.com/giovanniramos)
 
-PDO4You é um software open-source licenciado sob a [MIT License](http://www.opensource.org/licenses/MIT) (MIT-LICENSE.txt)
+PDO4You é um software open-source licenciado sob a [MIT License](http://www.opensource.org/licenses/MIT)
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-*[Leia a documenta&ccedil;&atilde;o em Portugu&ecirc;s](https://github.com/giovanniramos/PDO4YOU/blob/master/README-pt.md)*
+*[Leia a documenta&ccedil;&atilde;o em Portugu&ecirc;s](https://github.com/giovanniramos/PDO4You/blob/master/README-pt.md)*
 
 ---
 
@@ -32,64 +32,31 @@ The Singleton design pattern was adopted to optimize the connection, ensuring a
 
 
 
-Loading the bootstrap file
+Getting Started
 --------------------------------------------------
 
+The bootstrap file is responsible for loading the autoloader and all project dependencies.
+If not available, you will receive a confirmation message to start installation with Composer.
+
 ~~~ php
 <?php
 
-// Only one file is needed for loading the files responsible for the operation of the class.
-require_once('bootstrap.php');
+// Loads the autoloader and all project dependencies
+require __DIR__.'/bootstrap.php';
 
 ?>
 ~~~ 
 
-`PDO4You.class.php`: contains the implementation of the PDO object connection.
+`PDO4You.php`: class that contains the implementation of the PDO object connection.
 
 `PDO4You.config.php`: initial configuration file, server access and database.
 
-`PDO4You.library.php`: file containing an autoloading class, and internal functions of the class.
-
 `PDO4You.settings.ini`: contains the settings for each adapter of connection to the database.
 
+`Describe.php`: Describe is a class used to list all the fields in a table and the data format of each field.
 
+`Pagination.php`: Pagination is a class that allows you to list the records so as paged, similar to Google.
 
-Drivers supported by the server
---------------------------------------------------
-
-Execute the method below to check if the server supports a PDO driver specific to your database.
-Supported drivers will be displayed on the screen.
-
-~~~ php
-<?php
-
-// The method below shows all the drivers installed and that are supported by the server
-PDO4You::getAvailableDrivers();
-
-?>
-~~~
-
-To enable any driver not installed, locate the php.ini file, open it and look for "extension=" without quotes, then uncomment the following lines according to your database preferably, removing the beginning of each line the "semicolon" and after changes, restart the server.
-
-~~~ html
-;extension=php_pdo.dll                  ; This DLL is not required as of PHP 5.3
-extension=php_pdo_mysql.dll             ; MySQL 3.x/4.x/5.x / MariaDB
-extension=php_pdo_pgsql.dll             ; PostgreSQL
-;extension=php_pdo_cubrid.dll           ; CUBRID
-;extension=php_pdo_oci.dll              ; Oracle Call Interface
-;extension=php_pdo_sqlsrv.dll           ; Microsoft SQL Server / SQL Azure
-;extension=php_pdo_dblib.dll            ; Microsoft SQL Server / Sybase / FreeTDS
-;extension=php_pdo_mssql.dll            ; Microsoft SQL Server "Old version"
-;extension=php_pdo_sqlite.dll           ; SQLite 2/3
-
-~~~
-
-PDO drivers for the server Xampp:<br />
-CUBRID (PHP 5.4): http://bit.ly/PDO_CUBRID-PHP54<br />
-CUBRID (PHP 5.3): http://bit.ly/PDO_CUBRID-PHP53<br />
-MS SQL Server 3.0 (PHP 5.4): http://bit.ly/PDO_SQLSRV-PHP54<br />
-MS SQL Server 2.0 (PHP 5.2/5.3): http://bit.ly/PDO_SQLSRV-PHP53<br />
-MS SQL Server (Old version): http://bit.ly/PDO_MSSQL-PHP53
 
 
 Establishing a connection to the database
@@ -100,6 +67,14 @@ To abstract our data access mechanisms, we use a DSN (Data Source Name = Data So
 ~~~ php
 <?php
 
+// Load all the files needed
+require __DIR__.'/bootstrap.php';
+
+// Connection instance imported and available for use
+use PDO4You\PDO4You;
+new PDO4You;
+
+
 // Main ways to start a connection instance
 
 # DEFAULT 
@@ -142,12 +117,20 @@ Query statements:
 Below are examples of how to perform these operations.
 
 
+
 Selecting records in the database
 --------------------------------------------------
 
 ~~~ php
 <?php
 
+// Load all the files needed
+require __DIR__.'/bootstrap.php';
+
+// Connection instance imported and available for use
+use PDO4You\PDO4You;
+new PDO4You;
+
 // Starting a connection instance. The default connection is not persistent
 PDO4You::getInstance();
 
@@ -332,24 +315,63 @@ $result = PDO4You::execute($json);
 
 
 
-Requirements
+Drivers supported by the server
+--------------------------------------------------
+
+Execute the method below to check if the server supports a PDO driver specific to your database.
+Supported drivers will be displayed on the screen.
+
+~~~ php
+<?php
+
+// The method below shows all the drivers installed and that are supported by the server
+PDO4You::getAvailableDrivers();
+
+?>
+~~~
+
+To enable any driver not installed, locate the php.ini file, open it and look for "extension=" without quotes, then uncomment the following lines according to your database preferably, removing the beginning of each line the "semicolon" and after changes, restart the server.
+
+~~~ html
+;extension=php_pdo.dll                  ; This DLL is not required as of PHP 5.3
+extension=php_pdo_mysql.dll             ; MySQL 3.x/4.x/5.x / MariaDB
+extension=php_pdo_pgsql.dll             ; PostgreSQL
+;extension=php_pdo_cubrid.dll           ; CUBRID
+;extension=php_pdo_oci.dll              ; Oracle Call Interface
+;extension=php_pdo_sqlsrv.dll           ; Microsoft SQL Server / SQL Azure
+;extension=php_pdo_dblib.dll            ; Microsoft SQL Server / Sybase / FreeTDS
+;extension=php_pdo_mssql.dll            ; Microsoft SQL Server "Old version"
+;extension=php_pdo_sqlite.dll           ; SQLite 2/3
+
+~~~
+
+PDO drivers for the server Xampp:<br />
+CUBRID (PHP 5.4): http://bit.ly/PDO_CUBRID-PHP54<br />
+CUBRID (PHP 5.3): http://bit.ly/PDO_CUBRID-PHP53<br />
+MS SQL Server 3.0 (PHP 5.4): http://bit.ly/PDO_SQLSRV-PHP54<br />
+MS SQL Server 2.0 (PHP 5.2/5.3): http://bit.ly/PDO_SQLSRV-PHP53<br />
+MS SQL Server (Old version): http://bit.ly/PDO_MSSQL-PHP53
+
+
+
+Dependencies
 --------------------------------------------------
 
-PHP 5.3 or higher
+PHP >= 5.3.2
 
 
 
 Collaborators
 --------------------------------------------------
 
 Giovanni Ramos - <giovannilauro@gmail.com> - <http://twitter.com/giovanni_ramos><br />
-See also the list of [colaboradores](http://github.com/giovanniramos/PDO4YOU/contributors) who participated in this project.
+See also the list of [colaboradores](http://github.com/giovanniramos/PDO4You/contributors) who participated in this project.
 
 
 
 License
 --------------------------------------------------
 
-Copyright (c) 2013 [Giovanni Ramos](http://github.com/giovanniramos)
+Copyright (c) 2010-2013 [Giovanni Ramos](http://github.com/giovanniramos)
 
-PDO4You is open-sourced software licensed under the [MIT License](http://www.opensource.org/licenses/MIT) (MIT-LICENSE.txt)
+PDO4You is open-sourced software licensed under the [MIT License](http://www.opensource.org/licenses/MIT)