Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/phpMv/ubiquity
Ubiquity framework
https://github.com/phpMv/ubiquity
framework mvc orm performance php ubiquity
Last synced: 3 months ago
JSON representation
Ubiquity framework
- Host: GitHub
- URL: https://github.com/phpMv/ubiquity
- Owner: phpMv
- License: apache-2.0
- Created: 2016-06-29T00:20:49.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-06-18T14:46:11.000Z (about 1 year ago)
- Last Synced: 2024-03-14T05:43:17.134Z (4 months ago)
- Topics: framework, mvc, orm, performance, php, ubiquity
- Language: PHP
- Homepage: https://ubiquity.kobject.net
- Size: 24.7 MB
- Stars: 680
- Watchers: 24
- Forks: 63
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: docs/security/acl.rst
Lists
- awesome-swoole - Ubiquity - A powerful and fast framework for efficient design. (Frameworks)
- docsify-awesome-stars - phpMv/ubiquity - Ubiquity framework (PHP)
README
[](https://scrutinizer-ci.com/g/phpMv/ubiquity/?branch=master) [](https://scrutinizer-ci.com/g/phpMv/ubiquity/?branch=master) [](http://micro-framework.readthedocs.io/en/latest/?badge=latest)
[](https://packagist.org/packages/phpmv/ubiquity)
[](https://packagist.org/packages/phpmv/ubiquity)
[](https://packagist.org/packages/phpmv/ubiquity)
[](//packagist.org/packages/phpmv/ubiquity)
[](https://gitter.im/ubiquity-framework/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[Ubiquity](https://ubiquity.kobject.net), a powerful and fast framework for efficient design.
# Main features
- MVC or Domain Driven Design with MVC
- Dependency injection
- PSR-4 Autoloader
- Router based on annotations/attributes
- ORM implementing Data Mapper
- Multi-databases & multi-database types support (PDO Mysql/PostgreSQL/SQLite, Mysqli, Swoole coroutine Mysql, Tarantool, MongoDB)
- Multi-level cache
- Rest Server
- Web admin interface (Webtools)
- Scaffolding (CRUD, REST, Controllers, views, authentification...)
- Console Admin interface (Devtools)
- Assets & themes management (since 2.1.0, on a [proposal](https://github.com/phpMv/ubiquity/issues/11) from [@Gildonei](https://github.com/gildonei))
- Managed servers: fpm/fastcgi with Apache or nginX, [ngx_php](https://github.com/rryqszq4/ngx_php7), [Workerman](https://github.com/walkor/Workerman), [Swoole](https://github.com/swoole/swoole-src), [Roadrunner](https://github.com/Lapinskas/roadrunner-ubiquity), [PHP-PM](https://github.com/php-pm/php-pm) with ReactPHP (Dev only)
- Multi template engines support: [Twig](https://twig.symfony.com/)(default), [Latte](https://latte.nette.org/en/) and [Plates](https://platesphp.com/) since 2.5.2
# Upgrade
If Ubiquity devtools are already globally installed, and you want to upgrade to the lastest stable version:
```bash
composer global update
```
For an existing project (in the root folder):
```bash
composer update
```
# Project creation
The easiest way to create a project is to use composer **create-project** command:
Creation of the project **firstProject**
```bash
composer create-project phpmv/ubiquity-project firstProject
```
This installation adds [devtools](https://github.com/phpMv/ubiquity-devtools) and [webtools](https://github.com/phpMv/ubiquity-webtools) to the project.
- Running the server with `vendor/bin/Ubiquity serve`
- **webtools** available at `http://127.0.0.1:8090/Admin`
## Devtools installation
It is also possible to install [devtools](https://github.com/phpMv/ubiquity-devtools) globally, to share their use between different projects, and to get more options for a project creation.
* Install Ubiquity-devtools:
```bash
composer global require phpmv/ubiquity-devtools
```
* Create a project:
```bash
Ubiquity new firstProject -a
```
* Start the server:
```bash
Ubiquity serve
```
# Need some help?
Ubiquity is a recent project and does not yet have a large community.
In the meantime, you can consult:
- [Quick-start guide with devtools](https://micro-framework.readthedocs.io/en/latest/quickstart/quickstart.html) to discover the framework with the cli program
- [Quick-start guide with webtools](https://micro-framework.readthedocs.io/en/latest/quickstart/quickstart-html.html) to discover the framework with the webtools interface
- [Documentation](https://micro-framework.readthedocs.io/en/latest/) to go deeper
- [API documentation](http://api.kobject.net/ubiquity/) to search further
For further assistance please feel free to :
- ask your questions directly using [gitter](https://gitter.im/ubiquity-framework/community)
- create an [issue](https://github.com/phpMv/ubiquity/issues/new?assignees=jcheron&labels=&template=bug_report.md&title=%5Bpart%5D+Element+should+do+X) if you notice a bug or a suspicious behavior
# Performances
Ubiquity is very fast and performs well.
### In the PHP world
The various results of the [Techempower benchmarks](https://www.techempower.com/benchmarks) show this conclusively.
#### TechEmpower Multiple queries test (*) (see [PHP frameworks results](https://www.techempower.com/benchmarks/#section=test&runid=d6f9832a-d586-478c-84a0-8a89cccfcc2a&hw=ph&test=query&l=yyku7z-e7&c=c&a=2&o=c))
These excellent results have also been confirmed by an independent benchmark site : [phpbenchmarks.com](http://www.phpbenchmarks.com/en/comparator/framework)
### In the world of web frameworks
**Ubiquity** is optimized for use with asynchronous platforms (**Workerman** and **Swoole**). It takes advantage of the recent PHP evolutions (opCache management and preloading). In this context, it performs against the fastest Frameworks written in C, C++, Rust or java:
#### TechEmpower 20 updates test (*) (see [All frameworks results](https://www.techempower.com/benchmarks/#section=test&runid=d6f9832a-d586-478c-84a0-8a89cccfcc2a&hw=ph&test=update&c=e&a=2&o=e))
(*) Only tests with Framework and ORM are considered.
# About design choices
Ubiquity was created in April 2017.
The project tries to simplify the development process, and empowers web developers who delivering value through their applications.
It aims to combine performance and ease of handling.
This dual purpose has led to some design choices:
>Get inspired by the best practices and successful concepts from other frameworks, but do not try to reproduce things that are not a part of the logic of PHP.
Some PHP frameworks were inspired by the Java world, which has contributed to more professional php development.
But java is not PHP : the environments and languages are completely different (though their syntax is similar). What is good in Java is not necessarily in PHP.
Ubiquity wants to keep the essence of PHP and what it does best, for example:
- By using php (packed) arrays because they are effective in php (with php7 optimization)
- By not creating instances of classes to inject for the core part of the framework, to prefer the use of classes with static methods
Overall, Ubiquity wants to keep and use what PHP is good at.
In this perspective, Ubiquity chooses not to respect certain standards:
For example, by not creating a Response object implementing an interface (see [PSR-7 HTTP message interfaces](https://www.php-fig.org/psr/psr-7/) ) in response to an Http request.
>Not multiplying the ways of doing things.
If a method or technique is optimal, there's no reason to implement an alternative version, especially if there is a risk of degrading the performance or complicating the handling of the framework.
>Avoiding multiple external dependencies, which are sometimes loaded when they are never used.
- They prevent the developer from optimizing his own code.
- In some applications, the dependency loading time is more expensive than running the application code.
The framework used must give the developer the means to optimize his application and not the other way around.
Ubiquity aspires to never become another labyrinthine system.
# Preview of some features
## Devtools console program
```bash
Ubiquity help
```
The console mode makes it easy to perform all the repetitive tasks related to the design of projects:
- creations : project, controllers, actions, routes, models, views,
- checking : routes, models, validators
- scaffolding (CRUD + authentification)
## Scaffolding
Generation of the CRUD elements for a model class with devtools :
```bash
Ubiquity crud --resource=Developers --path=/devs/
```
The generated route **/devs/** provides an entry point for CRUD operations:
## Admin interface
Like the console, the administration interface makes it possible to act on the main components of the framework.
When creating a project, it can be installed with the **-a** option.
```bash
ubiquity new firstProject -a
```
# Graphic design
- Ubiquity logos and banner: [@richardbmx](https://github.com/richardbmx)
# Donations
You can tell us your pleasure in using Ubiquity, giving us a star,
and you can do even better by [contributing](https://github.com/phpMv/ubiquity/blob/master/CONTRIBUTING.md)...
Thank you!