DAL

class AeonDigital\DAL\DAL

Classe que permite o acesso a um banco de dados utilizando o PDO do PHP.

Parent:AeonDigital\BObject Implements:AeonDigital\Interfaces\DAL\iDAL

Properties

Methods

public AeonDigital\DAL\DAL::getConnection()

Retorna o objeto dbConnection desta instância.

Returns:‹ \PDO ›

public AeonDigital\DAL\DAL::getDBType()

Retorna o tipo do banco de dados utilizado.

Returns:‹ string ›

public AeonDigital\DAL\DAL::getDBHost()

Retorna o host da conexão com o banco de dados.

Returns:‹ string ›

public AeonDigital\DAL\DAL::getDBName()

Retorna o nome do banco de dados que esta conexão está apta a acessar.

Returns:‹ string ›

public AeonDigital\DAL\DAL::replaceConnection($oConnection)

Substitui a conexão desta instância pela do objeto passado.

Parameters:

• ‹ AeonDigital\Interfaces\DAL\iDAL › $oConnection
  Objeto que contêm a conexão que passará a ser usada por esta instância.

Returns:

‹ void ›

public AeonDigital\DAL\DAL::executeInstruction($strSQL, $parans=null)

Prepara e executa um comando SQL.

Parameters:

• ‹ string › $strSQL
  Instrução a ser executada.
• ‹ ?array › $parans
  Array associativo contendo as chaves e respectivos valores que serão substituídos na instrução SQL.

Returns:

‹ bool ›

public AeonDigital\DAL\DAL::getDataTable($strSQL, $parans=null)

Executa uma instrução SQL e retorna os dados obtidos.

Parameters:

• ‹ string › $strSQL
  Instrução a ser executada.
• ‹ ?array › $parans
  Array associativo contendo as chaves e respectivos valores que serão substituídos na instrução SQL.

Returns:

‹ ?array ›

public AeonDigital\DAL\DAL::getDataRow($strSQL, $parans=null)

Executa uma instrução SQL e retorna apenas a primeira linha de dados obtidos.

Parameters:

• ‹ string › $strSQL
  Instrução a ser executada.
• ‹ ?array › $parans
  Array associativo contendo as chaves e respectivos valores que serão substituídos na instrução SQL.

Returns:

‹ ?array ›

public AeonDigital\DAL\DAL::getDataColumn($strSQL, $parans=null, $castTo="string")

Executa uma instrução SQL e retorna apenas a coluna da primeira linha de dados

obtidos. O valor null será retornado caso a consulta não traga resultados.

Parameters:

• ‹ string › $strSQL
  Instrução a ser executada.
• ‹ ?array › $parans
  Array associativo contendo as chaves e respectivos valores que serão substituídos na instrução SQL.
• ‹ string › $castTo
  Indica o tipo que o valor resgatado deve ser retornado. Esperado: bool, int, float, real, datetime, string.

Returns:

‹ ?mixed ›

public AeonDigital\DAL\DAL::getCountOf($strSQL, $parans=null)

Efetua uma consulta SQL do tipo COUNT e retorna seu resultado.

A consulta passada deve sempre trazer o resultado da contagem em um alias chamado count.

``` sql

SELECT COUNT(id) as count FROM TargetTable WHERE column=:column;

```

Parameters:

• ‹ string › $strSQL
  Instrução a ser executada.
• ‹ ?array › $parans
  Array associativo contendo as chaves e respectivos valores que serão substituídos na instrução SQL.

Returns:

‹ int ›

public AeonDigital\DAL\DAL::isExecuted()

Indica se a última instrução foi corretamente executada.

Returns:‹ bool ›

public AeonDigital\DAL\DAL::countAffectedRows()

Retorna a quantidade de linhas afetadas pela última instrução SQL executada ou a

quantidade de linhas retornadas pela mesma.

Returns:‹ int ›

public AeonDigital\DAL\DAL::getLastError()

Retorna a mensagem de erro referente a última instrução SQL executada. Não

havendo erro, retorna null.

Returns:‹ ?string ›

public AeonDigital\DAL\DAL::getLastPK($tableName, $pkName)

Retorna o último valor definido para o último registro inserido na tabela de dado

alvo.

Tem efeito sobre chaves primárias do tipo AUTO INCREMENT.

Parameters:

• ‹ string › $tableName
  Nome da tabela de dados.
• ‹ string › $pkName
  Nome da chave primária a ser usada.

Returns:

‹ ?int ›

public AeonDigital\DAL\DAL::countRowsFrom($tableName, $pkName)

Efetua a contagem da totalidade de registros existentes na tabela de dados indicada.

Parameters:

• ‹ string › $tableName
  Nome da tabela de dados.
• ‹ string › $pkName
  Nome da chave primária da tabela.

Returns:

‹ int ›

public AeonDigital\DAL\DAL::countRowsWith($tablename, $colName, $colValue)

Efetua a contagem de registros existentes na tabela de dados indicada que

corresponda com o valor passado para a coluna indicada.

Parameters:

• ‹ string › $colName
  Nome da coluna a ser usada.
• ‹ mixed › $colValue
  Valor a ser pesquisado.

Returns:

‹ int ›

public AeonDigital\DAL\DAL::hasRowsWith($tablename, $colName, $colValue)

Verifica se existe na tabela de dados indicada um ou mais registros que possua na

coluna indicada o valor passado.

Parameters:

• ‹ string › $colName
  Nome da coluna a ser usada.
• ‹ mixed › $colValue
  Valor a ser pesquisado.

Returns:

‹ bool ›

public AeonDigital\DAL\DAL::insertInto($tableName, $rowData)

Efetua uma instrução INSERT INTO na tabela de dados alvo para cada um dos

itens existentes no array associativo passado.

Parameters:

• ‹ string › $tableName
  Nome da tabela de dados.
• ‹ array › $rowData
  Array associativo mapeando colunas e valores a serem utilizados na intrução SQL.

Returns:

‹ bool ›

public AeonDigital\DAL\DAL::updateSet($tableName, $rowData, $pkName)

Efetua uma instrução UPDATE SET na tabela de dados alvo para cada um dos

itens existentes no array associativo passado.

Parameters:

• ‹ string › $tableName
  Nome da tabela de dados.
• ‹ array › $rowData
  Array associativo mapeando colunas e valores a serem utilizados na intrução SQL.
• ‹ string › $pkName
  Nome da chave primária a ser usada. Seu respectivo valor deve estar entre aqueles constantes em $rowData.

Returns:

‹ bool ›

public AeonDigital\DAL\DAL::insertOrUpdate($tableName, $rowData, $pkName)

Efetua uma instrução INSERT INTO ou UPDATE SET conforme a existência ou não

da chave primária entre os dados passados para uso na instrução SQL.

Parameters:

• ‹ string › $tableName
  Nome da tabela de dados.
• ‹ array › $rowData
  Array associativo mapeando colunas e valores a serem utilizados na intrução SQL.
• ‹ string › $pkName
  Nome da chave primária a ser usada.

Returns:

‹ bool ›

public AeonDigital\DAL\DAL::selectFrom($tableName, $pkName, $pk, $columnNames=null)

Seleciona 1 única linha de registro da tabela de dados alvo a partir da chave

primária indicada e retorna um array associativo contendo cada uma das colunas

de dados indicados.

Parameters:

• ‹ string › $tableName
  Nome da tabela de dados.
• ‹ string › $pkName
  Nome da chave primária a ser usada.
• ‹ int › $pk
  Valor da chave primária.
• ‹ ?array › $columnNames
  Array contendo o nome de cada uma das colunas de dados a serem retornadas. Usando null todas serão retornadas.

Returns:

‹ ?array ›

public AeonDigital\DAL\DAL::deleteFrom($tableName, $pkName, $pk)

Efetua uma instrução DELETE FROM para a tabela de dados alvo usando o nome e

valor da chave primária definida.

Parameters:

• ‹ string › $tableName
  Nome da tabela de dados.
• ‹ string › $pkName
  Nome da chave primária a ser usada.
• ‹ int › $pk
  Valor da chave primária.

Returns:

‹ bool ›

public AeonDigital\DAL\DAL::inTransaction()

Indica se o modo de transação está aberto.

Returns:‹ bool ›

public AeonDigital\DAL\DAL::beginTransaction()

Inicia o modo de transação, dando ao desenvolvedor a responsabilidade de efetuar

o commit ou rollback conforme a necessidade.

Returns:‹ bool ›

public AeonDigital\DAL\DAL::commit()

Efetiva as transações realizadas desde que o modo de transação foi aberto.

Returns:‹ bool ›

public AeonDigital\DAL\DAL::rollBack()

Efetua o rollback das transações feitas desde que o modo de transação foi aberto.

Returns:‹ bool ›

public AeonDigital\DAL\DAL::__construct($dbType, $dbHost, $dbName, $dbUserName, $dbUserPassword, $dbSSLCA=null, $dbConnectionString=null, $oConnection=null)

Inicia uma nova instância de conexão com um banco de dados.

Parameters:

• ‹ string › $dbType
  Tipo do banco de dados. Esperao um dos tipos: mysql, mssqlserver, oracle, postgree.
• ‹ string › $dbHost
  Host da conexão com o banco de dados.
• ‹ string › $dbName
  Nome da base de dados à qual a conexão será feita.
• ‹ string › $dbUserName
  Credencial user para a efetuar a conexão.
• ‹ string › $dbUserPassword
  Credencial password para efetuar a conexão.
• ‹ ?string › $dbSSLCA
  Caminho para o certificado que deve ser usado no caso de uma conexão usando ssl.
• ‹ ?string › $dbConnectionString
  String de conexão a ser usada. Se não for definida, usará as regras internas para contruir uma.
• ‹ ?\AeonDigital\DAL\iConnection › $oConnection
  Instância de um objeto que terá sua conexão compartilhada com a nova instância que está sendo criada.

Throws:

‹ InvalidArgumentException ›
Caso algum valor passado não seja válido.