Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/milesq/nyxt
Simple and modern PHP framework
https://github.com/milesq/nyxt
backend framework php
Last synced: 9 days ago
JSON representation
Simple and modern PHP framework
- Host: GitHub
- URL: https://github.com/milesq/nyxt
- Owner: Milesq
- Created: 2021-01-24T14:21:17.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-01-11T16:23:38.000Z (about 3 years ago)
- Last Synced: 2025-02-03T20:53:18.854Z (9 days ago)
- Topics: backend, framework, php
- Language: PHP
- Homepage:
- Size: 55.7 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# Nyxt - modern & simple PHP framework
## Installation
You use this framework by [composer](https://getcomposer.org/)
`composer require milesq/nyxt`
## Out of the box
What is included in this package?
- Routing based on file system (custom 404, public directory)
- Twig template engine
- Form validation based on rakit/validation
- Simple a'la ORM to help you manage your database (based on clancats/hydrahon)
## Using
Check our `examples/` directory
### Before start
Nyxt have a small boilerplate. You must redirect all requests (except request which starts from `/public`) to index.php
Example configuration for Apache
```apache
RewriteEngine On
RewriteRule ^(app|dict|ns|tmp)\/|\.ini$ - [R=404]
RewriteCond %{REQUEST_FILENAME} !-l
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(?!public/)(.+)$ index.php [L,QSA]
RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization},L]
```
Now you can simply run framework from `index.php`
```php
run();
```
Then create a folder named `controllers`.
This directory is the place for your routes.
Inside controller files you must declare class
called `Handler` which extends from `\Nyxt\Controller`.
This class should have public handle function which will
be invoked when someone sends a request to your endpoint.
Example of handler
```php
id`
For the following file structure, the following paths will be available:
```
| .htaccess
| index.php
|
\---controllers
| index.php /
|
\---user
\---_id
create.php /user/what-ever/create
_action.php /user/what-ever/name-of-action
```
Check `examples/routing` for more tips
### Templates
Inside `templates/`directory you can place
twig templates, nextly you can render
them inside controller by `$this->render($name, $parametersAsAssocTable)`
**Important** Remember to set environment
variable `NYXT_MODE` to production on deploy server.
In development mode, cache is not used.
You can set template params through for a few ways
E.g.
```php
class Handler extends \Nyxt\Controller {
public function handle() {
// You can declare template arguments like:
$this->by_property = "hello";
$this->reset();
$this
->setByMethod("hello")
->setChainMethod("world")
->unset('chainMethod');
$this->render('index', ['by_arg' => 1]);
}
}
```
### Validation
Every handler can declare `validate` method.
The method will be invoked with `$v`
parameter which is an instance of `\Rakit\Validation\Validator`.
Check out [https://github.com/rakit/validation](https://github.com/rakit/validation)
The `validate` method must tell Next if the validation passed
via return boolean or string.
### Error 404 - not found
You can apply your own 404 page by add `[error].html`
template or `404.html` in public directory
### Using DB
ORM is based on clancats/hydrahon,
so check out [docs](https://clancats.io/hydrahon/master/)
and `examples/orm`
To create a model, you need to create a file
named which is a singular form of the db table.
Example model:
```php
findByDocked(true);
}
}
```
How can we use this model?
When `Handler` class is decorated with `#[nyxt('orm')]`
every model will be injected to handler
```php
#[nyxt('orm')]
class Handler extends \Nyxt\Controller {
function handle() {
$this->bikes->docked()->where('id', '>', 3)->get();
}
}
```
To learn how exactly can u build queries take a look for hydrahon docs
#### **Important**
Now you may be asking "how does Nyxt connect to the database?"
Answer: If your app is using db, you must change index.php a little and provide db connector as the first argument of constructor of \Nyxt\Base
E.g.
```php
$framework = new \Nyxt\Base(function() {
return new PDO("mysql:host=localhost;dbname=test", "username", "pass");
});
```