\
Omega
Application
Archive
Cache
Adapter
Exception
Factory
ServiceProvider
Config
ServiceProvider
Container
Exception
ServiceProvider
Database
Adapter
Command
Exception
Factory
Migration
Field
QueryBuilder
ServiceProvider
Environment
Command
Exception
Exceptions
Filesystem
Adapter
Amazon
Ftp
Local
Memory
Sftp
Contracts
Exception
Factory
ServiceProvider
Stream
Util
Http
ServiceProvider
Logging
Exception
Factory
ServiceProvider
Queue
Adapter
Command
Exception
Factory
ServiceProvider
Routing
ServiceProvider
Session
Exception
Factory
ServiceProvider
Storage
Support
Facade
Exception
Facades
Factory
Singleton
Exception
Validation
Exception
Rule
ServiceProvider
View
Engine
ServiceProvider

\Omega\Application ApplicationInterface

Application Interface Class.

Summary

Methods
Constants
getVersion()
getBasePath()
setBasePath()
getBootstrapPath()
setBootstrapPath()
getConfigPath()
setConfigPath()
getDatabasePath()
setDatabasePath()
environment()
getLangPath()
setLangPath()
getPublicPath()
setPublicPath()
getResourcePath()
getStoragePath()
setStoragePath()
setCurrentTimeZone()
getCurrentTimeZone()
No public constants found

Methods

getVersion()

getVersion() : string

Get the version of the application.

Returns

string —

Return the version of the application.

getBasePath()

getBasePath(string  $path = '') : string

Get the base path of the Omega installation.

Parameters

string $path

Holds the application path.

Returns

string —

Return the path of Omega installation.

setBasePath()

setBasePath(string  $basePath) : $this

Set the base path for Omega installation.

Parameters

string $basePath

Holds the application path.

Returns

$this —

getBootstrapPath()

getBootstrapPath(string  $path = '') : string

Get the path to the bootstrap directory defined by the developer.

Parameters

string $path

Holds the custom bootstrap path defined by the developer.

Returns

string —

Return the path for bootstrap directory.

setBootstrapPath()

setBootstrapPath(string  $path) : $this

Set bootstrap file directory path.

Parameters

string $path

Holds the application path.

Returns

$this —

getConfigPath()

getConfigPath(string  $path = '') : string

Get the path to the configuration directory defined by the developer.

Parameters

string $path

Holds the custom configuration path defined by the developer.

Returns

string —

Return the path for the configuration path.

setConfigPath()

setConfigPath(string  $path) : $this

Set the configuration directory path.

Parameters

string $path

Holds the application path.

Returns

$this —

getDatabasePath()

getDatabasePath(string  $path = '') : string

Get the path to the database directory defined by the developer.

Parameters

string $path

Holds the custom database path defined by the developer.

Returns

string —

Return the path for the database files.

setDatabasePath()

setDatabasePath(string  $path) : $this

Set the database directory path.

Parameters

string $path

Holds the application path.

Returns

$this —

environment()

environment(string|string[]  ...$environments) : string|bool

Get or check the current application environment.

This method allows you to either retrieve the current environment or check if the application is running in a specific environment.

Parameters

string|string[] $environments variadic

One or more environment names to check against the current environment.

If no parameters are provided, the method returns the current environment as a string. If one or more environment names are provided, the method returns true if the current environment matches any of the provided names; otherwise, it returns false.

Returns

string|bool —

The current environment as a string if no parameters are provided; true or false if checking against the provided environments.

getLangPath()

getLangPath(string  $path = '') : string

Get the path to the language directory defined by the developer.

Parameters

string $path

Holds the custom language path defined by the developer.

Returns

string —

Return the path to the language file directory.

setLangPath()

setLangPath(string  $path) : $this

Set the lang directory path.

Parameters

string $path

Holds the application path.

Returns

$this —

getPublicPath()

getPublicPath(string  $path = '') : string

Get the path to the public/web directory defined by the developer.

Parameters

string $path

Holds the custom public/web path defined by the developer.

Returns

string —

Return the path to the public/web path directory.

setPublicPath()

setPublicPath(string  $path) : $this

Set the public directory path.

Parameters

string $path

Holds the application path.

Returns

$this —

getResourcePath()

getResourcePath(string  $path = '') : string

Get the path to the resources directory.

Parameters

string $path

Holds the application resources path.

Returns

string —

Return the path to the resources path directory.

getStoragePath()

getStoragePath(string  $path = '') : string

Get the path to the storage directory.

Parameters

string $path

Holds the storage path.

Returns

string —

Return the path to the storage path directory.

setStoragePath()

setStoragePath(string  $path) : $this

Set the storage directory path.

Parameters

string $path

Holds the application path.

Returns

$this —

setCurrentTimeZone()

setCurrentTimeZone() : $this

Sets the default timezone for the application.

This method reads the timezone from the application configuration and sets it as the default timezone for all date and time operations within the application.

Returns

$this —

Returns a reference to the current object for method chaining.

getCurrentTimeZone()

getCurrentTimeZone() : string

Gets the current date and time formatted according to the application timezone.

Returns

string —

The formatted current date and time.