Commit deba2950 authored by Alexander Butenko's avatar Alexander Butenko

Merge pull request #220 from avbdr/master

readme updates
parents de2a6173 a204875d
...@@ -19,21 +19,33 @@ MysqliDb -- Simple MySQLi wrapper with prepared statements ...@@ -19,21 +19,33 @@ MysqliDb -- Simple MySQLi wrapper with prepared statements
**[Helper Functions](#helper-commands)** **[Helper Functions](#helper-commands)**
**[Transaction Helpers](#transaction-helpers)** **[Transaction Helpers](#transaction-helpers)**
### Initialization ### Installation
To utilize this class, first import MysqliDb.php into your project, and require it. To utilize this class, first import MysqliDb.php into your project, and require it.
```php ```php
require_once ('MysqliDb.php'); require_once ('MysqliDb.php');
``` ```
### Installation with composer
It is also possible to install library via composer
```
composer require joshcam/mysqli-database-class:dev-master
```
### Initialization
Simple initialization with utf8 charset by default: Simple initialization with utf8 charset by default:
```php ```php
$db = new MysqliDb ('host', 'username', 'password', 'databaseName'); $db = new MysqliDb ('host', 'username', 'password', 'databaseName');
``` ```
Or in case usage of the namespaces:
```php
$db = new \MysqliDb ('host', 'username', 'password', 'databaseName');
```
Advanced initialization. If no charset should be set charset, set it to null Advanced initialization. If no charset should be set charset, set it to null
```php ```php
$db = new Mysqlidb (Array ( $db = new MysqliDb (Array (
'host' => 'host', 'host' => 'host',
'username' => 'username', 'username' => 'username',
'password' => 'password', 'password' => 'password',
...@@ -46,7 +58,7 @@ port and charset params are optional. ...@@ -46,7 +58,7 @@ port and charset params are optional.
Reuse already connected mysqli: Reuse already connected mysqli:
```php ```php
$mysqli = new mysqli ('host', 'username', 'password', 'databaseName'); $mysqli = new mysqli ('host', 'username', 'password', 'databaseName');
$db = new Mysqlidb ($mysqli); $db = new MysqliDb ($mysqli);
``` ```
Its also possible to set a table prefix: Its also possible to set a table prefix:
...@@ -62,15 +74,15 @@ Simple example ...@@ -62,15 +74,15 @@ Simple example
$data = Array ("login" => "admin", $data = Array ("login" => "admin",
"firstName" => "John", "firstName" => "John",
"lastName" => 'Doe' "lastName" => 'Doe'
) );
$id = $db->insert('users', $data); $id = $db->insert ('users', $data);
if($id) if($id)
echo 'user was created. Id='.$id; echo 'user was created. Id=' . $id;
``` ```
Insert with functions use Insert with functions use
```php ```php
$data = Array( $data = Array (
'login' => 'admin', 'login' => 'admin',
'active' => true, 'active' => true,
'firstName' => 'John', 'firstName' => 'John',
...@@ -139,7 +151,7 @@ $stats = $db->getOne ("users", "sum(id), count(*) as cnt"); ...@@ -139,7 +151,7 @@ $stats = $db->getOne ("users", "sum(id), count(*) as cnt");
echo "total ".$stats['cnt']. "users found"; echo "total ".$stats['cnt']. "users found";
``` ```
or select one column or function result or select one column value or function result
```php ```php
$count = $db->getValue ("users", "count(*)"); $count = $db->getValue ("users", "count(*)");
...@@ -190,6 +202,7 @@ print_r ($results); // contains Array of returned rows ...@@ -190,6 +202,7 @@ print_r ($results); // contains Array of returned rows
### Where Method ### Where Method
This method allows you to specify where parameters of the query. This method allows you to specify where parameters of the query.
WARNING: In order to use column to column comparisons only raw where conditions should be used as column name or functions cant be passed as a bind variable. WARNING: In order to use column to column comparisons only raw where conditions should be used as column name or functions cant be passed as a bind variable.
Regular == operator with variables: Regular == operator with variables:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment