Download the PHP package fyre/engine without Composer

FyreEngine

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

Table Of Contents

• Installation
• Basic Usage
• Methods
• Attributes
• Global Functions

Installation

Using Composer

In PHP:

Basic Usage

• $loader is a Loader.

Methods

This class extends the Container class.

Boot

Boot the application.

Middleware

Build application middleware.

• $queue is a MiddlewareQueue.

Attributes

Attributes can be used to provide context when resolving values from the Container.

Cache

Load a shared Cacher instance.

Config

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

Current User

Get the current user.

DB

Load a shared Connection instance.

Encryption

Load a shared Encrypter instance.

Log

Load a shared Logger instance.

Mail

Load a shared Mailer instance.

ORM

Load a shared Model instance.

Route Argument

Retrieve an argument from the loaded route.

Global 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.

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

App

Load a shared Engine instance.

You can also load other shared class instances.

• $alias is a string representing the alias.
• $arguments is an array containing the named arguments for the class constructor.

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.

Auth

Load a shared Auth instance.

Authorize

Authorize an access rule.

• $rule is a string representing the access rule name or Policy method.

Any additional arguments supplied will be passed to the access rule callback or Policy method.

Cache

Load a shared Cacher instance.

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

Can

Check whether an access rule is allowed.

• $rule is a string representing the access rule name or Policy method.

Any additional arguments supplied will be passed to the access rule callback or Policy method.

Can Any

Check whether any access rule is allowed.

• $rules is an array containing access rule names or Policy methods.

Any additional arguments supplied will be passed to the access rule callbacks or Policy methods.

Can None

Check whether no access rule is allowed.

• $rules is an array containing access rule names or Policy methods.

Any additional arguments supplied will be passed to the access rule callbacks or Policy methods.

Cannot

Check whether an access rule is not allowed.

• $rule is a string representing the access rule name or Policy method.

Any additional arguments supplied will be passed to the access rule callback or Policy method.

Collect

Create a new Collection.

• $source can be either an array, a Closure that returns a Generator, or a Traversable or JsonSerializable object.

Config

Load a shared Config instance.

You can also 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.

DB

Load a shared Connection instance.

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

DD

Dump and die.

Dump

Dump data.

Email

Create an Email.

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

Encryption

Load a shared Encrypter instance.

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

Env

Retrieve an environment variable.

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

Escape

Escape characters in a string for use in HTML.

• $string is the string to escape.

Json

Create a new ClientResponse with JSON data.

• $data is the data to send.

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.

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

Logged In

Determine if the current user is logged in.

Model

Load a shared Model instance.

• $alias is a string representing the model alias.

Now

Create a new DateTime set to 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.

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.

Request

Load a shared ServerRequest instance.

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.
• $as is a string representing the value type, and will default to null.

Response

Create a new ClientResponse.

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.

Session

Load a shared Session instance.

Retrieve a value from the session.

• $key is a string representing the session key.

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

Type

Load a shared TypeParser instance.

You can also get the mapped Type class for a value type.

• $type is a string representing the value type.

User

Get the current user.

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.

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