folded/action

A pattern to organize your controllers with functions for you web app.

v0.2.2 2020-10-03 11:32 UTC

This package is auto-updated.

Last update: 2021-11-17 10:28:27 UTC


README

A pattern to organize your controllers with functions for you web app.

Build Status Maintainability TODOs

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.

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";

Version support

7.3 7.4 8.0
v0.1.0 ✔️
v0.1.1 ✔️
v0.2.0 ✔️
v0.2.1 ✔️
v0.2.2 ✔️