folded / action
A pattern to organize your controllers with functions for you web app.
Requires
- php: >=7.4.0
- folded/exception: 0.4.*
Requires (Dev)
- friendsofphp/php-cs-fixer: 2.*
- pestphp/pest: 0.3.*
- phpunit/phpunit: 9.*
README
A pattern to organize your controllers with functions for you web app.
Summary
About
I created this package to organize my controllers by files. It also helps not loading all the resources needed for all my routes at each requests.
Folded is a constellation of packages to help you setting up a web app easily, using ready to plug in packages.
- folded/config: Configuration utilities for your PHP web app.
- folded/crypt: Encrypt and decrypt strings for your web app.
- folded/exception: Various kind of exception to throw for your web app.
- folded/history: Manipulate the browser history for your web app.
- folded/http: HTTP utilities for your web app.
- folded/orm: An ORM for you web app.
- folded/session: Session functions for your web app.
- folded/request: Request utilities, including a request validator, for your PHP web app.
- folded/routing: Routing functions for your PHP web app.
- folded/view: View utilities for your PHP web app.
Features
- Include the content of a file (can use dot syntax)
Requirements
- PHP version >= 7.4.0
- Composer installed
Installation
1. Install the package
In your root folder, run this command:
composer require folded/action
2. Add the setup code
As soon as possible, include this code:
use function Folded\setActionFolderPath; setActionFolderPath(__DIR__ . "/actions");
Examples
1. Call an action
In this example, we will "call" (understand, including the content of the file) a file by its path.
use function Folded\callAction; callAction("home/index");
Which assumes your "action" file is located at actions/home/index.php
.
2. Call an action by dot syntax
In this example, we will call an action by dot syntax. This is equivalent to swapping /
for .
.
use function Folded\callAction; callAction("home.index");
Which assumes your "action" file is located at actions/home/index.php
.
3. Pass parameters to the called action
In this example, we will pass parameters to callAction
to use them in the called action.
use function Folded\callAction; callAction("home.index", [ "name" => "John", ]);
In your view located at actions/home/index.php
you can use the $name
parameter:
echo "Welcome, $name";