Skip to content

Small edits #2

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
Jan 10, 2023
Merged

Small edits #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c363b97
Update README
jason-napolitano Jan 10, 2023
aee9412
Update README
jason-napolitano Jan 10, 2023
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
159 changes: 4 additions & 155 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
<h1 style="text-align: center !important;">
<img src="https://www.svgrepo.com/show/224774/database.svg" alt="Logo" style="width: 9.0rem; margin-right: 0.5rem;">

DatabaseFactory
</h1>
# DatabaseFactory

Please note that this library is still in heavy development stages and is in no way ready for production use.
___

<div style="text-align: justify !important;">

> The aim of DatabaseFactory is to give PHP application developers a means
> to securely and efficiently interact with, manage and manipulate their databases with a simple,
> and intuitive API.
Expand Down Expand Up @@ -43,8 +39,6 @@ ___
libraries
corresponding documentation files in _markdown_ format.

</div>

### Features

- Object Relational Mapper (ORM)
Expand All @@ -61,154 +55,11 @@ ___
- PHP 8.2
- PDO

### How to get started

#### configure an `.env` file and assign your credentials

```dotenv
DB_HOSTNAME=127.0.0.1
DB_DATABASE=database_name
DB_USERNAME=root
DB_PASSWORD=password
DB_DRIVER=mysql
```

#### set up the library

> **DatabaseFactory** is extremely easy to set up. With just a few lines of code, you'll
> be up and running in not time flat. Simply configure your `env`, start a PDO connection
> and you're ready to work with your data.

```php
// first, we load the env configuration variables
DatabaseFactory\Helpers\Env::init(__DIR__); // path to the .env file

// next, we establish a new connection
DatabaseFactory\Facades\DB::connect();

// now, we're ready to get started!
// ...
```

<div style="text-align: justify !important;">

### Retrieving data

> The **DatabaseFactory** API provides several methods for returning data. This includes returning JSON, XML and raw
> PHP.
> These methods are `get()`, `toArray()`, `toJSON()` and `toXML()`.

</div>

##### using the ORM

```php
// generate the query
$mapper = User::where('name', '<>', '');

// dump the data
Helpers\Debug::dump($mapper->get());
```

##### using the query builder

```php
// generate the query
$builder = Facades\DB::table('users');
$builder->select('email')->where('name', '=', 'Mark');

// dump the data
Helpers\Debug::dump($builder->get());
```

##### using the ORM _with_ the query builder

```php
// generate the query
$combined = User::where('name', '<>', '')->limit(5)->offset(5);

// dump the data
Helpers\Debug::dump($combined->get());
```

### Creating and updating data

##### create a new entity object

```php
// this class MUST extend the base entity class
class User extends \DatabaseFactory\Entity
{
// all fields you want to work with are properties
// within this class
public string $name;
public string $email;
}
```

##### creating data using the entity object

```php
$user = new User();
$user->name = 'Manny Moreno';
$user->email = 'mmoreno@gmail.com';
$user->save();
```

##### updating data using the entity object

```php
// we pass through the ID of the record we want
// to work with
$user = new User(15);
$user->name = 'Garry Williams';
$user->email = 'gwilliamslas@gmail.com';
$user->save();
```

#### Advanced Usage

<div style="text-align: justify !important;">

> **DatabaseFactory** is meant to be extremely robust. Using the ORM and the query builder
> in conjunction with one another, you can build some rather complex queries. For example,
> here is a more comprehensive query that can be generated with **DatabaseFactory**.
>
> For example ...

</div>

```php
App\Entities\User::join('users_roles', 'users.id, users.name, users.email', ['users_roles.user_id', 'users.id'])
->and('users.email', '<>', '')
->and('users.name', '<>', '')
->andLike('users.email', 'proton')
->notLike('users.email', 'gmail')
->groupBy('users_roles.user_id, users.id')
->orderBy('users.id', 'DESC')
->limit(10)
->offset(5);
```

> ... would execute the following query:

```mysql
SELECT users.id, users.name, users.email
FROM users
INNER JOIN users_roles ON users_roles.user_id = users.id
AND users.email <> ''
AND users.name <> ''
AND users.email LIKE '%proton%'
WHERE users.email NOT LIKE '%gmail%'
GROUP BY users_roles.user_id, users.id
ORDER BY users.id DESC
LIMIT 10 OFFSET 5
```
### Getting Started
> To get a good idea of how to implement and use **DatabaseFactory**, I would advise that you look at the _Wiki Pages_, by going [here](https://github.com/DatabaseFactory/framework/wiki).

### License

<div style="text-align: justify !important;">

&copy; 2022 - **DatabaseFactory** is released under the MIT license

Permission is hereby granted, free of charge, to any person obtaining a copy
Expand All @@ -227,6 +78,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

</div>
SOFTWARE.