2017 © Pedro Peláez
 

library peyote

A database query builder for PHP 5.3+

image

davewid/peyote

A database query builder for PHP 5.3+

  • Tuesday, February 11, 2014
  • by davewid
  • Repository
  • 3 Watchers
  • 17 Stars
  • 806 Installations
  • PHP
  • 2 Dependents
  • 0 Suggesters
  • 2 Forks
  • 0 Open issues
  • 12 Versions
  • 0 % Grown

The README.md

Peyote

A MySQL query builder engine for PDO which requires PHP 5.3., (*1)

Installation

The easiest way to install Peyote is by adding this line to your composer.json file., (*2)

``` json "require":{ "davewid/peyote": "0.6.*" },, (*3)


Optionally you can download the source of this repo and move over the `classes`
folder.

## Standards

Peyote follows both the [PSR-0](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md)
and [PSR-1](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md)
standards.

There isn't an autoloader included with the library though so you will need to
set that up yourself. If you use [Composer](http://getcomposer.org/) to install
the dependency _(highly recommended)_ then you won't have to worry about anything
as Composer will take care of it all.

## Example

I'll start out with a full example on how to use the library and break it down
as we go along.

``` php
// Create a PDO instance
$pdo = new PDO($dsn, $user, $password);

// Create a SELECT query
$query = new \Peyote\Select('user');
$query->where('user_id', '=', 1);

// Build the PDOStatement
$statement = $pdo->prepare($query->compile());

// Run the query
$statement->execute($query->getParams());

// Fetch results
$results = $statement->fetchAll();

Why the getParams() call?

Keeping your queries safe from SQL injection is out of the scope of this library so Peyote uses ? placeholders instead and keeps track of all the data you enter., (*4)

If you would echo out $query->compile() you would see this., (*5)

``` sql SELECT * FROM user WHERE user_id = ?, (*6)


At this point `getParams()` will return an array holding the values you passed in,
_(in this case, 1)_.

PDO will handle the placeholder replacement during `execute()` keeping
you a lot safer from SQL injection.

## Select

``` php
$query = new \Peyote\Select('user');
$query->where('user_id', '=', 1);

echo $query->compile();
// output: SELECT * FROM user WHERE user_id = ?

Insert

``` php $data = array( 'email' => "testing@foo.com", 'password' => "youllneverguess" );, (*7)

$query = new \Peyote\Insert('user'); $query->columns(array_keys($data))->values(array_values($data));, (*8)

echo $query->compile(); // output: INSERT INTO user (email, password) VALUES (?, ?), (*9)


## Update

``` php
$data = array(
    'password' => "iguesssomebodyguessed"
);

$query = new \Peyote\Update('user');
$query->set($data)->where('user_id', '=', 1);

echo $query->compile();
// output: UPDATE user SET password = ? WHERE user_id = ?

Delete

``` php $query = new \Peyote\Delete('user'); $query->where('user_id', '=', 1);, (*10)

echo $query->compile(); // output: DELETE FROM user WHERE user_id = ?, (*11)


## Table Statements

As of version 0.6.0, Peyote now comes bundled with statements to help create, alter
and drop tables.

### Create

``` php
$query = new \Peyote\Create('user');
$query->setColumns(array(
  // Add Columns here....
));

echo $query->compile();
// output: CREATE TABLE user ( {columns here...} ) ENGINE=MyISAM DEFAULT CHARSET=utf8

Columns

There are 2 ways to create a column. The first is just to type out the raw SQL as as string. The second is to use a \Peyote\Column., (*12)

Please see the test folder for more usage examples., (*13)

Note: Using serial as the column type will give set the column as an INT, primary key, not null, unsigned and auto increment., (*14)

Alter

``` php $query = new \Peyote\Alter('user');, (*15)

// As string... $query->addColumn('activated TINYINT NOT NULL');, (*16)

// As Column... $column = new \Peyote\Column('activated', 'TINYINT', array('is_null' => false)); $query->addColumn($column);, (*17)

echo $query->compile(); // Output: 'ALTER TABLE user ADD activated TINYINT NOT NULL';, (*18)


### Drop
``` php
$query = new \Peyote\Drop('user');
echo $query->compile();
// Output: DROP TABLE user

Developed by Dave Widmer, (*19)

The Versions

11/02 2014

dev-master

9999999-dev https://github.com/daveWid/Peyote

A database query builder for PHP 5.3+

  Sources   Download

MIT

The Requires

  • php >=5.3

 

The Development Requires

by Dave Widmer

database mysql query builder

11/02 2014

0.7.2

0.7.2.0 https://github.com/daveWid/Peyote

A database query builder for PHP 5.3+

  Sources   Download

MIT

The Requires

  • php >=5.3

 

The Development Requires

by Dave Widmer

database mysql query builder

05/11 2013

0.7.1

0.7.1.0 https://github.com/daveWid/Peyote

A database query builder for PHP 5.3+

  Sources   Download

MIT

The Requires

  • php >=5.3

 

The Development Requires

by Dave Widmer

database mysql query builder

21/08 2013

0.7.0

0.7.0.0 https://github.com/daveWid/Peyote

A database query builder for PHP 5.3+

  Sources   Download

MIT

The Requires

  • php >=5.3

 

The Development Requires

by Dave Widmer

database mysql query builder

16/08 2013

0.6.3

0.6.3.0 https://github.com/daveWid/Peyote

A database query builder for PHP 5.3+

  Sources   Download

MIT

The Requires

  • php >=5.3

 

by Dave Widmer

database mysql query builder

16/08 2013

0.6.2

0.6.2.0 https://github.com/daveWid/Peyote

A database query builder for PHP 5.3+

  Sources   Download

MIT

The Requires

  • php >=5.3

 

by Dave Widmer

database mysql query builder

29/04 2013

0.6.1

0.6.1.0 https://github.com/daveWid/Peyote

A database query builder for PHP 5.3+

  Sources   Download

MIT

The Requires

  • php >=5.3

 

by Dave Widmer

database mysql query builder

12/02 2013

0.6.0

0.6.0.0 https://github.com/daveWid/Peyote

A database query builder for PHP 5.3+

  Sources   Download

MIT

The Requires

  • php >=5.3

 

by Dave Widmer

database mysql query builder

05/02 2013

0.5.2

0.5.2.0 https://github.com/daveWid/Peyote

A database query builder for PHP 5.3+

  Sources   Download

MIT

The Requires

  • php >=5.3

 

by Dave Widmer

database mysql query builder

05/11 2012

0.5.1

0.5.1.0 https://github.com/daveWid/Peyote

A database query builder for PHP 5.3+

  Sources   Download

MIT

The Requires

  • php >=5.3

 

by Dave Widmer

database mysql query builder

09/07 2012

0.5.0

0.5.0.0 https://github.com/daveWid/Peyote

A database query builder for PHP 5.3+

  Sources   Download

MIT

The Requires

  • php >=5.3

 

by Dave Widmer

database mysql query builder

06/07 2012

0.3.0

0.3.0.0 https://github.com/daveWid/Peyote

A database query builder for PHP 5.3+

  Sources   Download

MIT

The Requires

  • php >=5.3

 

by Dave Widmer

database mysql query builder