Download the PHP package tallieutallieu/oak without Composer
On this page you can find all versions of the php package tallieutallieu/oak. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download tallieutallieu/oak
More information about tallieutallieu/oak
Files in tallieutallieu/oak
Informations about the package oak
Simple PHP building blocks framework
- Config
- Console
- Container
- Dispatcher
- Filesystem
- Logger
- Scheduler
- Session
Install
Creating an application
The example above only registers the Console component. This is an easy example since the Console component doesn't depend on any other components. To run the Console component, you'll have to get the Console\Kernel from your application handle the incoming Input:
To use the HTTP component (PSR-7 & PSR-15 compliant) you'll also have to register the Config component...and since the Config component reads configuration values from the filesystem, you'll also have to register the Filesystem component:
Handling an incoming request with the Http\Kernel goes as follows:
Config
Config commands
Console
Documentation coming soon
Container
Documentation coming soon
Cookie
Example usage
Cookie config options
| Name | Default |
|---|---|
| path | / |
| secure | false |
| http_only | true |
| same_site | Lax |
same_site accepts Lax, Strict or None. None is only valid together
with secure; combining it with an insecure cookie throws instead of letting
the browser silently drop the cookie.
securedefaults tofalse. Oak cannot know whether the host serves over TLS, so it does not assume it — which means a project that never writes aconfig/cookie.phpships its session cookie over plain HTTP. Setcookie.securetotruein every project that has TLS.
Dispatcher
Listening for an event class
An event name that is a class name binds its listeners to that class, so a listener can be typed for that class instead of for every event. Dispatch the event object itself: its class is the name, so the listeners are always handed an instance of the class they were registered for.
Static analysis knows this too: a listener registered for an event class sees
that class, even when its parameter is left untyped, so calling a method of the
event needs no instanceof guard.
A dispatched event object also reaches the listeners of its parent classes and of the interfaces it implements, after those of its own class. Stopping propagation stops all of them.
An event object is dispatched on its own: passing a second event next to it
throws an InvalidArgumentException. Dispatching by name, as in
Dispatcher::dispatch(InvoiceSend::class, $event), still works but reaches only
the listeners of that exact name. Static analysis requires $event to be an
InvoiceSend there, but cannot tell when it is left out altogether:
Dispatcher::dispatch(InvoiceSend::class) passes analysis and hands the
listeners null. Dispatching the object avoids that.
Any other name is a plain signal. Nothing is known about its event, so its listeners are handed whatever is dispatched, including nothing:
Isolating listeners
By default a listener that throws takes down every listener registered after it
and the throwable surfaces at the dispatch() call, which quietly makes
registration order load-bearing. A listener can opt out of that:
Nothing is swallowed: if no exception handler is configured, the remaining listeners still run and the first throwable is re-thrown once the event is finished.
The $eventName handed to the exception handler is the name the failing
listener was registered under. For a dispatched event object that can be a
parent class or an interface of the event.
Filesystem
Documentation coming soon
Logger
Example usage
Logger config options
| Name | Default |
|---|---|
| filename | logs/log.txt |
| date_format | d/m/Y H:i |
Session
Example usage
Rotating and clearing a session
Rotate the session id whenever the privilege level of the session changes — on
login above all — so that an id an attacker planted beforehand is worthless
afterwards. regenerate() mints a new id, carries the data over, drops the old
handler entry and rewrites the cookie:
Session config options
| Name | Default |
|---|---|
| handler | \Oak\Session\FileSessionHandler |
| path | sessions |
| name | app |
| cookie_prefix | session |
| identifier_length | 40 |
| lottery | 200 |
| max_lifetime | 1000 |
All versions of oak with dependencies
nyholm/psr7 Version ^1.8
nyholm/psr7-server Version ^1.1
psr/http-server-handler Version ^1.0
psr/http-server-middleware Version ^1.0
vlucas/phpdotenv Version ^5.7
dragonmantank/cron-expression Version ^3.6