Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexsasharegan/model-framework
Make getting started with data-driven apps easier by using some solid model classes and database abstractions.
https://github.com/alexsasharegan/model-framework
database dbal framework micro-framework orm php
Last synced: 8 days ago
JSON representation
Make getting started with data-driven apps easier by using some solid model classes and database abstractions.
- Host: GitHub
- URL: https://github.com/alexsasharegan/model-framework
- Owner: alexsasharegan
- Created: 2016-11-28T01:25:20.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-06T21:50:15.000Z (about 7 years ago)
- Last Synced: 2024-04-15T04:31:22.034Z (7 months ago)
- Topics: database, dbal, framework, micro-framework, orm, php
- Language: PHP
- Size: 74.2 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# PHP Model Framework
[](https://packagist.org/packages/alexsasharegan/model-framework)
[](https://packagist.org/packages/alexsasharegan/model-framework)
[](https://packagist.org/packages/alexsasharegan/model-framework)
[](https://packagist.org/packages/alexsasharegan/model-framework)
A lightweight, PDO & MySQL-based data modeling framework in PHP strongly inspired by Laravel & Underscore/Lodash.
## Why Another Library
This library has been developed in a production environment to alleviate the difficulties of working with PHP and MySQL.
Developing in the `[LMW]AMP` stack affords the benefits of a high availability of deployment environments. Unfortunately, this also means dealing with the quirks of an inconsistent PHP language API and poor MySQL data type translations to PHP.
This is where the **model-framework** comes in. You can work with models & collections that provide a more consistent API wrapper around PHP, and define casts the work under the hood to enforce the type integrity of the data on your models.
PDO is a great way to interact with MySQL in PHP while simultaneously reducing the potential for injection attacks. This library uses prepared queries under the hood to help you get started with PDO right out of the box. Use simple methods like `Model::removePropsNotInDatabase()` to query your object's table and strip out any fields not defined in your table.
Not familiar with *Object-Oriented PHP*? The model class implements interfaces like **ArrayAccess** and **Traversable** so you can interact with it like a normal associative array, while still getting all the internal data type enforcement.
## Getting Started
Using Composer, load up the library:
```bash
composer require alexsasharegan/model-framework
```
This library uses the `vlucas/phpdotenv` library to connect models to your database (_already included_).
Start by creating a `.env` file with these database connection variables defined:
```bash
DB_HOST=localhost
DB_DATABASE=sandbox
DB_PORT=3306
DB_CHARSET=utf8
DB_USERNAME=root
DB_PASSWORD=root
```
Now load the environment:
```php
load();
// also a nice place to set things like timezone & session
date_default_timezone_set('America/Phoenix');
session_start();
} );
```
Now extend the abstract `\Framework\Model` class to get all the functionality:
```php
self::CAST_TO_INT,
'deleted' => self::CAST_TO_BOOL,
'float' => self::CAST_TO_FLOAT,
'price' => self::CAST_TO_PRICE,
'special' => self::CAST_FROM_JSON_TO_ARRAY,
'specialObject' => self::CAST_FROM_JSON_TO_OBJECT,
];
}
// Convenient static methods return instances
// this returns a model instance with the data from this id
// already parsed, or an empty model
$character = Character::fetch( 65 );
// Models implement ArrayAccess interface,
// but they still enforce the internal cast instructions
// as well as returning NULL when an index isn't defined
// instead of throwing an exception
$character['special'] = [
'key' => [
'nested' => 'value',
],
'prop' => TRUE,
];
echo $character->toJson( JSON_PRETTY_PRINT );
$newCharacter = Character::fetch( 655 );
$newCharacter->mergeData( [
'first_name' => 'Jamie',
'last_name' => 'Lanaster',
'special' => [
'house' => [
'name' => 'Lanaster',
'words' => 'A Lanaster always pays his debts.',
'sigil' => 'Lion',
],
],
'price' => 12.3493046,
'deleted' => FALSE,
'fakeField' => "I'm not in your database...",
] );
// a handy dot notation syntax is available from the model as a __get magic method
echo $newCharacter['special.house.name'];
// Lanaster
// The benefits of the Traversable interface
foreach ( $newCharacter as $key => $value )
{
$type = gettype( $value );
echo "Prop: $key ($type): " . print_r( $value, TRUE ) . PHP_EOL;
}
echo PHP_EOL;
// Retrieves the fields from the database,
// then filters the properties on the object
// so you can further prevent injection
// (prepared queries are also used for data binding)
$newCharacter->removePropsNotInDatabase();
foreach ( $newUser as $key => $value )
{
$type = gettype( $value );
echo "Prop: $key ($type): " . print_r( $value, TRUE ) . PHP_EOL;
}
echo PHP_EOL;
```
## Dependencies
This library uses the following dependencies directly:
- [vlucas/phpdotenv](https://github.com/vlucas/phpdotenv)
- environment variable declaration
- [twig/twig](https://github.com/twigphp/Twig)
- template engine for container
- [twig/extensions](https://github.com/twigphp/Twig-extensions)
- extra features for template engine
- [slim/pdo](https://github.com/FaaPz/Slim-PDO)
- PDO extension classes for OOP queries
- Mostly implemented under the hood in the model classes
- [nesbot/carbon](https://github.com/briannesbitt/Carbon)
- used for timestamping models