Documentation

Pop extends Application
in package

Popcorn

This is the main class for the Popcorn Micro-Framework.

Properties

$config : mixed: Application config
$autoloader : mixed: Autoloader
$config : mixed: Application config
$events : Manager|null: Event manager
$modules : Manager|null: Module manager
$name : string|null: Name
$router : Router|null: Application router
$routes : array<string|int, mixed>: Routes array
$services : Locator|null: Service locator
$version : string|null: Version

Methods

__call() : void: Magic method to check for a custom method
__construct() : mixed: Constructor
__get() : mixed: Get a pre-designated value from the application object
__isset() : bool: Determine if a pre-designated value in the application object exists
__set() : void: Set a pre-designated value in the application object
__unset() : void: Unset a pre-designated value in the application object
addConfigValue() : AbstractApplication: Add new value to config
addCustomMethod() : Pop: Add a custom method
addCustomMethods() : Pop: Add custom methods
addRoute() : static: Add a route
addRoutes() : static: Add routes
addToAll() : Pop: Add to all methods
any() : Pop: Add to any and all methods (alias method to addToAll)
autoloader() : mixed: Get the autoloader object
bootstrap() : static: Bootstrap the application, creating the required objects if they haven't been created yet and registering with the autoloader, adding routes, services and events
config() : mixed: Access application config
connect() : Pop: Add a CONNECT route
delete() : Pop: Add a DELETE route
deleteConfigValue() : AbstractApplication: Replace existing value in config
env() : mixed: Get environment value
environment() : string|null|bool: Get application environment
events() : Manager: Get the event manager
get() : Pop: Add a GET route
getName() : string: Get name
getRoute() : mixed: Method to get a route by method
getRoutes() : array<string|int, mixed>: Method to get all routes
getService() : mixed: Get a service
getVersion() : string: Get version
hasCustomMethod() : bool: Has a custom method
hasName() : bool: Determine if the name is set
hasRoute() : bool: Method to determine if the application has a route
hasVersion() : bool: Determine if version has been set
head() : Pop: Add a HEAD route
init() : static: Initialize the application
isAllowed() : bool: Determine if the route is allowed on for the method
isDev() : bool: Check if application environment is dev
isDown() : bool: Check if application is in maintenance mode
isLocal() : bool: Check if application environment is local
isProduction() : bool: Check if application environment is production
isRegistered() : bool: Determine whether a module is registered with the application object
isStaging() : bool: Check if application environment is staging
isTesting() : bool: Check if application environment is testing
isUp() : bool: Check if application is in not maintenance mode
load() : AbstractApplication: Optional method that can be used to load custom operations/configurations for an application to run
mergeConfig() : AbstractApplication: Merge new or altered config values with the existing config values
module() : ModuleInterface|null: Access a module object
modules() : Manager: Access all application module configs
name() : string|null: Get application name (alias method)
off() : static: Detach an event. Default hook-points are:
offsetExists() : bool: Determine if a pre-designated value in the application object exists
offsetGet() : mixed: Get a pre-designated value from the application object
offsetSet() : void: Set a pre-designated value in the application object
offsetUnset() : void: Unset a pre-designated value in the application object
on() : static: Attach an event. Default hook-points are:
options() : Pop: Add an OPTIONS route
patch() : Pop: Add a PATCH route
post() : Pop: Add a POST route
put() : Pop: Add a PUT route
register() : static: Register a module with the module manager object
registerAutoloader() : static: Register the autoloader object with the application
registerConfig() : AbstractApplication: Register a new configuration with the application
registerEvents() : static: Register a new event manager object with the application
registerModules() : static: Register a new module manager object with the application
registerRouter() : static: Register a new router object with the application
registerServices() : static: Register a new service locator object with the application
removeService() : static: Remove a service
router() : Router: Access the application router
run() : void: Run the application.
services() : Locator: Get the service locator
setName() : static: Set name
setRoute() : Pop: Add a route
setRoutes() : Pop: Add multiple routes
setService() : static: Set a service
setVersion() : static: Set version
trace() : Pop: Add a TRACE route
trigger() : static: Trigger an event
unregister() : static: Unregister a module with the module manager object
updateConfigValue() : AbstractApplication: Update existing value in config
url() : string|null: Get application URL

$config

Application config


    public
        mixed
    $config

mixed

$autoloader

Autoloader


    protected
        mixed
    $autoloader
     = null

$config

Application config


    protected
        mixed
    $config
     = null

$events

Event manager


    protected
        Manager|null
    $events
     = null

$modules

Module manager


    protected
        Manager|null
    $modules
     = null

$name

Name


    protected
        string|null
    $name
     = null

$router

Application router


    protected
        Router|null
    $router
     = null

$routes

Routes array


    protected
        array<string|int, mixed>
    $routes
     = ['get' => [], 'head' => [], 'post' => [], 'put' => [], 'delete' => [], 'trace' => [], 'options' => [], 'connect' => [], 'patch' => []]

$services

Service locator


    protected
        Locator|null
    $services
     = null

$version

Version


    protected
        string|null
    $version
     = null

__call()

Magic method to check for a custom method


    public
                    __call(string $methodName, array<string|int, mixed> $arguments) : void

Parameters

$methodName : string
$arguments : array<string|int, mixed>

__construct()

Constructor


    public
                    __construct() : mixed

Instantiate an application object

Optional parameters are a service locator instance, a router instance, an event manager instance or a configuration object or array

__get()

Get a pre-designated value from the application object


    public
                    __get(string $name) : mixed

Parameters

$name : string

__isset()

Determine if a pre-designated value in the application object exists


    public
                    __isset(string $name) : bool

Parameters

$name : string

Return values

bool

__set()

Set a pre-designated value in the application object


    public
                    __set(string $name, mixed $value) : void

Parameters

$name : string
$value : mixed

__unset()

Unset a pre-designated value in the application object


    public
                    __unset(string $name) : void

Parameters

$name : string

addConfigValue()

Add new value to config


    public
                    addConfigValue(string $name, string $value) : AbstractApplication

Parameters

$name : string
$value : string

Return values

AbstractApplication

addCustomMethod()

Add a custom method


    public
                    addCustomMethod(string $customMethod) : Pop

Parameters

$customMethod : string

Return values

Pop

addCustomMethods()

Add custom methods


    public
                    addCustomMethods(array<string|int, mixed> $customMethods) : Pop

Parameters

$customMethods : array<string|int, mixed>

Return values

Pop

addRoute()

Add a route


    public
                    addRoute(string $route, mixed $controller) : static

Parameters

$route : string
$controller : mixed

Return values

static

addRoutes()

Add routes


    public
                    addRoutes(array<string|int, mixed> $routes) : static

Parameters

$routes : array<string|int, mixed>

Return values

static

addToAll()

Add to all methods


    public
                    addToAll(string $route, mixed $controller) : Pop

Parameters

$route : string
$controller : mixed

Return values

Pop

any()

Add to any and all methods (alias method to addToAll)


    public
                    any(string $route, mixed $controller) : Pop

Parameters

$route : string
$controller : mixed

Return values

Pop

autoloader()

Get the autoloader object


    public
                    autoloader() : mixed

bootstrap()

Bootstrap the application, creating the required objects if they haven't been created yet and registering with the autoloader, adding routes, services and events


    public
                    bootstrap([mixed $autoloader = null ]) : static

Parameters

$autoloader : mixed = null

Return values

static

config()

Access application config


    public
                    config() : mixed

connect()

Add a CONNECT route


    public
                    connect(string $route, mixed $controller) : Pop

Parameters

$route : string
$controller : mixed

Return values

Pop

delete()

Add a DELETE route


    public
                    delete(string $route, mixed $controller) : Pop

Parameters

$route : string
$controller : mixed

Return values

Pop

deleteConfigValue()

Replace existing value in config


    public
                    deleteConfigValue(string $name) : AbstractApplication

Parameters

$name : string

Return values

AbstractApplication

env()

Get environment value


    public
                    env(string $key[, mixed $default = null ]) : mixed

Parameters

$key : string
$default : mixed = null

environment()

Get application environment


    public
                    environment([mixed $env = null ]) : string|null|bool

Parameters

$env : mixed = null

Return values

string|null|bool

events()

Get the event manager


    public
                    events() : Manager

Return values

Manager

get()

Add a GET route


    public
                    get(string $route, mixed $controller) : Pop

Parameters

$route : string
$controller : mixed

Return values

Pop

getName()

Get name


    public
                    getName() : string

Return values

string

getRoute()

Method to get a route by method


    public
                    getRoute(string $method, string $route) : mixed

Parameters

$method : string
$route : string

getRoutes()

Method to get all routes


    public
                    getRoutes([string|null $method = null ]) : array<string|int, mixed>

Parameters

$method : string|null = null

Return values

array<string|int, mixed>

getService()

Get a service


    public
                    getService(string $name) : mixed

Parameters

$name : string

getVersion()

Get version


    public
                    getVersion() : string

Return values

string

hasCustomMethod()

Has a custom method


    public
                    hasCustomMethod(string $customMethod) : bool

Parameters

$customMethod : string

Return values

bool

hasName()

Determine if the name is set


    public
                    hasName() : bool

Return values

bool

hasRoute()

Method to determine if the application has a route


    public
                    hasRoute(string $method, string $route) : bool

Parameters

$method : string
$route : string

Return values

bool

hasVersion()

Determine if version has been set


    public
                    hasVersion() : bool

Return values

bool

head()

Add a HEAD route


    public
                    head(string $route, mixed $controller) : Pop

Parameters

$route : string
$controller : mixed

Return values

Pop

init()

Initialize the application


    public
                    init() : static

Return values

static

isAllowed()

Determine if the route is allowed on for the method


    public
                    isAllowed([string|null $route = null ]) : bool

Parameters

$route : string|null = null

Return values

bool

isDev()

Check if application environment is dev


    public
                    isDev() : bool

Return values

bool

isDown()

Check if application is in maintenance mode


    public
                    isDown() : bool

Return values

bool

isLocal()

Check if application environment is local


    public
                    isLocal() : bool

Return values

bool

isProduction()

Check if application environment is production


    public
                    isProduction() : bool

Return values

bool

isRegistered()

Determine whether a module is registered with the application object


    public
                    isRegistered(string $name) : bool

Parameters

$name : string

Return values

bool

isStaging()

Check if application environment is staging


    public
                    isStaging() : bool

Return values

bool

isTesting()

Check if application environment is testing


    public
                    isTesting() : bool

Return values

bool

isUp()

Check if application is in not maintenance mode


    public
                    isUp() : bool

Return values

bool

load()

Optional method that can be used to load custom operations/configurations for an application to run


    public
                    load() : AbstractApplication

Return values

AbstractApplication

mergeConfig()

Merge new or altered config values with the existing config values


    public
                    mergeConfig(mixed $config[, bool $preserve = false ]) : AbstractApplication

Parameters

$config : mixed
$preserve : bool = false

Return values

AbstractApplication

module()

Access a module object


    public
                    module(string $name) : ModuleInterface|null

Parameters

$name : string

Return values

ModuleInterface|null

modules()

Access all application module configs


    public
                    modules() : Manager

Return values

Manager

name()

Get application name (alias method)


    public
                    name() : string|null

Return values

string|null

off()

Detach an event. Default hook-points are:


    public
                    off(string $name, mixed $action) : static

app.init app.route.pre app.dispatch.pre app.dispatch.post app.error

Parameters

$name : string
$action : mixed

Return values

static

offsetExists()

Determine if a pre-designated value in the application object exists


    public
                    offsetExists(mixed $offset) : bool

Parameters

$offset : mixed

Return values

bool

offsetGet()

Get a pre-designated value from the application object


    public
                    offsetGet(mixed $offset) : mixed

Parameters

$offset : mixed

offsetSet()

Set a pre-designated value in the application object


    public
                    offsetSet(mixed $offset, mixed $value) : void

Parameters

$offset : mixed
$value : mixed

offsetUnset()

Unset a pre-designated value in the application object


    public
                    offsetUnset(mixed $offset) : void

Parameters

$offset : mixed

on()

Attach an event. Default hook-points are:


    public
                    on(string $name, mixed $action[, int $priority = 0 ]) : static

app.init app.route.pre app.dispatch.pre app.dispatch.post app.error

Parameters

$name : string
$action : mixed
$priority : int = 0

Return values

static

options()

Add an OPTIONS route


    public
                    options(string $route, mixed $controller) : Pop

Parameters

$route : string
$controller : mixed

Return values

Pop

patch()

Add a PATCH route


    public
                    patch(string $route, mixed $controller) : Pop

Parameters

$route : string
$controller : mixed

Return values

Pop

post()

Add a POST route


    public
                    post(string $route, mixed $controller) : Pop

Parameters

$route : string
$controller : mixed

Return values

Pop

put()

Add a PUT route


    public
                    put(string $route, mixed $controller) : Pop

Parameters

$route : string
$controller : mixed

Return values

Pop

register()


    public
                    register(mixed $module[, string|null $name = null ]) : static

Parameters

$module : mixed
$name : string|null = null

Return values

static

registerAutoloader()


    public
                    registerAutoloader(mixed $autoloader) : static

Parameters

$autoloader : mixed

Return values

static

registerConfig()


    public
                    registerConfig(mixed $config) : AbstractApplication

Parameters

$config : mixed

Return values

AbstractApplication

registerEvents()


    public
                    registerEvents(Manager $events) : static

Parameters

$events : Manager

Return values

static

registerModules()


    public
                    registerModules(Manager $modules) : static

Parameters

$modules : Manager

Return values

static

registerRouter()


    public
                    registerRouter(Router $router) : static

Parameters

$router : Router

Return values

static

registerServices()


    public
                    registerServices(Locator $services) : static

Parameters

$services : Locator

Return values

static

removeService()

Remove a service


    public
                    removeService(string $name) : static

Parameters

$name : string

Return values

static

router()

Access the application router


    public
                    router() : Router

Return values

Router

run()

Run the application.


    public
                    run([bool $exit = true ][, string|null $forceRoute = null ]) : void

Parameters

$exit : bool = true
$forceRoute : string|null = null

services()

Get the service locator


    public
                    services() : Locator

Return values

Locator

setName()

Set name


    public
                    setName(string $name) : static

Parameters

$name : string

Return values

static

setRoute()

Add a route


    public
                    setRoute(string $method, string $route, mixed $controller) : Pop

Parameters

$method : string
$route : string
$controller : mixed

Return values

Pop

setRoutes()

Add multiple routes


    public
                    setRoutes(array<string|int, mixed>|string $methods, string $route, mixed $controller) : Pop

Parameters

$methods : array<string|int, mixed>|string
$route : string
$controller : mixed

Return values

Pop

setService()

Set a service


    public
                    setService(string $name, mixed $service) : static

Parameters

$name : string
$service : mixed

Return values

static

setVersion()

Set version


    public
                    setVersion(string $version) : static

Parameters

$version : string

Return values

static

trace()

Add a TRACE route


    public
                    trace(string $route, mixed $controller) : Pop

Parameters

$route : string
$controller : mixed

Return values

Pop

trigger()

Trigger an event


    public
                    trigger(string $name[, array<string|int, mixed> $args = [] ]) : static

Parameters

$name : string
$args : array<string|int, mixed> = []

Return values

static

unregister()

Unregister a module with the module manager object


    public
                    unregister(string $name) : static

Parameters

$name : string

Return values

static

updateConfigValue()

Update existing value in config


    public
                    updateConfigValue(string $name, string $value) : AbstractApplication

Parameters

$name : string
$value : string

Return values

AbstractApplication

url()

Get application URL


    public
                    url() : string|null

Return values

string|null

Pop extends Application in package Popcorn

Tags

Table of Contents

Properties

Methods

Properties

$config

$autoloader

$config

$events

$modules

$name

$router

$routes

$services

$version

Methods

__call()

Parameters

Tags

__construct()

Tags

__get()

Parameters

__isset()

Parameters

Return values

__set()

Parameters

Tags

__unset()

Parameters

addConfigValue()

Parameters

Return values

addCustomMethod()

Parameters

Return values

addCustomMethods()

Parameters

Return values

addRoute()

Parameters

Return values

addRoutes()

Parameters

Return values

addToAll()

Parameters

Tags

Return values

any()

Parameters

Return values

autoloader()

bootstrap()

Parameters

Tags

Return values

config()

connect()

Parameters

Tags

Return values

delete()

Parameters

Tags

Return values

deleteConfigValue()

Parameters

Return values

env()

Parameters

environment()

Parameters

Return values

events()

Return values

get()

Parameters

Pop extends Application
in package

Popcorn