1. class
  2. App
  3. \
  4. Helpers
  5. \
  6. LumenHelper

LumenHelper

class LumenHelper

Properties

static $app_instances

Methods

__construct($app)

Construct Get Plugin Container from Static Array

static mixed
plugin($namespace)

Get Lumen Plugin Instance

Application
app()

Get Lumen App

SessionServiceProvider
session()

Get Lumen App

WpHelper
wpHelper()

Get wpHelper

CacheManager
cache()

Get Cache

AuthManager
auth()

Get Auth

string
asset($url)

Get Public Asset

void
abort(int $code, string $message = '', array $headers = [])

Throw an HttpException with the given data.

mixed|Application
make(string $make)

Get the available container instance.

string
base_path(string $path = '')

Get the path to the base of the install.

string
decrypt(string $value)

Decrypt the given value.

mixed
dispatch(mixed $job)

Dispatch a job to its appropriate handler.

mixed
config(array|string $key = null, mixed $default = null)

Get / set the specified configuration value.

string
database_path(string $path = '')

Get the path to the database directory of the install.

string
encrypt(string $value)

Encrypt the given value.

mixed
env(string $key, mixed $default = null)

Gets the value of an environment variable. Supports boolean, empty and null.

array|null
event(object|string $event, mixed $payload = [], bool $halt = false)

Fire an event and call the listeners.

FactoryBuilder
factory()

Create a model factory builder for a given class, name, and amount.

void
info(string $message, array $context = [])

Write some information to the log.

Redirector|RedirectResponse
redirect(string|null $to = null, int $status = 302, array $headers = [], bool $secure = null)

Get an instance of the redirector.

string
resource_path(string $path = '')

Get the path to the resources folder.

Validator
validator()

Make Validator

Request
request()

Return the current request from the application.

Response|ResponseFactory
response(string $content = '', int $status = 200, array $headers = [])

Return a new response from the application.

string
route(string $name, array $parameters = [], bool $secure = null)

Generate a URL to a named route.

string
storage_path(string $path = '')

Get the path to the storage folder.

Translator|string
trans(string $id = null, array $replace = [], string $locale = null)

Translate the given message.

string
trans_choice(string $id, int|array|Countable $number, array $replace = [], string $locale = null)

Translates the given message based on a count.

string
url(string $path = null, mixed $parameters = [], bool $secure = null)

Generate a url for the application.

View
view(string $view = null, array $data = [], array $mergeData = [])

Get the evaluated view contents for the given view.

mixed
recursiveCollection(array $array)

Recursive Collection

Details

at line 15
__construct($app)

Construct Get Plugin Container from Static Array

Parameters

$app \Illuminate\Contracts\Foundation\Application

Exceptions

Exception

at line 35
static mixed plugin($namespace)

Get Lumen Plugin Instance

Parameters

$namespace

Return Value

mixed

at line 46
Application app()

Get Lumen App

Return Value

Application

at line 54
SessionServiceProvider session()

Get Lumen App

Return Value

SessionServiceProvider

at line 62
WpHelper wpHelper()

Get wpHelper

Return Value

WpHelper

at line 70
CacheManager cache()

Get Cache

Return Value

CacheManager

at line 78
AuthManager auth()

Get Auth

Return Value

AuthManager

at line 86
string asset($url)

Get Public Asset

Parameters

$url

Return Value

string

at line 101
void abort(int $code, string $message = '', array $headers = [])

Throw an HttpException with the given data.

Parameters

int $code
string $message
array $headers

Return Value

void

Exceptions

HttpException
NotFoundHttpException

at line 113
mixed|Application make(string $make)

Get the available container instance.

Parameters

string $make

Return Value

mixed|Application

at line 124
string base_path(string $path = '')

Get the path to the base of the install.

Parameters

string $path

Return Value

string

at line 135
string decrypt(string $value)

Decrypt the given value.

Parameters

string $value

Return Value

string

at line 146
mixed dispatch(mixed $job)

Dispatch a job to its appropriate handler.

Parameters

mixed $job

Return Value

mixed

at line 160
mixed config(array|string $key = null, mixed $default = null)

Get / set the specified configuration value.

If an array is passed as the key, we will assume you want to set an array of values.

Parameters

array|string $key
mixed $default

Return Value

mixed

at line 178
string database_path(string $path = '')

Get the path to the database directory of the install.

Parameters

string $path

Return Value

string

at line 189
string encrypt(string $value)

Encrypt the given value.

Parameters

string $value

Return Value

string

at line 201
mixed env(string $key, mixed $default = null)

Gets the value of an environment variable. Supports boolean, empty and null.

Parameters

string $key
mixed $default

Return Value

mixed

at line 242
array|null event(object|string $event, mixed $payload = [], bool $halt = false)

Fire an event and call the listeners.

Parameters

object|string $event
mixed $payload
bool $halt

Return Value

array|null

at line 253
FactoryBuilder factory()

Create a model factory builder for a given class, name, and amount.

Return Value

FactoryBuilder

at line 277
void info(string $message, array $context = [])

Write some information to the log.

Parameters

string $message
array $context

Return Value

void

at line 291
Redirector|RedirectResponse redirect(string|null $to = null, int $status = 302, array $headers = [], bool $secure = null)

Get an instance of the redirector.

Parameters

string|null $to
int $status
array $headers
bool $secure

Return Value

Redirector|RedirectResponse

at line 307
string resource_path(string $path = '')

Get the path to the resources folder.

Parameters

string $path

Return Value

string

at line 316
Validator validator()

Make Validator

Return Value

Validator

at line 325
Request request()

Return the current request from the application.

Return Value

Request

at line 338
Response|ResponseFactory response(string $content = '', int $status = 200, array $headers = [])

Return a new response from the application.

Parameters

string $content
int $status
array $headers

Return Value

Response|ResponseFactory

at line 357
string route(string $name, array $parameters = [], bool $secure = null)

Generate a URL to a named route.

Parameters

string $name
array $parameters
bool $secure

Return Value

string

at line 368
string storage_path(string $path = '')

Get the path to the storage folder.

Parameters

string $path

Return Value

string

at line 381
Translator|string trans(string $id = null, array $replace = [], string $locale = null)

Translate the given message.

Parameters

string $id
array $replace
string $locale

Return Value

Translator|string

at line 399
string trans_choice(string $id, int|array|Countable $number, array $replace = [], string $locale = null)

Translates the given message based on a count.

Parameters

string $id
int|array|Countable $number
array $replace
string $locale

Return Value

string

at line 412
string url(string $path = null, mixed $parameters = [], bool $secure = null)

Generate a url for the application.

Parameters

string $path
mixed $parameters
bool $secure

Return Value

string

at line 425
View view(string $view = null, array $data = [], array $mergeData = [])

Get the evaluated view contents for the given view.

Parameters

string $view
array $data
array $mergeData

Return Value

View

at line 442
mixed recursiveCollection(array $array)

Recursive Collection

Parameters

array $array

Return Value

mixed