MaintenanceMode Class Reference

Public Member Functions
	__construct (Filesystem $filesystem)
	isOn ($remoteAddr='')
	set ($isOn)
	setAddresses ($addresses)
	getAddressInfo ()

Data Fields
const	FLAG_FILENAME = '.maintenance.flag'
const	IP_FILENAME = '.maintenance.ip'
const	FLAG_DIR = DirectoryList::VAR_DIR

Protected Attributes
	$flagDir

Detailed Description

Application Maintenance Mode

Definition at line 14 of file MaintenanceMode.php.

Constructor & Destructor Documentation

__construct()

__construct

(

Filesystem

$filesystem

)

Constructor

Parameters

\Magento\Framework\Filesystem

$filesystem

Definition at line 46 of file MaintenanceMode.php.

    {
        $this->flagDir = $filesystem->getDirectoryWrite(self::FLAG_DIR);
    }

Member Function Documentation

getAddressInfo()

getAddressInfo

(

)

Get list of IP addresses effective for maintenance mode

Returns

string[]

Definition at line 113 of file MaintenanceMode.php.

    {
        if ($this->flagDir->isExist(self::IP_FILENAME)) {
            $temp = $this->flagDir->readFile(self::IP_FILENAME);
            return explode(',', trim($temp));
        } else {
            return [];
        }
    }

isOn()

isOn

(

$remoteAddr = ''

)

Checks whether mode is on

Optionally specify an IP-address to compare against the white list

Parameters

string

$remoteAddr

Returns

bool

Definition at line 59 of file MaintenanceMode.php.

    {
        if (!$this->flagDir->isExist(self::FLAG_FILENAME)) {
            return false;
        }
        $info = $this->getAddressInfo();
        return !in_array($remoteAddr, $info);
    }

set()

set

(

$isOn

)

Sets maintenance mode "on" or "off"

Parameters

bool

$isOn

Returns

bool

Definition at line 74 of file MaintenanceMode.php.

    {
        if ($isOn) {
            return $this->flagDir->touch(self::FLAG_FILENAME);
        }
        if ($this->flagDir->isExist(self::FLAG_FILENAME)) {
            return $this->flagDir->delete(self::FLAG_FILENAME);
        }
        return true;
    }

setAddresses()

setAddresses

(

$addresses

)

Sets list of allowed IP addresses

Parameters

string

$addresses

Returns

bool

Exceptions

Definition at line 92 of file MaintenanceMode.php.

    {
        $addresses = (string)$addresses;
        if (empty($addresses)) {
            if ($this->flagDir->isExist(self::IP_FILENAME)) {
                return $this->flagDir->delete(self::IP_FILENAME);
            }
            return true;
        }
        if (!preg_match('/^[^\s,]+(,[^\s,]+)*$/', $addresses)) {
            throw new \InvalidArgumentException("One or more IP-addresses is expected (comma-separated)\n");
        }
        $result = $this->flagDir->writeFile(self::IP_FILENAME, $addresses);
        return false !== $result ? true : false;
    }

Field Documentation

$flagDir

$flagDir

protected

Definition at line 39 of file MaintenanceMode.php.

FLAG_DIR

const FLAG_DIR = DirectoryList::VAR_DIR

Maintenance flag dir

Definition at line 32 of file MaintenanceMode.php.

FLAG_FILENAME

const FLAG_FILENAME = '.maintenance.flag'

Maintenance flag file name

DO NOT consolidate this file and the IP white list into one. It is going to work much faster in 99% of cases: the isOn() will return false whenever file doesn't exist.

Definition at line 22 of file MaintenanceMode.php.

IP_FILENAME

const IP_FILENAME = '.maintenance.ip'

IP-addresses file name

Definition at line 27 of file MaintenanceMode.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/framework/App/MaintenanceMode.php