Download the PHP package shayanderson/exo without Composer

Exo // Next-Gen Eco Framework

Classes

• App
  • Response
• Entity
• Event
• Exception
• Factory
  • Singleton
• Logger
• Map
• Model
• Options
• Share
• Validator

Functions

• token()

Classes

Exo\App\Cli

Cli is a CLI helper. The Exo\Factory::cli() will only return a Exo\App\Cli object if used with the CLI, all non-CLI usage will return null.

These examples use the Exo\Factory helper function app().

By default the SCRIPT and COMMAND keys are automatically set based on the php [SCRIPT] [COMMAND] ...options pattern. This default pattern can be changed by using the map() method, example using the same command in the example above:

Output

A CLI output helper can be used like:

Arrays are supported:

Output messages on the same line:

An output buffer can be used:

Output using color:

Output using indent:

Using other methods (like colors and indent) with the prepend() method:

Confirm

Confirm example:

Methods

• confirm(string $allow): bool - confirm method
• get(string $key) - getter
• getArgs(): array - get all args
• getMap(): array - args map getter
• has(string $key): bool - check if key exists
• map(array $map) - args map setter
• output($message): \Exo\App\Cli\Output - output helper

  Output Methods

• buffer(): array - buffer getter
• enableBuffering() - enable buffering
• line() - print empty line
• indent($message = null) - indent
• output($message) - print message
• prepend($message) - print without newline

  Output Color Methods

  Color methods are: colorBlue(), colorCyan(), colorGray(), colorGreen(), colorMagenta(), colorRed(), colorYellow()

Light color methods are: colorLightBlue(), colorLightCyan(), colorLightGray(), colorLightGreen(), colorLightMagenta(), colorLightRed(), colorLightYellow()

Exo\App\Env

Env is an application environment variables helper. Keys are case-sensitive.

This example uses the helper function app().

Example .env file:

Example usage:

PHP environment variables from $_ENV (prefixed with ENV.) and $_SERVER (prefixed with SERVER.) are also accessible, example:

Methods

• fromArray(array $array) - from array setter
• get(string $key, $defaultValue = null, bool $invalidKeyException = false) - getter
• has(string $key): bool - check if key exists
• load(string $path) - load file
• toArray(array $filter = null): array - to array

Exo\App\Http\Request

Request is an HTTP request helper.

These examples use the Exo\Factory helper function app().

Example POST request:

Example GET request:

Session in request example:

Session flash can be used to store short-term data where the data is available from when set through the following request, example:

Cookie in request example:

Methods

• body(bool $convertHtmlEntities = true): string - request body raw data getter
• contentType(): string - content-type getter
• cookie(string $key, $default = null): Request\Cookie - cookie input object getter
• hasHeader(string $key): bool - check if header key exists
• header(string $key): string - header value getter
• headers(): array - get all headers
• host(): string - HTTP host value getter, ex: www.example.com
• input(string $key, $default = null): Request\Input - input (POST) object getter
• ipAddress(): string - IP address getter
• isContentType(string $contentType): bool - validate request content-type
• isMethod(string $method): bool - validate request method
• isSecure(): bool - check if request is secure (HTTPS)
• json(bool $returnArray = false) - JSON request payload helper
• method(): string - request method getter
• path(): string - path getter, ex: /the/path
• pathWithQueryString(): string - path with query string getter, ex: /the/path?x=1
• port(): int - port getter
• query(string $key, $default = null): Request\Query - query (GET) input object getter
• queryString(): string - query string getter, ex: x=1&y=2
• scheme(): string - URI scheme getter, ex: http
• session(): Request\Session - session object getter
• uri(): string - URI getter, ex: http://example.com/example?key=x

  Input Methods

  Input methods include methods for request input objects: Cookie, Input and Query.

• email() - value getter, sanitize as email
• float() - value getter, sanitize as float
• has(): bool - check if key exists
• integer() - value getter, sanitize as integer
• string() - value getter, sanitize as string
• url() - value getter, sanitize as URL
• validator(\Exo\Validator\AbstractType $validator): AbstractInput - validator setter

  Session Methods

  Session methods clear(), get(), has() and set() all use dot notation for keys, for example: set('user.isActive', 1) equals: [user => [isActive => 1]]

• clear(string $key) - clear a key
• static cookieOptions(array $options) - set cookie options
  • default options are: ['lifetime' => 0, 'path' => '/', 'domain' => '', 'secure' => false, 'httponly' => false]
• destroy() - destroy a session
• get(string $key) - value getter
• has(string $key): bool - check if key exists
• isSession(): bool - check if session exists
• set(string $key, $value) - key/value setter
• toArray(): array - session array getter

Exo\App\Http\Response

Response is an HTTP response helper.

These examples use the Exo\Factory helper function app().

Methods

All methods return Exo\App\Http\Response, unless otherwise stated.

• cacheOff() - disable cache using cache-control
• contentType(string $contentType) - content-type setter
• cookie($key, $value, $expires, $path, $domain, $secure, $httpOnly): bool - cookie setter
• cookieClear(string $key, string $path = '/'): bool - remove cookie
• header(string $key, $value) - header setter
• headerClear(string $key) - remove header key
• headers(array $headers) - headers setter using array
• json($data): void - respond with JSON and Content-type: application/json in headers
• redirect(string $location, bool $statusCode301 = false): void - send redirect
• statusCode(int $code) - status code setter

Exo\Entity

Entity is an object helper.

The apply() method can be used to apply a callback to a property value, example:

The bind() method can be used to bind an external Entity reference to objects or arrays, example:

The Property voidable() method allows a property to be missing from the entity. This differs from the validator rule optional because optional requires the property to be present. If a property is voidable the default value will not be used when using the toArray() method and using allow voidables. Example usage for the property createdAt that may only be set once (during create operation):

The Entity voidable() method allows all properties to be missing from the entity, unless a property uses the notVoidable() method. Example:

Methods

• assert($name, $value) - single prop value assertion
• deregisterProperty($name) - deregister a property
• fromArray(array $data) - properties values setter
• hasProperty($name): bool - check if property exists
• hasVoidableProperty(): bool - check if any property is voidable
• isVoidable(): bool - check if globally voidable
• property($name, $default = null): \Exo\Entity\Property - register property
• toArray(array $filter = null, bool $voidable = false): array - to array method
  • $filter - allows filtering fields
    • remove specific fields: [field => 0, ...]
    • include only specific fields: [field => 1, ...]
• validate($name, $value) - single prop value validation
• voidable() - set all properties as voidable (unless properties use notVoidable() method)

  Property Methods

• apply(callable $callback): \Exo\Entity\Property - apply callback to value
  • note: $callback(value) is only called if a value or default value exists for the property
• bind(\Exo\Entity $entity): \Exo\Entity\Property - create a reference to another Entity
• notVoidable(): \Exo\Entity\Property - cannot be set as voidable
• validator(): \Exo\Validator - validator object getter
  • must be called after all other property methods
• voidable(): \Exo\Entity\Property - make a property voidable

trait Exo\Event

Event is an event helper.

Callable Chain

Multiple callables can be bound to the same event:

Returning true from any bound callable will interrupt the chain of callables:

Exo\Exception

Exceptions can be improved by using or extending the Exo\Exception class, or the other available Exo\App\Http\Exception\* exception classes. Example:

Exceptions can be handled using the Exo\Exception class:

Exo\Factory

The Exo factory is a factory helper that can be inherited.

Methods

• cli(): \Exo\App\Cli
• env(): \Exo\App\Env
• logger(): \Exo\Logger
• map(array $map = null): \Exo\Map
• options(array $options = null): \Exo\Options
• request(): \Exo\App\Http\Request
• response(): \Exo\App\Http\Response
• session(): \Exo\App\Http\Request\Session
• share(): \Exo\Share
• validator(string $name): \Exo\Validator

Exo\Factory\Annotation

Annotation is a class loading helper that utilizes class annotations.

Singleton Pattern

Use the singleton pattern in factory classes by inheriting the Exo\Factory\Singleton class:

Inheritance Chain

Helper Function

Helper function example:

Exo\Factory\Dynamic

Dynamic class factory.

If a class doesn't exist an exception (Exo\Exception) with be thrown, use try/catch to handle missing classes:

Exo\Factory\Mapper

Mapper is a class loading helper.

Singleton Pattern

Use the singleton pattern in factory classes by inheriting the Exo\Factory\Singleton class:

Helper Function

Helper function example:

Exo\Factory\Singleton

Singleton is a singleton pattern helper.

Helper Function

Helper function example:

Exo\Logger

Logger is a logging helper.

This example uses the Exo\Factory helper function app().

Example custom log handler:

The debug() method can be used with or without a message, and with or without context. Example:

Methods

• critical(?string $message, array $context): \Exo\Logger - critical log record
• debug(?string $message, array $context): \Exo\Logger - debug log record
• error(?string $message, array $context): \Exo\Logger - error log record
• static globalContext(array $context) - add context to global context
  • Local context will overwrite global context
• static handler(\Exo\Logger\Handler $handler) - add log handler
• info(?string $message, array $context): \Exo\Logger - info log record
• warning(?string $message, array $context): \Exo\Logger - warning log record

Exo\Map

Map is a helper class for handling arrays. Map implements Countable and Iterator.

Methods

• __construct(array $map) - overridable
• clear($key) - clear
• count() - get count
• filterKeys(array $filter) - filter map elements by key (exclude or include)
• get($key) - getter
• has($key) - check if exists
• hasValue($value) - check if value exists
• isEmpty(): bool - check it map is empty
• merge(array $map) - merge with another map
• set($key, $value) - setter
• toArray(): array - get as array

  Static Methods

• arrayFilterKeys(array $array, array $filter): array - either include or exclude array keys based on the filter
  • $filter - allows filtering keys
    • exclude: [key => 0, ...]
    • include: [key => 1, ...]
• &extract(array $array, $key, $valueKey = null): array - extract key or key/value from multidimensional array to one dimensional

Exo\Model

Model is a model helper class that can be used with Exo\Entity objects.

For reference see Exo\Entity example above

Methods

• entity($data = null): \Exo\Entity - entity factory method
• entityArray(array $data, array $filter = null, bool $voidable = false): array - array of entities factory

Exo\Options

Options is a helper class for handling options with validation.

Usage example:

Methods

• get(string $key): mixed - value getter
• has(string $key): bool - check if key exists
• option(string $key, $defaultValue): \Exo\Validator - optional default value setter and validation
• read(array &$map) - abstract read all
• set($key, $value) - value setter, or use array for keys/values setter
• toArray(): array - get options as array [key => value, ...]
• write(string $key, $value): bool - abstract write key/value

Exo\Share

Share is a global key/value helper.

Methods

• clear(string $key) - clear key
• get(string $key) - getter
• has(string $key): bool - check if key exists
• set(string $key, $value) - setter

Exo\Validator

Validator is a validation helper.

Optional

Custom Messages

Use custom validation exception messages:

Also a singe validation message can be used for an entire group:

Assert Callback

Use callback with assert() method:

Custom Rules

Use custom rule:

Validate Method

Usage with validate() method instead:

Use Custom Assertion Exception Class

A custom exception class can be used instead of the default Exo\Validator\Exception class when an assertion fails, example:

Display Value in Assertion Exception Message

The value that fails validation can be displayed in the assertion exception message for debugging purposes:

Types & Rules

• Array - must be a non-empty array
  • depth(int $depth) - must be an array with specific depth
  • length(int $length) - must be a specific number of array items
  • max(int $max) - array items must be a maximum of
  • min(int $min) - array items must be a minimum of
  • optional() - array can be empty
  • unique() - array items must be unique
• Boolean - must be valid boolean value
  • optional() - ignored because "" and null are considered false (unless type() is used)
  • type() - must be primitive type boolean
    • when type() is not used acceptable boolean values are:
      • for true: true, "1", "true", "on", "yes"
      • for false: false, "0", "false", "off", "no", "", null
• Number - must be a valid number
  • between(int $min, int $max) - must be between both values
  • greaterThan(int $compareValue) - must be greater than
  • integer() - must be an integer
  • lessThan(int $compareValue) - must be less than
  • max(int $max) - must be a maximum of
  • min(int $min) - must be a minimum of
  • negative() - must be a negative number
  • optional() - allows "" and null
  • positive() - must be a positive number
  • typeFloat() - must be primitive type float
  • typeInteger() - must be primitive type integer
  • unique(callable $callback) - must be unique (callable returns true if unique)
• Object - must be an object
  • optional() - allows null
• String - must be a non-empty string
  • allowed(array $list) - must be allowed
  • alnum(bool $allowWhitespaces = false) - must only contain alphanumeric characters
  • alpha(bool $allowWhitespaces = false) - must only contain alphabetic characters
  • contains($containsValue, bool $caseSensitive = true) - must contain value
  • email() - must be a valid email address
  • hash(string $knownHash) - hashes must be equal
  • ipv4() - must be valid IPv4 address
  • ipv6() - must be valid IPv6 address
  • json() - must be a valid JSON
  • length(int $length) - length must be exact number of characters
  • match(string $compareValue, bool $caseSensitive = true) - values must be equal
  • max(int $max) - length must be a maximum number of characters
  • min(int $min) - length must be a minimum number of characters
  • notAllowed(array $list) - is not allowed
  • optional - allows "" and null
  • password(string $hash) - passwords must be equal
  • regex(string $pattern) - must match regular expression pattern
  • type() - must be primitive type string
  • unique(callable $callback) - must be unique (callable returns true if unique)
  • url() - must be valid URL

    Methods

• assert($value, callable $callback) - throws exception if validation fails
• getMessage() - get first validation message after validation
• getMessages(): array - get all validation messages after validation
• groupMessage(string $message) - set group single validation message
• message(string $message): \Exo\Validator\AbstractType - set validation message for last rule
• rule(\Exo\Validator\RuleInterface $rule): \Exo\Validator\AbstractType - add custom rule
• validate($value): bool - validate value

Functions

bind(): string

Formatted string helper.

Any depth beyond the allowed depth of two is auto-serialized, example:

debug($message = null, $context = null): \Exo\Logger

Logger debug alias.

env(string $key, $default)

The env() function is a getter helper function for Env.

logger(string $channel = ''): \Exo\Logger

Logger helper function.

pa(...$values): void

HTML and CLI friendly printer for all PHP types.

share(string $key, $value)

The share() function is a getter/setter helper function for Share.

token(int $length = 32): string

Generate tokens: