Application.php

TLDR

The Application interface defines the contract for a Laravel application. It extends the Container interface and defines methods for retrieving various paths, managing the application environment, registering service providers, booting the application, managing the application locale, and more.

Methods

version

Returns the version number of the application.

basePath

Returns the base path of the Laravel installation. This can be optionally appended with a given path.

bootstrapPath

Returns the path to the bootstrap directory. This can be optionally appended with a given path.

configPath

Returns the path to the application configuration files. This can be optionally appended with a given path.

databasePath

Returns the path to the database directory. This can be optionally appended with a given path.

langPath

Returns the path to the language files. This can be optionally appended with a given path.

publicPath

Returns the path to the public directory. This can be optionally appended with a given path.

resourcePath

Returns the path to the resources directory. This can be optionally appended with a given path.

storagePath

Returns the path to the storage directory. This can be optionally appended with a given path.

environment

Gets or checks the current application environment. If one or more environments are provided, it checks if the current environment matches any of the provided environments.

runningInConsole

Determines if the application is running in the console.

runningUnitTests

Determines if the application is running unit tests.

hasDebugModeEnabled

Determines if the application is running with debug mode enabled.

maintenanceMode

Returns an instance of the maintenance mode manager implementation.

isDownForMaintenance

Determines if the application is currently down for maintenance.

registerConfiguredProviders

Registers all of the configured providers.

register

Registers a service provider with the application.

registerDeferredProvider

Registers a deferred provider and service.

resolveProvider

Resolves a service provider instance from the class name.

boot

Boots the application's service providers.

booting

Registers a new boot listener.

booted

Registers a new "booted" listener.

bootstrapWith

Runs the given array of bootstrap classes.

getLocale

Gets the current application locale.

getNamespace

Gets the application namespace.

getProviders

Gets the registered service provider instances if any exist.

hasBeenBootstrapped

Determines if the application has been bootstrapped before.

loadDeferredProviders

Loads and boots all of the remaining deferred providers.

setLocale

Sets the current application locale.

shouldSkipMiddleware

Determines if middleware has been disabled for the application.

terminating

Registers a terminating callback with the application.

terminate

Terminates the application.

END

<?php

namespace Illuminate\Contracts\Foundation;

use Illuminate\Contracts\Container\Container;

interface Application extends Container
{
    /**
     * Get the version number of the application.
     *
     * @return string
     */
    public function version();

    /**
     * Get the base path of the Laravel installation.
     *
     * @param  string  $path
     * @return string
     */
    public function basePath($path = '');

    /**
     * Get the path to the bootstrap directory.
     *
     * @param  string  $path
     * @return string
     */
    public function bootstrapPath($path = '');

    /**
     * Get the path to the application configuration files.
     *
     * @param  string  $path
     * @return string
     */
    public function configPath($path = '');

    /**
     * Get the path to the database directory.
     *
     * @param  string  $path
     * @return string
     */
    public function databasePath($path = '');

    /**
     * Get the path to the language files.
     *
     * @param  string  $path
     * @return string
     */
    public function langPath($path = '');

    /**
     * Get the path to the public directory.
     *
     * @param  string  $path
     * @return string
     */
    public function publicPath($path = '');

    /**
     * Get the path to the resources directory.
     *
     * @param  string  $path
     * @return string
     */
    public function resourcePath($path = '');

    /**
     * Get the path to the storage directory.
     *
     * @param  string  $path
     * @return string
     */
    public function storagePath($path = '');

    /**
     * Get or check the current application environment.
     *
     * @param  string|array  ...$environments
     * @return string|bool
     */
    public function environment(...$environments);

    /**
     * Determine if the application is running in the console.
     *
     * @return bool
     */
    public function runningInConsole();

    /**
     * Determine if the application is running unit tests.
     *
     * @return bool
     */
    public function runningUnitTests();

    /**
     * Determine if the application is running with debug mode enabled.
     *
     * @return bool
     */
    public function hasDebugModeEnabled();

    /**
     * Get an instance of the maintenance mode manager implementation.
     *
     * @return \Illuminate\Contracts\Foundation\MaintenanceMode
     */
    public function maintenanceMode();

    /**
     * Determine if the application is currently down for maintenance.
     *
     * @return bool
     */
    public function isDownForMaintenance();

    /**
     * Register all of the configured providers.
     *
     * @return void
     */
    public function registerConfiguredProviders();

    /**
     * Register a service provider with the application.
     *
     * @param  \Illuminate\Support\ServiceProvider|string  $provider
     * @param  bool  $force
     * @return \Illuminate\Support\ServiceProvider
     */
    public function register($provider, $force = false);

    /**
     * Register a deferred provider and service.
     *
     * @param  string  $provider
     * @param  string|null  $service
     * @return void
     */
    public function registerDeferredProvider($provider, $service = null);

    /**
     * Resolve a service provider instance from the class name.
     *
     * @param  string  $provider
     * @return \Illuminate\Support\ServiceProvider
     */
    public function resolveProvider($provider);

    /**
     * Boot the application's service providers.
     *
     * @return void
     */
    public function boot();

    /**
     * Register a new boot listener.
     *
     * @param  callable  $callback
     * @return void
     */
    public function booting($callback);

    /**
     * Register a new "booted" listener.
     *
     * @param  callable  $callback
     * @return void
     */
    public function booted($callback);

    /**
     * Run the given array of bootstrap classes.
     *
     * @param  array  $bootstrappers
     * @return void
     */
    public function bootstrapWith(array $bootstrappers);

    /**
     * Get the current application locale.
     *
     * @return string
     */
    public function getLocale();

    /**
     * Get the application namespace.
     *
     * @return string
     *
     * @throws \RuntimeException
     */
    public function getNamespace();

    /**
     * Get the registered service provider instances if any exist.
     *
     * @param  \Illuminate\Support\ServiceProvider|string  $provider
     * @return array
     */
    public function getProviders($provider);

    /**
     * Determine if the application has been bootstrapped before.
     *
     * @return bool
     */
    public function hasBeenBootstrapped();

    /**
     * Load and boot all of the remaining deferred providers.
     *
     * @return void
     */
    public function loadDeferredProviders();

    /**
     * Set the current application locale.
     *
     * @param  string  $locale
     * @return void
     */
    public function setLocale($locale);

    /**
     * Determine if middleware has been disabled for the application.
     *
     * @return bool
     */
    public function shouldSkipMiddleware();

    /**
     * Register a terminating callback with the application.
     *
     * @param  callable|string  $callback
     * @return \Illuminate\Contracts\Foundation\Application
     */
    public function terminating($callback);

    /**
     * Terminate the application.
     *
     * @return void
     */
    public function terminate();
}