Skip to content

readme updates #220

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 26, 2015
Merged

readme updates #220

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1f7b99e
Added installation via composer into readme
avbdr Apr 26, 2015
a204875
Couple typo fixed in readme
avbdr Apr 26, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 21 additions & 8 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,21 +19,33 @@ MysqliDb -- Simple MySQLi wrapper with prepared statements
**[Helper Functions](#helper-commands)**
**[Transaction Helpers](#transaction-helpers)**

### Initialization
### Installation
To utilize this class, first import MysqliDb.php into your project, and require it.

```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:
```php
$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
```php
$db = new Mysqlidb (Array (
$db = new MysqliDb (Array (
'host' => 'host',
'username' => 'username',
'password' => 'password',
Expand All @@ -46,7 +58,7 @@ port and charset params are optional.
Reuse already connected mysqli:
```php
$mysqli = new mysqli ('host', 'username', 'password', 'databaseName');
$db = new Mysqlidb ($mysqli);
$db = new MysqliDb ($mysqli);
```

Its also possible to set a table prefix:
Expand All @@ -62,15 +74,15 @@ Simple example
$data = Array ("login" => "admin",
"firstName" => "John",
"lastName" => 'Doe'
)
$id = $db->insert('users', $data);
);
$id = $db->insert ('users', $data);
if($id)
echo 'user was created. Id='.$id;
echo 'user was created. Id=' . $id;
```

Insert with functions use
```php
$data = Array(
$data = Array (
'login' => 'admin',
'active' => true,
'firstName' => 'John',
Expand Down Expand Up @@ -139,7 +151,7 @@ $stats = $db->getOne ("users", "sum(id), count(*) as cnt");
echo "total ".$stats['cnt']. "users found";
```

or select one column or function result
or select one column value or function result

```php
$count = $db->getValue ("users", "count(*)");
Expand Down Expand Up @@ -190,6 +202,7 @@ print_r ($results); // contains Array of returned rows

### Where Method
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.

Regular == operator with variables:
Expand Down