WpConfiguration

The WpConfiguration class manages configuration files and parsers

WpConfigParser

Wp.ConfigParser

Methods

wp_config_parser_add_file

gboolean
wp_config_parser_add_file (WpConfigParser * self,
                           const char* location)

Adds the file at location on the parser and parses all the information from it, making it available to the code that needs this configuration

Parameters:

self –

the parser

location –

path to a configuration file

Returns –

TRUE on success, FALSE if an error occurred

Wp.ConfigParser.add_file

def Wp.ConfigParser.add_file (self, location):
    #python wrapper for 'wp_config_parser_add_file'

Adds the file at location on the parser and parses all the information from it, making it available to the code that needs this configuration

Parameters:

self ( Wp.ConfigParser ) –

the parser

location ( str ) –

path to a configuration file

Returns ( bool ) –

True on success, False if an error occurred

Wp.ConfigParser.prototype.add_file

function Wp.ConfigParser.prototype.add_file(location: String): {
    // javascript wrapper for 'wp_config_parser_add_file'
}

Adds the file at location on the parser and parses all the information from it, making it available to the code that needs this configuration

Parameters:

self ( Wp.ConfigParser ) –

the parser

location ( String ) –

path to a configuration file

Returns ( Number ) –

true on success, false if an error occurred

wp_config_parser_get_matched_data

gconstpointer
wp_config_parser_get_matched_data (WpConfigParser * self,
                                   gpointer data)

Parameters:

self –

the parser

data –

implementation-specific data

Returns –

the matched data

Wp.ConfigParser.get_matched_data

def Wp.ConfigParser.get_matched_data (self, data):
    #python wrapper for 'wp_config_parser_get_matched_data'

Parameters:

self ( Wp.ConfigParser ) –

the parser

data ( object ) –

implementation-specific data

Returns ( object ) –

the matched data

Wp.ConfigParser.prototype.get_matched_data

function Wp.ConfigParser.prototype.get_matched_data(data: Object): {
    // javascript wrapper for 'wp_config_parser_get_matched_data'
}

Parameters:

self ( Wp.ConfigParser ) –

the parser

data ( Object ) –

implementation-specific data

Returns ( Object ) –

the matched data

wp_config_parser_reset

wp_config_parser_reset (WpConfigParser * self)

Resets the state of the parser

Parameters:

self –

the parser

Wp.ConfigParser.reset

def Wp.ConfigParser.reset (self):
    #python wrapper for 'wp_config_parser_reset'

Resets the state of the parser

Parameters:

self ( Wp.ConfigParser ) –

the parser

Wp.ConfigParser.prototype.reset

function Wp.ConfigParser.prototype.reset(): {
    // javascript wrapper for 'wp_config_parser_reset'
}

Resets the state of the parser

Parameters:

self ( Wp.ConfigParser ) –

the parser

Virtual Methods

add_file

gboolean
add_file (WpConfigParser * self,
          const gchar * location)

See wp_config_parser_add_file

Parameters:

self –

No description available

location –

No description available

Returns –

No description available

do_add_file

def do_add_file (self, location):
    #python implementation of the 'add_file' virtual method

See Wp.ConfigParser.add_file

Parameters:

self ( Wp.ConfigParser ) –

No description available

location ( str ) –

No description available

Returns ( bool ) –

No description available

vfunc_add_file

function vfunc_add_file(self: Wp.ConfigParser, location: String): {
    // javascript implementation of the 'add_file' virtual method
}

See Wp.ConfigParser.prototype.add_file

Parameters:

self ( Wp.ConfigParser ) –

No description available

location ( String ) –

No description available

Returns ( Number ) –

No description available

get_matched_data

gconstpointer
get_matched_data (WpConfigParser * self,
                  gpointer data)

See wp_config_parser_get_matched_data

Parameters:

self –

No description available

data –

No description available

Returns –

No description available

do_get_matched_data

def do_get_matched_data (self, data):
    #python implementation of the 'get_matched_data' virtual method

See Wp.ConfigParser.get_matched_data

Parameters:

self ( Wp.ConfigParser ) –

No description available

data ( object ) –

No description available

Returns ( object ) –

No description available

vfunc_get_matched_data

function vfunc_get_matched_data(self: Wp.ConfigParser, data: Object): {
    // javascript implementation of the 'get_matched_data' virtual method
}

See Wp.ConfigParser.prototype.get_matched_data

Parameters:

self ( Wp.ConfigParser ) –

No description available

data ( Object ) –

No description available

Returns ( Object ) –

No description available

reset

reset (WpConfigParser * self)

See wp_config_parser_reset

Parameters:

self –

No description available

do_reset

def do_reset (self):
    #python implementation of the 'reset' virtual method

See Wp.ConfigParser.reset

Parameters:

self ( Wp.ConfigParser ) –

No description available

vfunc_reset

function vfunc_reset(self: Wp.ConfigParser): {
    // javascript implementation of the 'reset' virtual method
}

See Wp.ConfigParser.prototype.reset

Parameters:

self ( Wp.ConfigParser ) –

No description available

WpConfiguration

GObject
    ╰──WpConfiguration

Class structure

WpConfigurationClass

Fields

parent_class (GObjectClass) –

No description available

Wp.ConfigurationClass

Attributes

parent_class (GObject.ObjectClass) –

No description available

Wp.ConfigurationClass

Attributes

parent_class (GObject.ObjectClass) –

No description available

WpConfiguration

GObject
    ╰──WpConfiguration

WpConfiguration

GObject
    ╰──WpConfiguration

Methods

wp_configuration_add_extension

gboolean
wp_configuration_add_extension (WpConfiguration * self,
                                const gchar * extension,
                                GType parser_type)

Creates a parser and associates it with the specified filename extension. All configuration files that match this extension will, upon calling wp_configuration_reload, be added to this parser

Parameters:

self –

the configuration

extension –

a filename extension

parser_type –

a type that implements the WpConfigParser interface

Returns –

TRUE if the extension is new, FALSE if it was already added or an error occurred

Wp.Configuration.add_extension

def Wp.Configuration.add_extension (self, extension, parser_type):
    #python wrapper for 'wp_configuration_add_extension'

Creates a parser and associates it with the specified filename extension. All configuration files that match this extension will, upon calling Wp.Configuration.reload, be added to this parser

Parameters:

self ( Wp.Configuration ) –

the configuration

extension ( str ) –

a filename extension

parser_type ( GObject.Type ) –

a type that implements the Wp.ConfigParser interface

Returns ( bool ) –

True if the extension is new, False if it was already added or an error occurred

Wp.Configuration.prototype.add_extension

function Wp.Configuration.prototype.add_extension(extension: String, parser_type: GObject.Type): {
    // javascript wrapper for 'wp_configuration_add_extension'
}

Creates a parser and associates it with the specified filename extension. All configuration files that match this extension will, upon calling Wp.Configuration.prototype.reload, be added to this parser

Parameters:

self ( Wp.Configuration ) –

the configuration

extension ( String ) –

a filename extension

parser_type ( GObject.Type ) –

a type that implements the Wp.ConfigParser interface

Returns ( Number ) –

true if the extension is new, false if it was already added or an error occurred

wp_configuration_add_path

wp_configuration_add_path (WpConfiguration * self,
                           const char* path)

Adds the specified path in the list of directories that are being searched for configuration files. All files in this directory that have a known extension to this WpConfiguration instance will be parsed and made available through their WpConfigParser

Parameters:

self –

the configuration

path –

path to a directory that contains configuration files

Wp.Configuration.add_path

def Wp.Configuration.add_path (self, path):
    #python wrapper for 'wp_configuration_add_path'

Adds the specified path in the list of directories that are being searched for configuration files. All files in this directory that have a known extension to this Wp.Configuration instance will be parsed and made available through their Wp.ConfigParser

Parameters:

self ( Wp.Configuration ) –

the configuration

path ( str ) –

path to a directory that contains configuration files

Wp.Configuration.prototype.add_path

function Wp.Configuration.prototype.add_path(path: String): {
    // javascript wrapper for 'wp_configuration_add_path'
}

Parameters:

self ( Wp.Configuration ) –

the configuration

path ( String ) –

path to a directory that contains configuration files

wp_configuration_get_parser

WpConfigParser *
wp_configuration_get_parser (WpConfiguration * self,
                             const char* extension)

Parameters:

self –

the configuration

extension –

a filename extension that was previously associated with a parser using wp_configuration_add_extension

Returns ( [transfer: full] [nullable] ) –

the parser associated with extension

Wp.Configuration.get_parser

def Wp.Configuration.get_parser (self, extension):
    #python wrapper for 'wp_configuration_get_parser'

Parameters:

self ( Wp.Configuration ) –

the configuration

extension ( str ) –

a filename extension that was previously associated with a parser using Wp.Configuration.add_extension

Returns ( Wp.ConfigParser ) –

the parser associated with extension

Wp.Configuration.prototype.get_parser

function Wp.Configuration.prototype.get_parser(extension: String): {
    // javascript wrapper for 'wp_configuration_get_parser'
}

Parameters:

self ( Wp.Configuration ) –

the configuration

extension ( String ) –

a filename extension that was previously associated with a parser using Wp.Configuration.prototype.add_extension

Returns ( Wp.ConfigParser ) –

the parser associated with extension

wp_configuration_reload

wp_configuration_reload (WpConfiguration * self,
                         const char* extension)

Resets the parser associated with extension and re-adds (and re-parses) all the configuration files that have this extension from all the directories that were added with wp_configuration_add_path

Parameters:

self –

the configuration

extension –

a filename extension that was previously associated with a parser using wp_configuration_add_extension

Wp.Configuration.reload

def Wp.Configuration.reload (self, extension):
    #python wrapper for 'wp_configuration_reload'

Resets the parser associated with extension and re-adds (and re-parses) all the configuration files that have this extension from all the directories that were added with Wp.Configuration.add_path

Parameters:

self ( Wp.Configuration ) –

the configuration

extension ( str ) –

a filename extension that was previously associated with a parser using Wp.Configuration.add_extension

Wp.Configuration.prototype.reload

function Wp.Configuration.prototype.reload(extension: String): {
    // javascript wrapper for 'wp_configuration_reload'
}

Parameters:

self ( Wp.Configuration ) –

the configuration

extension ( String ) –

a filename extension that was previously associated with a parser using Wp.Configuration.prototype.add_extension

wp_configuration_remove_extension

gboolean
wp_configuration_remove_extension (WpConfiguration * self,
                                   const gchar * extension)

Removes the association of extension to a parser and destroys the parser

Parameters:

self –

the configuration

extension –

a filename extension that was previously associated with a parser using wp_configuration_add_extension

Returns –

TRUE if the extension was indeed removed, FALSE if it was not added

Wp.Configuration.remove_extension

def Wp.Configuration.remove_extension (self, extension):
    #python wrapper for 'wp_configuration_remove_extension'

Removes the association of extension to a parser and destroys the parser

Parameters:

self ( Wp.Configuration ) –

the configuration

extension ( str ) –

a filename extension that was previously associated with a parser using Wp.Configuration.add_extension

Returns ( bool ) –

True if the extension was indeed removed, False if it was not added

Wp.Configuration.prototype.remove_extension

function Wp.Configuration.prototype.remove_extension(extension: String): {
    // javascript wrapper for 'wp_configuration_remove_extension'
}

Removes the association of extension to a parser and destroys the parser

Parameters:

self ( Wp.Configuration ) –

the configuration

extension ( String ) –

a filename extension that was previously associated with a parser using Wp.Configuration.prototype.add_extension

Returns ( Number ) –

true if the extension was indeed removed, false if it was not added

wp_configuration_remove_path

wp_configuration_remove_path (WpConfiguration * self,
                              const char* path)

Removes the specified path from the list of directories that are being searched for configuration files

Parameters:

self –

the configuration

path –

path to a directory that was previously added with wp_configuration_add_path

Wp.Configuration.remove_path

def Wp.Configuration.remove_path (self, path):
    #python wrapper for 'wp_configuration_remove_path'

Removes the specified path from the list of directories that are being searched for configuration files

Parameters:

self ( Wp.Configuration ) –

the configuration

path ( str ) –

path to a directory that was previously added with Wp.Configuration.add_path

Wp.Configuration.prototype.remove_path

function Wp.Configuration.prototype.remove_path(path: String): {
    // javascript wrapper for 'wp_configuration_remove_path'
}

Removes the specified path from the list of directories that are being searched for configuration files

Parameters:

self ( Wp.Configuration ) –

the configuration

path ( String ) –

path to a directory that was previously added with Wp.Configuration.prototype.add_path

Functions

wp_configuration_get_instance

WpConfiguration *
wp_configuration_get_instance (WpCore * core)

Retrieves (and creates, the first time) the instance of WpConfiguration that is registered on the specified core

Parameters:

core –

the core

Returns ( [transfer: full] ) –

the core-specific instance of WpConfiguration

Wp.Configuration.get_instance

def Wp.Configuration.get_instance (core):
    #python wrapper for 'wp_configuration_get_instance'

Retrieves (and creates, the first time) the instance of Wp.Configuration that is registered on the specified core

Parameters:

core ( Wp.Core ) –

the core

Returns ( Wp.Configuration ) –

the core-specific instance of Wp.Configuration

Wp.Configuration.prototype.get_instance

function Wp.Configuration.prototype.get_instance(core: Wp.Core): {
    // javascript wrapper for 'wp_configuration_get_instance'
}

Retrieves (and creates, the first time) the instance of Wp.Configuration that is registered on the specified core

Parameters:

core ( Wp.Core ) –

the core

Returns ( Wp.Configuration ) –

the core-specific instance of Wp.Configuration

Constants

WP_TYPE_CONFIGURATION

#define WP_TYPE_CONFIGURATION (wp_configuration_get_type ())

The WpConfiguration GType

WP_TYPE_CONFIG_PARSER

#define WP_TYPE_CONFIG_PARSER (wp_config_parser_get_type ())

The WpConfigParser GType

The results of the search are