Class MaintenanceConfig

__construct()

__construct() 

Constructs a AbstractConfigData object

• Inherited from \AbstractConfigData

Tags

None found

synchronize()

synchronize() 

This method is not used in the configuration context.

{@inheritdoc}

final

• Inherited from \AbstractConfigData

Tags

None found

set_default_values()

set_default_values() 

Redefine this method if you want to avoid getting errors while asking values.

If some entries doesn't exist, they can be created here.

• Inherited from \AbstractConfigData

Tags

None found

get_property()

get_property(string $name) : string

Reads a property's value.

Parameters

string

$name

Name of the property to read

Returns

string —

the read value

• Inherited from \AbstractConfigData

Tags

None found

set_property()

set_property(string $name, string $value) 

Sets a property value. If the property exists, it overrides its value, otherwise, it creates an entry for this property.

Parameters

string	$name	Name of the property
string	$value	Value of the property

• Inherited from \AbstractConfigData

Tags

None found

get_default_values()

get_default_values() : \string[mixed]

Returns a map associating to each property name the corresponding default value

Returns

\string[mixed]

• Inherited from \MaintenanceConfig

Tags

None found

is_maintenance_enabled()

is_maintenance_enabled() 

• Inherited from \MaintenanceConfig

Tags

None found

set_maintenance_enabled()

set_maintenance_enabled( $enabled) 

Parameters

$enabled

• Inherited from \MaintenanceConfig

Tags

None found

enable_maintenance()

enable_maintenance() 

• Inherited from \MaintenanceConfig

Tags

None found

disable_maintenance()

disable_maintenance() 

• Inherited from \MaintenanceConfig

Tags

None found

is_unlimited_maintenance()

is_unlimited_maintenance() 

• Inherited from \MaintenanceConfig

Tags

None found

set_unlimited_maintenance()

set_unlimited_maintenance( $unlimited) 

Parameters

$unlimited

• Inherited from \MaintenanceConfig

Tags

None found

get_end_date()

get_end_date() : \Date

Returns

\Date

• Inherited from \MaintenanceConfig

Tags

None found

set_end_date()

set_end_date(\Date $date) 

Parameters

\Date

$date

• Inherited from \MaintenanceConfig

Tags

None found

get_message()

get_message() 

• Inherited from \MaintenanceConfig

Tags

None found

set_message()

set_message( $message) 

Parameters

$message

• Inherited from \MaintenanceConfig

Tags

None found

get_auth()

get_auth() 

• Inherited from \MaintenanceConfig

Tags

None found

set_auth()

set_auth(array $auth) 

Parameters

array

$auth

• Inherited from \MaintenanceConfig

Tags

None found

get_display_duration()

get_display_duration() 

• Inherited from \MaintenanceConfig

Tags

None found

set_display_duration()

set_display_duration( $display) 

Parameters

$display

• Inherited from \MaintenanceConfig

Tags

None found

get_display_duration_for_admin()

get_display_duration_for_admin() 

• Inherited from \MaintenanceConfig

Tags

None found

set_display_duration_for_admin()

set_display_duration_for_admin( $display) 

Parameters

$display

• Inherited from \MaintenanceConfig

Tags

None found

is_end_date_not_reached()

is_end_date_not_reached() 

• Inherited from \MaintenanceConfig

Tags

None found

is_under_maintenance()

is_under_maintenance() 

• Inherited from \MaintenanceConfig

Tags

None found

is_authorized_in_maintenance()

is_authorized_in_maintenance() 

• Inherited from \MaintenanceConfig

Tags

None found

load()

load() : \MaintenanceConfig

Returns the configuration.

Returns

\MaintenanceConfig

static

• Inherited from \MaintenanceConfig

Tags

None found

save()

save() 

Saves the configuration in the database. Has it become persistent.

static

• Inherited from \MaintenanceConfig

Tags

None found

get_default_value()

get_default_value( $property) 

Parameters

$property

• Inherited from \AbstractConfigData

Tags

None found