Peyote

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

(★ 15)

A database query builder engine for PHP 5.3+

Peyote Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Peyote

A MySQL query builder engine for PDO which requires PHP 5.3.

## Installation

The easiest way to install Peyote is by adding this line to your
[composer.json](http://getcomposer.org/) file.

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

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.

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

``` sql
SELECT * FROM user WHERE user_id = ?
```

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"
);

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

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

## 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);

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

## 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`.

Please see the test folder for more usage examples.

_Note_: Using `serial` as the column type will give set the column as an INT, primary key,
not null, unsigned and auto increment.

### Alter

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

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

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

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

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

----

Developed by [Dave Widmer](http://www.davewidmer.net)

Peyote

Peyote Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Peyote

Peyote Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README