PHP Class Inpsyde\MultilingualPress\Core\ImmutablePluginProperties

Since: 3.0.0
Inheritance: implements Inpsyde\MultilingualPress\Common\PluginProperties
Datei anzeigen Open project: inpsyde/multilingual-press

Public Methods

Method Description
__construct ( string $plugin_file_path ) Constructor. Sets up the properties.
offsetExists ( string $name ) : boolean Checks if a property with the given name exists.
offsetGet ( string $name ) : mixed Returns the value of the property with the given name.
offsetSet ( string $name, mixed $value ) : void Stores the given value with the given name.
offsetUnset ( string $name ) : void Removes the property with the given name.
plugin_base_name ( ) : string Returns the base name of the plugin.
plugin_dir_path ( ) : string Returns the absolute path of the plugin root folder.
plugin_dir_url ( ) : string Returns the URL of the plugin root folder.
plugin_file_path ( ) : string Returns the absolute path of main plugin file.
plugin_name ( ) : string Returns the plugin name as given in the plugin headers.
plugin_website ( ) : string Returns the URL of the plugin website.
text_domain ( ) : string Returns the plugin text domain.
text_domain_path ( ) : string Returns the absolute path of the folder with the plugin translation files.
version ( ) : string Returns the plugin version.

Method Details

__construct() public method

Constructor. Sets up the properties.
Since: 3.0.0
public __construct ( string $plugin_file_path )
$plugin_file_path string Main plugin file path.

offsetExists() public method

Checks if a property with the given name exists.
Since: 3.0.0
public offsetExists ( string $name ) : boolean
$name string The name of a property.
return boolean Whether or not a property with the given name exists.

offsetGet() public method

Returns the value of the property with the given name.
Since: 3.0.0
public offsetGet ( string $name ) : mixed
$name string The name of a property.
return mixed The value of the property with the given name.

offsetSet() public method

Setting properties is not allowed.
Since: 3.0.0
public offsetSet ( string $name, mixed $value ) : void
$name string The name of a property.
$value mixed The value.
return void

offsetUnset() public method

Removing properties is not allowed.
Since: 3.0.0
public offsetUnset ( string $name ) : void
$name string The name of a property.
return void

plugin_base_name() public method

Returns the base name of the plugin.
Since: 3.0.0
public plugin_base_name ( ) : string
return string The base name of the plugin.

plugin_dir_path() public method

Returns the absolute path of the plugin root folder.
Since: 3.0.0
public plugin_dir_path ( ) : string
return string The absolute path of the plugin root folder.

plugin_dir_url() public method

Returns the URL of the plugin root folder.
Since: 3.0.0
public plugin_dir_url ( ) : string
return string The URL of the plugin root folder.

plugin_file_path() public method

Returns the absolute path of main plugin file.
Since: 3.0.0
public plugin_file_path ( ) : string
return string The absolute path of main plugin file.

plugin_name() public method

Returns the plugin name as given in the plugin headers.
Since: 3.0.0
public plugin_name ( ) : string
return string The plugin name.

plugin_website() public method

Returns the URL of the plugin website.
Since: 3.0.0
public plugin_website ( ) : string
return string The URL of the plugin website

text_domain() public method

Returns the plugin text domain.
Since: 3.0.0
public text_domain ( ) : string
return string The plugin text domain.

text_domain_path() public method

Returns the absolute path of the folder with the plugin translation files.
Since: 3.0.0
public text_domain_path ( ) : string
return string The absolute path of the folder with the plugin translation files.

version() public method

Returns the plugin version.
Since: 3.0.0
public version ( ) : string
return string The plugin version.