Download the PHP package usmanhalalit/pixie without Composer
On this page you can find all versions of the php package usmanhalalit/pixie. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download usmanhalalit/pixie
More information about usmanhalalit/pixie
Files in usmanhalalit/pixie
Package pixie
Short Description A lightweight, expressive, framework agnostic query builder for PHP.
License MIT
Homepage https://github.com/usmanhalalit/pixie
Informations about the package pixie
This project is Not Actively Maintained but most of the features are fully working and there are no major security issues, I'm just not giving it much time.
Pixie Query Builder
A lightweight, expressive, framework agnostic query builder for PHP it can also be referred as a Database Abstraction Layer. Pixie supports MySQL, SQLite and PostgreSQL and it takes care of query sanitization, table prefixing and many other things with a unified API.
It has some advanced features like:
- Query Events
- Nested Criteria
- Sub Queries
- Nested Queries
- Multiple Database Connections.
The syntax is quite similar to Laravel's query builder.
Example
Simple Query:
The query below returns the row where id = 3, null if no rows.
Full Queries:
Query Events:
After the code below, every time a select query occurs on users
table, it will add this where criteria, so banned users don't get access.
There are many advanced options which are documented below. Sold? Let's install.
Installation
Pixie uses Composer to make things easy.
Learn to use composer and add this to require section (in your composer.json):
"usmanhalalit/pixie": "2.*@dev"
And run:
composer update
Library on Packagist.
Full Usage API
Table of Contents
- Connection
- Alias
- Multiple Connection
- SQLite and PostgreSQL Config Sample
- Query
- Select
- Get Easily
- Multiple Selects
- Select Distinct
- Get All
- Get First Row
- Get Rows Count
- Where
- Where In
- Where Between
- Where Null
- Grouped Where
- Group By and Order By
- Having
- Limit and Offset
- Join
- Multiple Join Criteria
- Raw Query
- Raw Expressions
- Insert
- Batch Insert
- Insert with ON DUPLICATE KEY statement
- Update
- Delete
- Transactions
- Get Built Query
- Sub Queries and Nested Queries
- Get PDO Instance
- Fetch results as objects of specified class
- Query Events
- Available Events
- Registering Events
- Removing Events
- Some Use Cases
- Notes
Connection
Pixie supports three database drivers, MySQL, SQLite and PostgreSQL. You can specify the driver during connection and the associated configuration when creating a new connection. You can also create multiple connections, but you can use alias for only one connection at a time.;
Alias
When you create a connection:
MyAlias
is the name for the class alias you want to use (like MyAlias::table(...)
), you can use whatever name (with Namespace also, MyNamespace\\MyClass
) you like or you may skip it if you don't need an alias. Alias gives you the ability to easily access the QueryBuilder class across your application.
When not using an alias you can instantiate the QueryBuilder handler separately, helpful for Dependency Injection and Testing.
$connection
here is optional, if not given it will always associate itself to the first connection, but it can be useful when you have multiple database connections.
SQLite and PostgreSQL Config Sample
Query
You must use table()
method before every query, except raw query()
.
To select from multiple tables just pass an array.
Get Easily
The query below returns the (first) row where id = 3, null if no rows.
Access your row like, echo $row->name
. If your field name is not id
then pass the field name as second parameter QB::table('my_table')->find(3, 'person_id');
.
The query below returns the all rows where name = 'Sana', null if no rows.
Select
Multiple Selects
Using select method multiple times select('a')->select('b')
will also select a
and b
. Can be useful if you want to do conditional selects (within a PHP if
).
Select Distinct
Get All
Return an array.
You can loop through it like:
Get First Row
Returns the first row, or null if there is no record. Using this method you can also make sure if a record exists. Access these like echo $row->name
.
Get Rows Count
Where
Basic syntax is (fieldname, operator, value)
, if you give two parameters then =
operator is assumed. So where('name', 'usman')
and where('name', '=', 'usman')
is the same.
Where In
Where Between
Where Null
Grouped Where
Sometimes queries get complex, where you need grouped criteria, for example WHERE age = 10 and (name like '%usman%' or description LIKE '%usman%')
.
Pixie allows you to do so, you can nest as many closures as you need, like below.
Group By and Order By
Multiple Group By
Using groupBy()
or orderBy()
methods multiple times groupBy('a')->groupBy('b')
will also group by first a
and than b
. Can be useful if you want to do conditional grouping (within a PHP if
). Same applies to orderBy()
.
Having
Limit and Offset
Join
Available methods,
- join() or innerJoin
- leftJoin()
- rightJoin()
If you need FULL OUTER
join or any other join, just pass it as 5th parameter of join
method.
Multiple Join Criteria
If you need more than one criterion to join a table then pass a closure as second parameter.
Raw Query
You can always use raw queries if you need,
You can also pass your bindings
Raw Expressions
When you wrap an expression with raw()
method, Pixie doesn't try to sanitize these.
NOTE: Queries that run through query()
method are not sanitized until you pass all values through bindings. Queries that run through raw()
method are not sanitized either, you have to do it yourself. And of course these don't add table prefix too, but you can use the addTablePrefix()
method.
Insert
insert()
method returns the insert id.
Batch Insert
In case of batch insert, it will return an array of insert ids.
Insert with ON DUPLICATE KEY statement
Update
Will update the name field to Sana and description field to Blah where id = 5.
Delete
Will delete all the rows where id is greater than 5.
Transactions
Pixie has the ability to run database "transactions", in which all database changes are not saved until committed. That way, if something goes wrong or differently then you intend, the database changes are not saved and no changes are made.
Here's a basic transaction:
If this were to cause any errors (such as a duplicate name or some other such error), neither data set would show up in the database. If not, the changes would be successfully saved.
If you wish to manually commit or rollback your changes, you can use the
commit()
and rollback()
methods accordingly:
Get Built Query
Sometimes you may need to get the query string, its possible.
getQuery()
will return a query object, from this you can get sql, bindings or raw sql.
Sub Queries and Nested Queries
Rarely but you may need to do sub queries or nested queries. Pixie is powerful enough to do this for you. You can create different query objects and use the QB::subQuery()
method.
This will produce a query like this:
SELECT * FROM (SELECT `cb_my_table`.*, (SELECT `details` FROM `cb_person_details` WHERE `person_id` = 3) as table_alias1 FROM `cb_my_table`) as table_alias2
NOTE: Pixie doesn't use bindings for sub queries and nested queries. It quotes values with PDO's quote()
method.
Get PDO Instance
If you need to get the PDO instance you can do so.
Fetch results as objects of specified class
Simply call asObject
query's method.
Furthermore, you may fine-tune fetching mode by calling setFetchMode
method.
Query Events
Pixie comes with powerful query events to supercharge your application. These events are like database triggers, you can perform some actions when an event occurs, for example you can hook after-delete
event of a table and delete related data from another table.
Available Events
- before-select
- after-select
- before-insert
- after-insert
- before-update
- after-update
- before-delete
- after-delete
Registering Events
Now every time a select query occurs on users
table, it will add this where criteria, so banned users don't get access.
The syntax is registerEvent('event type', 'table name', action in a closure)
.
If you want the event to be performed when any table is being queried, provide ':any'
as table name.
Other examples:
After inserting data into my_table
, details will be inserted into another table
Whenever data is inserted into person_details
table, set the timestamp field created_at
, so we don't have to specify it everywhere:
After deleting from my_table
delete the relations:
Pixie passes the current instance of query builder as first parameter of your closure so you can build queries with this object, you can do anything like usual query builder (QB
).
If something other than null
is returned from the before-*
query handler, the value will be result of execution and DB will not be actually queried (and thus, corresponding after-*
handler will not be called either).
Only on after-*
events you get three parameters: first is the query builder, third is the execution time as float and the second varies:
- On
after-select
you get theresults
obtained fromselect
. - On
after-insert
you get the insert id (or array of ids in case of batch insert) - On
after-delete
you get the query object (same as what you get fromgetQuery()
), from it you can get SQL and Bindings. - On
after-update
you get the query object likeafter-delete
.
Removing Events
Some Use Cases
Here are some cases where Query Events can be extremely helpful:
- Restrict banned users.
- Get only
deleted = 0
records. - Implement caching of all queries.
- Trigger user notification after every entry.
- Delete relationship data after a delete query.
- Insert relationship data after an insert query.
- Keep records of modification after each update query.
- Add/edit created_at and updated _at data after each entry.
Notes
- Query Events are set as per connection basis so multiple database connection don't create any problem, and creating new query builder instance preserves your events.
- Query Events go recursively, for example after inserting into
table_a
your event inserts intotable_b
, now you can have another event registered withtable_b
which inserts intotable_c
. - Of course Query Events don't work with raw queries.
If you find any typo then please edit and send a pull request.
© 2020 Muhammad Usman. Licensed under MIT license.