Class Core

Core of the framework.

ICanBoogie\Object implements ICanBoogie\ToArrayRecursive uses ICanBoogie\ToArrayRecursiveTrait, ICanBoogie\PrototypeTrait

ICanBoogie\Core

Direct known subclasses

Icybee\Core

Namespace: ICanBoogie
Located at vendor/icanboogie/icanboogie/lib/core.php

Methods summary

`public static ICanBoogie\Core`	# `get( )` Returns the unique instance of the core object. Returns the unique instance of the core object. Returns `ICanBoogie\Core` The core object.
`public static`	# `exception_handler( ICanBoogie\Exception $exception )` Echos the exception and kills PHP. Echos the exception and kills PHP. Parameters `$exception` `Exception` $exception
`public`	# `__construct( array $options = [] )` Constructor. Constructor. Parameters `$options` `array` $options Initial options to create the core object. Throws `Exception` when one tries to create a second instance.
`protected`	# `create_config_manager( mixed $path_list, mixed $constructors )`
`protected ICanBoogie\Modules`	# `lazy_get_modules( )` Returns modules accessor. Returns modules accessor. Returns `ICanBoogie\Modules` The modules accessor.
`protected ICanBoogie\Models`	# `lazy_get_models( )` Returns models accessor. Returns models accessor. Returns `ICanBoogie\Models` The models accessor.
`protected ICanBoogie\Vars`	# `lazy_get_vars( )` Returns the non-volatile variables accessor. Returns the non-volatile variables accessor. Returns `ICanBoogie\Vars` The non-volatile variables accessor.
`protected array`	# `lazy_get_config( )` Returns the _core_ configuration. Returns the _core_ configuration. Returns `array`
`protected ICanBoogie\HTTP\Dispatcher`	# `get_dispatcher( )` Returns the dispatcher used to dispatch HTTP requests. Returns the dispatcher used to dispatch HTTP requests. Returns `ICanBoogie\HTTP\Dispatcher`
`protected ICanBoogie\HTTP\Request`	# `lazy_get_initial_request( )` Returns the initial request object. Returns the initial request object. Returns `ICanBoogie\HTTP\Request`
`protected ICanBoogie\HTTP\Request`	# `get_request( )` Returns the current request. Returns the current request. Returns `ICanBoogie\HTTP\Request`
`protected string`	# `get_language( )` Returns the locale language. Returns the locale language. Returns `string`
`protected`	# `set_locale( string $id )` Sets the working locate. Sets the working locate. Parameters `$id` `string` $id Locale identifier.
`protected ICanBoogie\I18n\Locale`	# `get_locale( )` Returns the working locale object. Returns the working locale object. Returns `ICanBoogie\I18n\Locale`
`protected`	# `set_timezone( ICanBoogie\Timezone\|string\|integer $timezone )` Sets the working time zone. Sets the working time zone. When the time zone is set the default time zone is also set with date_default_timezone_set(). Parameters `$timezone` `ICanBoogie\Timezone\|string\|integer` $timezone An instance of `ICanBoogie\TimeZone`, the name of a timezone, or numeric equivalent e.g. 3600.
`protected string`	# `get_timezone( )` Returns the working time zone. Returns the working time zone. If the time zone is not defined yet it defaults to the value of date_default_timezone_get() or "UTC". Returns `string`
`protected ICanBoogie\Routes`	# `get_routes( )` Returns the route collection. Returns the route collection. Returns `ICanBoogie\Routes`
`public`	# `__invoke( )` Launch the application. Launch the application.
`protected`	# `run_modules( )` Run the enabled modules. Run the enabled modules. Before the modules are actually ran, their index is used to alter the I18n load paths, the config paths and the core's `classes aliases` config properties.
`public string`	# `generate_path( strign\|ICanBoogie\Route $pattern_or_route_id_or_route, string $params = null, array $options = [] )` Genreates a path with the specified parameters. Genreates a path with the specified parameters. Parameters `$pattern_or_route_id_or_route` `strign\|ICanBoogie\Route` $pattern_or_route_id_or_route A pattern, a route identifier or a `ICanBoogie\Route` instance. `$params` `string` $params `$options` `array` $options Returns `string`
`public`	# `generate_url( mixed $pattern_or_route_id_or_route, mixed $params = null, array $options = [] )`

Magic methods summary

Properties summary

`public static boolean`	`$is_running`	# Whether the core is running or not. Whether the core is running or not.

Magic properties

`public ICanBoogie\Configs`	`$configs`	# Configurations accessor. Configurations accessor.
`public ICanBoogie\ActiveRecord\Connections`	`$connections`	# Database connections accessor. Database connections accessor.
`public ICanBoogie\Models`	`$models`	# Models accessor. Models accessor.
`public ICanBoogie\Modules`	`$modules`	# Modules accessor. Modules accessor.
`public ICanBoogie\Vars`	`$vars`	# Persistent variables accessor. Persistent variables accessor.
`public ICanBoogie\Database`	`$db`	# Primary database connection. Primary database connection.
`public ICanBoogie\Session`	`$session`	# User's session. User's session.
`public string`	`$language`	# Locale language. Locale language.
`public string\|integer`	`$timezone`	# Date and time timezone. Date and time timezone.
`public array`	`$config`	# The "core" configuration. The "core" configuration.
`public read-only ICanBoogie\I18n\Locale`	`$locale`	# Locale object matching the locale language. Locale object matching the locale language.
`public read-only ICanBoogie\HTTP\Request`	`$request`	# The request being processed. The request being processed.
`public read-only ICanBoogie\Events`	`$events`	# Event collection. Event collection.
`public read-only ICanBoogie\Routes`	`$routes`	# Route collection. Route collection.

Magic properties inherited from ICanBoogie\Object

$prototype

Namespaces

Classes

Interfaces

Traits

Exceptions

Constants

Functions

Class Core

Direct known subclasses

Methods summary

Returns

Parameters

Parameters

Throws

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Methods inherited from ICanBoogie\Object

Methods inherited from ICanBoogie\ToArrayRecursive

Methods used from ICanBoogie\ToArrayRecursiveTrait

Methods used from ICanBoogie\PrototypeTrait

Magic methods summary

Properties summary

Magic properties

Magic properties inherited from ICanBoogie\Object