Class Core

Core of the ICanBoogie framework.

ICanBoogie\Core uses ICanBoogie\PrototypeTrait (not available) ICanBoogie\Binding\Event\CoreBindings (not available) ICanBoogie\Binding\HTTP\CoreBindings (not available)

Namespace: ICanBoogie
Located at Core.php

Methods summary


				
				 protected 
				
				

				get_is_configured( void )
				

				: boolean

Whether the core is configured.


				
				 protected 
				
				

				get_is_booting( void )
				

				: boolean

Whether the core is booting.


				
				 protected 
				
				

				get_is_booted( void )
				

				: boolean

Whether the core is booted.


				
				 protected 
				
				

				get_is_running( void )
				

				: boolean

Whether the core is running.


				
				 public static
				
				

				get( void )
				

				: ICanBoogie\Core

Returns the unique instance of the core object.


				
				 public 
				
				

				__construct( array $options = [] )

Constructor.


				
				 public 
				
				

				assert_not_booted( void )

Asserts that the application is not booted yet.


				
				 public 
				
				

				assert_not_running( void )

Asserts that the application is not running yet.


				
				 protected 
				
				

				create_config_manager( array $paths, array $synthesizers )
				

				: Config

Returns configuration manager.


				
				 protected 
				
				

				apply_config( array $config )

Applies low-level configuration.


				
				 protected 
				
				

				create_storage( string|callable $engine )
				

				: ICanBoogie\Storage\Storage

Creates a storage engine.


				
				 protected 
				
				

				create_storage_for_configs( string|callable $engine )
				

				: ICanBoogie\Storage\Storage

Creates storage engine for synthesized configs.


				
				 protected 
				
				

				get_storage_for_configs( void )
				

				: ICanBoogie\Storage\Storage


				
				 protected 
				
				

				create_storage_for_vars( string|callable $engine )
				

				: ICanBoogie\Storage\Storage

Creates storage engine for variables.


				
				 protected 
				
				

				lazy_get_vars( void )
				

				: ICanBoogie\Storage\Storage

Returns the non-volatile variables registry.


				
				 protected 
				
				

				lazy_get_config( void )
				

				: array

Returns the core configuration.


				
				 protected 
				
				

				set_timezone( TimeZone|string|integer $timezone )

Sets the working time zone.


				
				 protected 
				
				

				get_timezone( void )
				

				: TimeZone

Returns the working time zone.


				
				 protected 
				
				

				change_status( integer $status, callable $callable )
				

				: mixed

Changes the status of the application.


				
				 protected 
				
				

				configure( void )

Configures the application.


				
				 public 
				
				

				boot( void )

Boot the modules and configure Debug, Prototype and Events.

The boot event of class ICanBoogie\Core\BootEvent is fired after the boot is finished.

The ICANBOOGIE_READY_TIME_FLOAT key is added to the $_SERVER super global with the micro-time at which the boot finished.

Throws

ICanBoogie\CoreAlreadyBooted
in attempt to boot the core twice.


				
				 public 
				
				

				__invoke( ICanBoogie\HTTP\Request $request = null )

Run the application.

In order to avoid error messages triggered by PHP fatal errors to be send with a 200 (Ok) HTTP code, the HTTP code is changed to 500 before the core is run (and booted). When the process runs properly the HTTP code is changed to the appropriate value by the response.

The ICanBoogie\Core::boot() method is invoked if the core has not booted yet.

Parameters

$request: The request to handle. If null, the initial request is used.


				
				 protected 
				
				

				run( ICanBoogie\HTTP\Request $request )

Fires the ICanBoogie\Core::run event.


				
				 protected 
				
				

				terminate( ICanBoogie\HTTP\Request $request, ICanBoogie\HTTP\Response $response )

Terminate the application.


				
				 protected 
				
				

				initialize_response_header( void )

Initializes default response header.

Constants summary


				
STATUS_VOID				

                : integer

Status of the application.


				
STATUS_INSTANTIATING				

                : integer


				
STATUS_INSTANTIATED				

                : integer


				
STATUS_CONFIGURING				

                : integer


				
STATUS_CONFIGURED				

                : integer


				
STATUS_BOOTING				

                : integer


				
STATUS_BOOTED				

                : integer


				
STATUS_RUNNING				

                : integer


				
STATUS_TERMINATED				

                : integer

Properties summary

Magic properties


				
				public  
				

				
$configs				

				: Config

Configurations manager.


				
				public  
				

				
$vars				

				: ICanBoogie\Storage\Storage

Persistent variables registry.


				
				public  
				

				
$session				

				: Session

User's session.


				
				public  
				

				
$language				

				: string

Locale language.


				
				public  
				

				
$timezone				

				: string|integer

Time zone.


				
				public  
				

				
$config				

				: array

The "core" configuration.


				
				public  read-only
				

				
$is_configured				

				: boolean

true if the core is configured, false otherwise.


				
				public  read-only
				

				
$is_booting				

				: boolean

true if the core is booting, false otherwise.


				
				public  read-only
				

				
$is_booted				

				: boolean

true if the core is booted, false otherwise.


				
				public  read-only
				

				
$is_running				

				: boolean

true if the core is running, false otherwise.


				
				public  read-only
				

				
$logger				

				: ICanBoogie\LoggerInterface

The message logger.


				
				public  read-only
				

				
$storage_for_configs				

				: ICanBoogie\Storage\Storage