Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/viames/pair
a lightweight PHP framework as the air
https://github.com/viames/pair
active-record framework multilingual mvc pair php plugin-system rest-api router
Last synced: 3 months ago
JSON representation
a lightweight PHP framework as the air
- Host: GitHub
- URL: https://github.com/viames/pair
- Owner: viames
- License: mit
- Created: 2017-02-16T11:32:06.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T11:33:52.000Z (3 months ago)
- Last Synced: 2024-10-28T12:57:23.345Z (3 months ago)
- Topics: active-record, framework, multilingual, mvc, pair, php, plugin-system, rest-api, router
- Language: PHP
- Homepage: https://viames.github.io/pair
- Size: 1.03 MB
- Stars: 10
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://packagist.org/packages/viames/pair)
[](https://packagist.org/packages/viames/pair)
[](https://packagist.org/packages/viames/pair)
[](https://packagist.org/packages/viames/pair)
## Features
Pair is simple and fast, few frills, maybe none. It was written with simplicity in mind, while trying to achieve the most frequent needs of web applications. It implements [Model-View-Controller](https://en.wikipedia.org/wiki/Model-View-Controller) pattern and a search friendly [route logic](https://github.com/viames/pair/wiki/Router) by default.
Everyone knows that you do not need a truck to go shopping. You do not even need the car to go and buy the newspaper at the nearby newsstand. You need the right medium for everything.
If you’re already tired of starting a new web project due to the complexity of the famous frameworks used around, you should take a look at Pair. For a small or medium web project, it fits really well.
Pair acquires the logical connections of the database tables and automatically uses caching functions to reuse the data that has already been retrieved. While Pair sends the ready-made web page to the browser, some of the most popular frameworks haven't even loaded all the libraries yet.
Using also the advanced functions of Pair for the efficient management of the information already extracted from the DB, it is possible to create a web page of an application that reads millions of records and many related tables in an astounding time of just 10 ms.
#### ActiveRecord
Pair allows the creation of objects related to each respective database table using the [ActiveRecord class](https://github.com/viames/pair/wiki/ActiveRecord). Objects retrieved from the DB are cast in both directions to the required type (int, bool, DateTime, float, csv). See [Automatic properties cast](https://github.com/viames/pair/wiki/ActiveRecord#automatic-properties-cast) page in the wiki.
In addition, each class inherited from ActiveRecord supports many convenient methods including those for caching data that save queries.
The Pair base tables are InnoDB utf-8mb4.
#### Plugins
Pair supports modules and templates as installable plugins, but can easily be extended to other types of custom plugins. The Pair’s Plugin class allows you to create the manifest file, the ZIP package with the contents of the plugin and the installation of the plugin of your Pair’s application.
#### Time zone
The automatic time zone management allows to store the data on UTC and to obtain it already converted according to the connected user’s time zone automatically.
#### Log bar
A nice log bar shows all the details of the loaded objects, the system memory load, the time taken for each step and for the queries, the SQL code of the executed queries and the backtrace of the detected errors. Custom messages can be added for each step of the code.
## Installation
### Composer
```sh
composer require viames/pair
```
After having installed Pair framework you can get singleton object `$app` and the just start MVC. You can check any session before MVC, like in the following example.
```php
use Pair\Application;
// initialize the framework
require 'vendor/autoload.php';
// intialize the Application
$app = Application::getInstance();
// any session
$app->manageSession();
// start controller and then display
$app->startMvc();
```
If you want to test code that is in the master branch, which hasn’t been pushed as a release, you can use master.
```
composer require viames/pair dev-master
```
If you don’t have Composer, you can [download it](https://getcomposer.org/download/).
## Documentation
Please consult the [Wiki](https://github.com/viames/pair/wiki) of this project. Below are its most interesting pages that illustrate some features of Pair.
* [ActiveRecord](https://github.com/viames/pair/wiki/ActiveRecord)
* [Application](https://github.com/viames/pair/wiki/Application)
* [Controller](https://github.com/viames/pair/wiki/Controller)
* [Form](https://github.com/viames/pair/wiki/Form)
* [Router](https://github.com/viames/pair/wiki/Router)
* [index.php](https://github.com/viames/pair/wiki/index)
* [.htaccess](https://github.com/viames/pair/wiki/htaccess)
* [config.php](https://github.com/viames/pair/wiki/Configuration-file)
* [classes](https://github.com/viames/pair/wiki/Classes-folder)
## Requirements
| Software | Recommended | Minimum | Configuration |
| --- | :---: | :---: | --- |
| Apache | 2.4+ | 2.2 | `modules:` mod_rewrite |
| MySQL | 8.0 | 5.6 | `character_set:` utf8mb4
`collation:` utf8mb4\_unicode_ci
`storage_engine:` InnoDB |
| PHP | 7.3+ | 7.0 | `extensions:` fileinfo, json, pcre, PDO, pdo_mysql, Reflection |
## Examples
The [pair_boilerplate](https://github.com/viames/pair_boilerplate) is a good starting point to build your new web project in a breeze with Pair PHP framework using the installer wizard.
## Contributing
If you would like to contribute to this project, please feel free to submit a pull request.
# License
MIT