ezsql
5.1.1
Una clase que hace que sea muy fácil lidiar con conexiones de bases de datos. Un sistema CRUD intercambiable universal.
Esta es la versión 5 que interrumpirá a los usuarios de la versión 4 .
Principalmente por:
El uso del namespace en el archivo ezFunctions.php de funciones global . El uso de las funciones globales requerirá que el usuario inicie un archivo .php similar a:
use function ezsql functions where ;
// Or
use function ezsql functions {
getInstance ,
selecting ,
inserting ,
}; Propiedades de clase a las que se podía acceder mediante métodos mágicos get/set , ahora PSR 1 camelCase.
Se cambió el nombre select de ez_mysqli a dbSelect .
Método de clase renombrado y comportamiento de selecting para select .
selecting y los nuevos métodos inserting se pueden llamar sin el nombre de la tabla, solo los demás parámetros necesarios:
tableSetup(name, prefix), or setTable(name), setPrefix(append) , si se llama sin preestablecer, se devuelve false .ing . Se eliminaron funciones globales en las que se pasaba el nombre table . Utilice funciones que utilicen nombres de tablas preestablecidos que terminen en ing .
renombrado cleanInput a clean_string
renombrado createCertificate a create_certificate
Se agregó get_results globales para devolver conjuntos de resultados en diferentes formatos.
La versión 4 tiene muchas prácticas de programación modernas que molestarán a los usuarios de la versión 3.
La versión 3 rompió la versión 2.1.7 de una manera importante: requería PHP 5.6 . Lo que elimina el soporte de la extensión mysql, aparte de eso, no se cambió nada en lo que respecta al uso de la biblioteca, solo características adicionales.
Esta biblioteca tiene una clase Database , una combinación del patrón Factory con un alojamiento de contenedor de inyección de dependencia. Esta biblioteca ahora sigue muchos principios de programación orientada a objetos, uno de los cuales se ha eliminado el acceso público a las propiedades de los métodos. Esta biblioteca también sigue las convenciones PSR-2, PSR-4, PSR-11 y principalmente PSR-1, y aún es un trabajo en progreso.
Para obtener una descripción completa, consulte la documentación Wiki, que no está completamente terminada.
composer require ezsql/ezsql
require ' vendor/autoload.php ' ;
// **** is one of mysqli, pgsql, sqlsrv, sqlite3, or Pdo.
use ezsql Database ;
$ db = Database:: initialize ( ' **** ' , [ $ dsn_path_user , $ password , $ database , $ other_settings ], $ optional_tag );
// Is same as:
use ezsql Config ;
use ezsql Database ez_ ****;
$ settings = new Config ( ' **** ' , [ $ dsn_path_user , $ password , $ database , $ other_settings ]);
$ db = new ez_ ****( $ settings );Esta biblioteca asumirá que el desarrollador está utilizando algún tipo de IDE con intellisense habilitado. El área de comentarios/bloque de documentos contendrá cualquier documentación faltante. Para ver ejemplos adicionales, consulte las pruebas de phpunit . Las pruebas son pruebas de integración completamente funcionales, lo que significa que son pruebas de bases de datos en vivo, no simuladas.
Se ha agregado lo siguiente desde la versión 2.1.7.
Métodos generales
to_string($arrays, $separation = ',');
clean($string);
create_cache(string $path = null);
secureSetup(string $key = 'certificate.key',
string $cert = 'certificate.crt',
string $ca = 'cacert.pem',
string $path = '.'._DS
);
secureReset();
create_certificate(string $privatekeyFile = certificate.key,
string $certificateFile = certificate.crt,
string $signingFile = certificate.csr,
string $ssl_path = null, array $details = [commonName => localhost]
);
Métodos de tabla de accesos directos
create(string $table = null, ...$schemas);// $schemas requires... column()
column(string $column = null, string $type = null, ...$args);
primary(string $primaryName, ...$primaryKeys);
index(string $indexName, ...$indexKeys);
drop(string $table);
Ejemplo
// Creates an database table
create ( ' profile ' ,
// and with database column name, datatype
// data types are global CONSTANTS
// SEQUENCE|AUTO is placeholder tag, to be replaced with the proper SQL drivers auto number sequencer word.
column ( ' id ' , INTR , 11 , AUTO , PRIMARY ), // mysqli
column ( ' name ' , VARCHAR , 50 , notNULL),
column ( ' email ' , CHAR , 25 , NULLS ),
column ( ' phone ' , TINYINT )
); innerJoin(string $leftTable = null, string $rightTable = null,
string $leftColumn = null, string $rightColumn = null, string $tableAs = null, $condition = EQ);
leftJoin(string $leftTable = null, string $rightTable = null,
string $leftColumn = null, string $rightColumn = null, string $tableAs = null, $condition = EQ);
rightJoin(string $leftTable = null, string $rightTable = null,
string $leftColumn = null, string $rightColumn = null, string $tableAs = null, $condition = EQ);
fullJoin(string $leftTable = null, string $rightTable = null,
string $leftColumn = null, string $rightColumn = null, string $tableAs = null, $condition = EQ);
prepareOn (); // When activated will use prepare statements for all shortcut SQL Methods calls.
prepareOff (); // When off shortcut SQL Methods calls will use vendors escape routine instead. This is the default behavior.having(...$having);groupBy($groupBy);union(string $table = null, $columnFields = '*', ...$conditions);unionAll(string $table = null, $columnFields = '*', ...$conditions);orderBy($orderBy, $order);limit($numberOf, $offset = null)where( ...$whereConditions);select(string $table = null, $columnFields = '*', ...$conditions);create_select(string $newTable, $fromColumns, $oldTable = null, ...$conditions);select_into(string $newTable, $fromColumns, $oldTable = null, ...$conditions);update(string $table = null, $keyAndValue, ...$whereConditions);delete(string $table = null, ...$whereConditions);replace(string $table = null, $keyAndValue);insert(string $table = null, $keyAndValue);create(string $table = null, ...$schemas);drop(string $table = null);alter(string $table = null, ...$alteringSchema);insert_select(string $toTable = null, $toColumns = '*', $fromTable = null, $fromColumns = '*', ...$conditions); // The variadic ...$whereConditions, and ...$conditions parameters,
// represent the following global functions.
// They are comparison expressions returning an array with the given arguments,
// the last arguments of _AND, _OR, _NOT, _andNOT will combine expressions
eq ( ' column ' , $ value , _AND ), // combine next expression
neq ( ' column ' , $ value , _OR ), // will combine next expression again
ne ( ' column ' , $ value ), // the default is _AND so will combine next expression
lt ( ' column ' , $ value )
lte ( ' column ' , $ value )
gt ( ' column ' , $ value )
gte ( ' column ' , $ value )
isNull ( ' column ' )
isNotNull ( ' column ' )
like ( ' column ' , ' _%? ' )
notLike ( ' column ' , ' _%? ' )
in ( ' column ' , ... $ value )
notIn ( ' column ' , ... $ value )
between ( ' column ' , $ value , $ value2 )
notBetween ( ' column ' , $ value , $ value2 )
// The above should be used within the where( ...$whereConditions) clause
// $value will protected by either using escape or prepare statement // To allow simple grouping of basic $whereConditions,
// wrap the following around a group of the above comparison
// expressions within the where( ...$whereConditions) clause
grouping ( eq (key, value, combiner ), eq (key, value, combiner ) )
// The above will wrap beginning and end grouping in a where statement
// where required to break down your where clause. // Note: The usage of this method will require the user/developer to check
// if `query_string` or `param_array` is valid.
//
// This is really an `private` internal method for other shortcut methods,
// it's made public for `class development` usage only.
//
//
// Supply the the whole `query` string, and placing '?' within, with the same number of arguments in an array.
// It will then determine arguments type, execute, and return results.
query_prepared (string $ query_string , array $ param_array );
// You will need to call this method to get last successful query result.
// It wll return an object array.
queryResult (); // To get all shortcut SQL methods calls to use prepare statements
$ db -> prepareOn (); // This needs to be called at least once at instance creation
$ values = [];
$ values [ ' name ' ] = $ user ;
$ values [ ' email ' ] = $ address ;
$ values [ ' phone ' ] = $ number ;
$ db -> insert ( ' profile ' , $ values );
$ db -> insert ( ' profile ' , [ ' name ' => ' john john ' , ' email ' => ' john@email ' , ' phone ' => 123456 ]);
// returns result set given the table name, column fields, and ...conditions
$ result = $ db -> select ( ' profile ' , ' phone ' , eq ( ' email ' , $ email ), between ( ' id ' , 1 , $ values ));
foreach ( $ result as $ row ) {
echo $ row -> phone ;
}
$ result = $ db -> select ( ' profile ' , ' name, email ' ,
// Conditionals can also be called, stacked with other functions like:
// innerJoin(), leftJoin(), rightJoin(), fullJoin()
// as (leftTable, rightTable, leftColumn, rightColumn, tableAs, equal condition),
// where( eq( columns, values, _AND ), like( columns, _d ) ),
// groupBy( columns ),
// having( between( columns, values1, values2 ) ),
// orderBy( columns, desc ),
// limit( numberOfRecords, offset ),
// union(table, columnFields, conditions),
// unionAll(table, columnFields, conditions)
$ db -> where ( eq ( ' phone ' , $ number , _OR ), neq ( ' id ' , 5 ) ),
// another way: where( array(key, operator, value, combine, combineShifted) );
// or as strings double spaced: where( "key operator value combine combineShifted" );
$ db -> orderBy ( ' name ' ),
$ db -> limit ( 1 )
);
foreach ( $ result as $ row ) {
echo $ row -> name . ' ' . $ row -> email ;
}
// To get results in `JSON` format
$ json = get_results ( JSON , $ db ); $ db -> query_prepared ( ' INSERT INTO profile( name, email, phone) VALUES( ?, ?, ? ); ' , [ $ user , $ address , $ number ]);
$ db -> query_prepared ( ' SELECT name, email FROM profile WHERE phone = ? OR id != ? ' , [ $ number , 5 ]);
$ result = $ db -> queryResult (); // the last query that has results are stored in `lastResult` protected property
// Or for results in other formats use the global function, will use global database instance if no `$db` supplied
$ result = get_results ( / * OBJECT | ARRAY _ A | ARRAY _ N | JSON */ , $ db ); // Defaults to `OBJECT`
foreach ( $ result as $ row ) {
echo $ row -> name . ' ' . $ row -> email ;
} La mayoría de los métodos abreviados tienen funciones de contador global disponibles. Solo se puede acceder a ellos iniciando su archivo .php como:
use function ezsql functions functionBelow ;
// Or as here, a complete list.
use function ezsql functions {
database ,
mysqlInstance ,
pgsqlInstance ,
mssqlInstance ,
sqliteInstance ,
pdoInstance ,
tagInstance ,
setInstance ,
getInstance ,
clearInstance ,
get_vendor ,
///
to_string ,
clean_string ,
is_traversal ,
sanitize_path ,
create_certificate ,
///
column ,
primary ,
foreign ,
unique ,
index ,
addColumn ,
dropColumn ,
changingColumn ,
///
eq ,
neq ,
ne ,
lt ,
lte ,
gt ,
gte ,
isNull ,
isNotNull ,
like ,
in ,
notLike ,
notIn ,
between ,
notBetween ,
///
where ,
grouping ,
groupBy ,
having ,
orderBy ,
limit ,
innerJoin ,
leftJoin ,
rightJoin ,
fullJoin ,
union ,
unionAll ,
///
creating ,
deleting ,
dropping ,
replacing ,
selecting ,
inserting ,
altering ,
get_results ,
table_setup ,
set_table ,
set_prefix ,
select_into ,
insert_select ,
create_select ,
};Para conocer el uso de funciones/documentos, consulte ezFunctions.php.
Se alientan y agradecen las contribuciones; Siempre me complace recibir comentarios o solicitudes de extracción en Github :) Cree problemas de Github para errores y nuevas funciones y comente los que le interesen.
ezsql es un software de código abierto con licencia original (LGPL-3.0) y las partes complementarias (MIT).
