Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/milantex/milantex-daw
Database Access Wrapper for Milantex's projects.
https://github.com/milantex/milantex-daw
Last synced: 21 days ago
JSON representation
Database Access Wrapper for Milantex's projects.
- Host: GitHub
- URL: https://github.com/milantex/milantex-daw
- Owner: Milantex
- Created: 2017-04-25T19:21:12.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-05-18T09:42:49.000Z (over 7 years ago)
- Last Synced: 2024-11-15T21:44:26.635Z (about 2 months ago)
- Language: PHP
- Size: 20.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://travis-ci.org/Milantex/milantex-daw)
[](https://codecov.io/gh/Milantex/milantex-daw)
[](https://codeclimate.com/github/Milantex/milantex-daw)
[](https://packagist.org/packages/milantex/daw)
[](https://packagist.org/packages/milantex/daw)
[](https://packagist.org/packages/milantex/daw)
[](https://insight.sensiolabs.com/projects/39907987-6b7f-42ee-9ea9-aebb60ecc7e6)
# What is Milantex-DAW?
This package provides a mechanism to easily connect and use a MySQL/MariaDB database. Check the text below for information about how to install it and to see examples of how to use it.
## Installation
#### Using composer in the command line
You can use composer to install the package using the following command from within your project's source directory:
`composer require milantex/daw`
Make sure to update your autoloader if needed:
`composer dump-autoload -o`
#### Requiring the package as a dependency in composer.json
Add the following code to your composer.json. Here is an example of a composer.json file with the milantex/daw package required:
```javascript
{
"name": "your-name/your-project",
"description": "Your project's description",
"type": "project",
"license": "MIT",
"authors": [
{
"name": "Your Name",
"email": "[email protected]"
}
],
"require": {
"milantex/daw": "*"
}
}
```
Make sure to run the composer command to install dependencies:
`composer install`
## Using it in your project
To start using the DAW, first require the composer's autoload script:
```php
require_once 'vendor/autoload.php';
```
After that, you can create an instance of Milantex\DAW\DataBase:
```php
use Milantex\DAW\DataBase;
# Open a connection using the DAW
$daw = new DataBase('localhost', 'bayou', 'root', '');
```
Here is an example showing how you can select multiple records from the database and print it out:
```php
# Write an SQL query (no parameters)
$query1 = 'SELECT * FROM `post` WHERE `visible` = 1;';
# Execute the query and retrieve all result set rows
$visiblePosts = $daw->selectMany($query1);
# Print out the dump of the result
echo '
' . print_r($visiblePosts, true) . '
';
```
**Output:**
```html
Array
(
[0] => stdClass Object
(
[post_id] => 1
[created_at] => 2015-02-12 20:44:04
[user_id] => 1
[title] => Limitless Bayou begins
[link] => limitsless-bayou-begins
[content] => This is a sample post in a database.
[visible] => 1
)
)
```
Here is an example showing how you can select a single record from the database with an SQL query and named parameter placeholders:
```php
# Write an SQL query (with one parameter for the username)
$query2 = 'SELECT * FROM `user` WHERE `username` = :username AND `active` = 1;';
# Prepare the parameter associative array
$params2 = [ ':username' => 'milantex' ];
# Execute the query and retrieve a single result set
$user = $daw->selectOne($query2, $params2);
# Print out the dump of the result
echo '
' . print_r($user, true) . '
';
```
**Output:**
```html
stdClass Object
(
[user_id] => 1
[created_At] => 2015-02-12 20:41:12
[username] => milantex
[password] => SOME_HASH_VALUE
[active] => 1
)
```
Here is an example showing how you can delete records from the database using unnamed parameter placeholders (ordered):
```php
# Write an SQL query (with an unnamed parameter placeholder)
$query3 = 'DELETE FROM `post` WHERE `post_id` = ?;';
# Prepare the ordered parameter array
$params3 = [ 130 ];
# Execute the query and retrieve a single result set
$result3 = $daw->execute($query3, $params3);
# Check the result
if (!$result3) {
# Print out the dump of error information if the result is bad
echo '
' . print_r($daw->getLastExecutionError(), true) . '
';
} else {
# Print out how many records were affected
$affectedRows = $daw->getLastExecutionAffectedRownCount();
echo 'Deleted record count: ' . $affectedRows . '
';
}
```
**Output:**
```html
Deleted record count: 0
```
Here is an example showing how you can add a record to a table, again using named parameter placeholders:
```php
# Write an SQL query (with unnamed parameter placeholders)
$query4 = 'INSERT INTO `post` (`user_id`, `title`, `link`, `content`) '.
'VALUES (:user_id, :title, :link, :content);';
# Prepare the parameter associative array
$params4 = [
':user_id' => 1,
':title' => 'A test post',
':link' => 'a-test-post',
':content' => '
This is the content of the new test post.
'
];
# Execute the query and retrieve a single result set
$result4 = $daw->execute($query4, $params4);
# Check the result
if (!$result4) {
# Print out the dump of error information if the result is bad
echo '
' . print_r($daw->getLastExecutionError(), true) . '
';
} else {
# Get the ID of the new post
$postId = $daw->getLastInsertId();
echo 'The ID of the new post is: ' . $postId . '
';
}
```
**Output:**
```html
The ID of the new post is: 6
```