fyre/engine

An engine library.

v7.1.1 2024-06-25 07:04 UTC

Requires

• fyre/command: ^4.0
• fyre/config: ^3.0
• fyre/encryption: ^3.0
• fyre/entity: ^3.0
• fyre/error: ^4.0
• fyre/lang: 3.0
• fyre/mail: ^2.0
• fyre/middleware: ^2.0
• fyre/migration: ^3.0
• fyre/orm: ^6.0
• fyre/queue: ^2.0
• fyre/router: ^5.0
• fyre/server: ^3.0
• fyre/session: ^3.1
• fyre/view: ^7.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.59
• fyre/php-cs-fixer-config: ^1.0
• phpunit/phpunit: ^10

MIT

• elusivecodes

README

FyreEngine

FyreEngine is a free, open-source engine library for PHP.

Table Of Contents

• Installation
• Methods
• Functions

Installation

Using Composer

composer require fyre/engine

In PHP:

use Fyre\Engine\Engine;

Methods

Bootstrap

Bootstrap application.

Engine::bootstrap();

Middleware

Build application middleware.

• $queue is a MiddlewareQueue.

Engine::middleware($queue);

Routes

Build application routes.

Engine::routes();

Functions

__

Get a language value.

• $key is a string representing the key to lookup.
• $data is an array containing data to insert into the language string.

$lang = __($key, $data);

Abort

Throw an Exception.

• $code is a number representing the status code, and will default to 500.
• $message is a string representing the error message, and will default to "".

abort($code, $message);

Asset

Generate a URL for an asset path.

• $path is a string representing the asset path.
• $options is an array containing the route options.
  • fullBase is a boolean indicating whether to use the full base URI and will default to false.

$url = asset($path);

Cache

Load a shared Cacher instance.

• $key is a string representing the Cacher key, and will default to Cache::DEFAULT.

$cacher = cache($key);

Config

Retrieve a value from the config using "dot" notation.

• $key is a string representing the key to lookup.
• $default is the default value to return, and will default to null.

$value = config($key, $default);

DD

Dump and die.

dd(...$data);

Dump

Dump data.

dump(...$data);

Email

Create an Email.

• $key is a string representing the Mailer key, and will default to Mail::DEFAULT.

$email = email($key);

Encryption

Load a shared Encrypter instance.

• $key is a string representing the Encrypter key, and will default to Encryption::DEFAULT.

$encrypter = encryption($key);

Escape

Escape characters in a string for use in HTML.

• $string is the string to escape.

$escaped = escape($string);

Json

Create a new ClientResponse with JSON data.

• $data is the data to send.

$response = json($data);

Log Message

Log a message.

• $type is a string representing the log level.
• $message is a string representing the log message.
• $data is an array containing data to insert into the message string.

log($type, $message, $data);

The $type must be one of the supported log levels.

Model

Load a shared Model instance.

• $alias is a string representing the model alias.

$model = model($alias);

Now

Create a new DateTime set to now.

$now = now();

Queue

Push a job to a Queue.

• $className is a string representing the job class.
• $arguments is an array containing arguments that will be passed to the job.
• $options is an array containing options for the Message.
  • config is a string representing the configuration key, and will default to "default".
  • queue is a string representing the Queue name, and will default to "default".
  • method is a string representing the class method, and will default to "run".
  • delay is a number representing the number of seconds before the job should run, and will default to 0.
  • expires is a number representing the number of seconds after which the job will expire, and will default to 0.

queue($className, $arguments, $options);

Redirect

Create a new RedirectResponse.

• $uri is a Uri or string representing the URI to redirect to.
• $code is a number representing the header status code, and will default to 302.
• $options is an array containing configuration options.

$response = redirect($uri, $code, $options);

Request

Load a shared ServerRequest instance.

$request = request();

You can also retrieve value from the $_POST array by passing arguments to this function.

• $key is a string representing the array key using "dot" notation.
• $filter is a number representing the filter to apply, and will default to FILTER_DEFAULT.
• $options is a number or array containing flags to use when filtering, and will default to 0.

$value = request($key, $filter, $options);

Response

Create a new ClientResponse.

$response = response();

Route

Generate a URL for a named Route.

• $name is a string representing the route alias.
• $arguments is an array containing the route arguments.
  • ? is an array containing route query parameters.
  • # is a string representing the fragment component of the URI.
• $options is an array containing the route options.
  • fullBase is a boolean indicating whether to use the full base URI and will default to false.

$route = route($name, $arguments, $options);

Session

Retrieve a value from the session.

• $key is a string representing the session key.

$value = session($key);

You can also set a session value by including a second argument.

session($key, $value);

Type

Get the mapped Type class for a value type.

• $type is a string representing the value type.

$typeClass = type($type);

View

Render a View template.

• $template is a string representing the template file.
• $data is an array containing data to pass to the template.
• $layout is a string representing the layout file, and will default to null.

$view = view($template, $data, $layout);

If the $layout is set to null, it will use the App.defaultLayout option from the Config.