Class GeneralConfig

__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_site_url()

get_site_url() 

• Inherited from \GeneralConfig

Tags

None found

get_complete_site_url()

get_complete_site_url() 

• Inherited from \GeneralConfig

Tags

None found

is_site_url_https()

is_site_url_https() 

• Inherited from \GeneralConfig

Tags

None found

set_site_url()

set_site_url(string $url) 

Parameters

string

$url

The URL must begin with a protocol (for instance http://) and must not end with a slash.

• Inherited from \GeneralConfig

Tags

None found

get_site_path()

get_site_path() 

• Inherited from \GeneralConfig

Tags

None found

set_site_path()

set_site_path( $path) 

Parameters

$path

• Inherited from \GeneralConfig

Tags

None found

get_phpboost_major_version()

get_phpboost_major_version() 

• Inherited from \GeneralConfig

Tags

None found

set_phpboost_major_version()

set_phpboost_major_version( $version) 

Parameters

$version

• Inherited from \GeneralConfig

Tags

None found

get_site_install_date()

get_site_install_date() : \Date

Returns

\Date

• Inherited from \GeneralConfig

Tags

None found

set_site_install_date()

set_site_install_date(\Date $date) 

Parameters

\Date

$date

• Inherited from \GeneralConfig

Tags

None found

get_site_timezone()

get_site_timezone() 

• Inherited from \GeneralConfig

Tags

None found

set_site_timezone()

set_site_timezone( $timezone) 

Parameters

$timezone

• Inherited from \GeneralConfig

Tags

None found

get_default_site_url()

get_default_site_url() 

static

• Inherited from \GeneralConfig

Tags

None found

get_default_site_path()

get_default_site_path() 

static

• Inherited from \GeneralConfig

Tags

None found

get_site_name()

get_site_name() 

• Inherited from \GeneralConfig

Tags

None found

set_site_name()

set_site_name( $site_name) 

Parameters

$site_name

• Inherited from \GeneralConfig

Tags

None found

get_site_slogan()

get_site_slogan() 

• Inherited from \GeneralConfig

Tags

None found

set_site_slogan()

set_site_slogan( $site_slogan) 

Parameters

$site_slogan

• Inherited from \GeneralConfig

Tags

None found

get_site_description()

get_site_description() 

• Inherited from \GeneralConfig

Tags

None found

set_site_description()

set_site_description( $site_description) 

Parameters

$site_description

• Inherited from \GeneralConfig

Tags

None found

get_module_home_page()

get_module_home_page() 

• Inherited from \GeneralConfig

Tags

None found

set_module_home_page()

set_module_home_page( $start_page) 

Parameters

$start_page

• Inherited from \GeneralConfig

Tags

None found

get_other_home_page()

get_other_home_page() 

• Inherited from \GeneralConfig

Tags

None found

set_other_home_page()

set_other_home_page( $start_page) 

Parameters

$start_page

• Inherited from \GeneralConfig

Tags

None found

load()

load() : \GeneralConfig

Returns the configuration.

Returns

\GeneralConfig

static

• Inherited from \GeneralConfig

Tags

None found

save()

save() 

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

static

• Inherited from \GeneralConfig

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 \GeneralConfig

Tags

None found

get_default_value()

get_default_value( $property) 

Parameters

$property

• Inherited from \AbstractConfigData

Tags

None found

remove_dirs_from_root()

remove_dirs_from_root( $path) 

Parameters

$path

static

• Inherited from \GeneralConfig

Tags

None found