jstayton / miner
A dead simple PHP class for building SQL statements. No manual string concatenation necessary.
Installs: 11 499
Dependents: 0
Suggesters: 0
Security: 0
Stars: 252
Watchers: 20
Forks: 60
Open Issues: 0
Requires
- php: >=5.1.0
Requires (Dev)
This package is not auto-updated.
Last update: 2020-01-24 14:52:36 UTC
README
NOTICE: This project is deprecated and no longer maintained. If you'd like to continue supporting a forked version, please reach out on Twitter (@kidjustino) to have it listed here.
Miner
A dead simple PHP class for building SQL statements. No manual string concatenation necessary.
Developed by Justin Stayton while at Monk Development.
Requirements
- PHP >= 5.1.0
Installation
Composer
The recommended installation method is through
Composer, a dependency manager for PHP. Just add
jstayton/miner
to your project's composer.json
file:
{ "require": { "jstayton/miner": "*" } }
More details can be found over at Packagist.
Manually
- Copy
src/Miner.php
to your codebase, perhaps to thevendor
directory. - Add the
Miner
class to your autoloader orrequire
the file directly.
Getting Started
Composing SQL with Miner is very similar to writing it by hand, as much of the syntax maps directly to methods:
$Miner = new Miner(); $Miner->select('*') ->from('shows') ->innerJoin('episodes', 'show_id') ->where('shows.network_id', 12) ->orderBy('episodes.aired_on', Miner::ORDER_BY_DESC) ->limit(20);
Now that the statement is built,
$Miner->getStatement();
returns the full SQL string with placeholders (?), and
$Miner->getPlaceholderValues();
returns the array of placeholder values that can then be passed to your database connection or abstraction layer of choice. Or, if you'd prefer it all at once, you can get the SQL string with values already safely quoted:
$Miner->getStatement(false);
If you're using PDO, however, Miner makes executing the statement even easier:
$PDOStatement = $Miner->execute();
Miner works directly with your PDO connection, which can be passed during creation of the Miner object
$Miner = new Miner($PDO);
or after
$Miner->setPdoConnection($PDO);
Usage
SELECT
SELECT * FROM shows INNER JOIN episodes ON shows.show_id = episodes.show_id WHERE shows.network_id = 12 ORDER BY episodes.aired_on DESC LIMIT 20
With Miner:
$Miner->select('*') ->from('shows') ->innerJoin('episodes', 'show_id') ->where('shows.network_id', 12) ->orderBy('episodes.aired_on', Miner::ORDER_BY_DESC) ->limit(20);
INSERT
INSERT HIGH_PRIORITY shows SET network_id = 13, name = 'Freaks & Geeks', air_day = 'Tuesday'
With Miner:
$Miner->insert('shows') ->option('HIGH_PRIORITY') ->set('network_id', 13) ->set('name', 'Freaks & Geeks') ->set('air_day', 'Tuesday');
REPLACE
REPLACE shows SET network_id = 13, name = 'Freaks & Geeks', air_day = 'Monday'
With Miner:
$Miner->replace('shows') ->set('network_id', 13) ->set('name', 'Freaks & Geeks') ->set('air_day', 'Monday');
UPDATE
UPDATE episodes SET aired_on = '2012-06-25' WHERE show_id = 12 OR (name = 'Girlfriends and Boyfriends' AND air_day != 'Monday')
With Miner:
$Miner->update('episodes') ->set('aired_on', '2012-06-25') ->where('show_id', 12) ->openWhere(Miner::LOGICAL_OR) ->where('name', 'Girlfriends and Boyfriends') ->where('air_day', 'Monday', Miner::NOT_EQUALS) ->closeWhere();
DELETE
DELETE FROM shows WHERE show_id IN (12, 15, 20) LIMIT 3
With Miner:
$Miner->delete() ->from('shows') ->whereIn('show_id', array(12, 15, 20)) ->limit(3);
Methods
SELECT
INSERT
REPLACE
UPDATE
DELETE
OPTIONS
SET / VALUES
FROM
- from
- innerJoin
- leftJoin
- rightJoin
- join
- getFrom
- getFromAlias
- getFromString
- getJoinString
- mergeFromInto
- mergeJoinInto
WHERE
- where
- andWhere
- orWhere
- whereIn
- whereNotIn
- whereBetween
- whereNotBetween
- openWhere
- closeWhere
- getWherePlaceholderValues
- getWhereString
- mergeWhereInto
GROUP BY
HAVING
- having
- andHaving
- orHaving
- havingIn
- havingNotIn
- havingBetween
- havingNotBetween
- openHaving
- closeHaving
- getHavingPlaceholderValues
- getHavingString
- mergeHavingInto
ORDER BY
LIMIT
Statement
- execute
- getStatement
- getPlaceholderValues
- isSelect
- isInsert
- isReplace
- isUpdate
- isDelete
- __toString
- mergeInto
Connection
Feedback
Please open an issue to request a feature or submit a bug report. Or even if you just want to provide some feedback, I'd love to hear. I'm also available on Twitter as @kidjustino.
Contributing
- Fork it.
- Create your feature branch (
git checkout -b my-new-feature
). - Commit your changes (
git commit -am 'Added some feature'
). - Push to the branch (
git push origin my-new-feature
). - Create a new Pull Request.