Jet\Config_Section
This class inherits from Jet\Config and is intended to be inherited by the configuration section-defining classes.
Method | Meaning |
---|---|
public __construct( array $data = null ) | It behaves similarly to the parent constructor. That is, if it receives configuration data on input, it sets it immediately. The important difference is that it does not load the data from the file. |
public getDefinition( ): Config_Definition_Config_Section | Returns an instance of the definition. |
public setConfig( Config $config ): void | Since this is a section of some configuration, i.e. a sub-element, it is important that the section knows what configuration it belongs to. This is what this method is used for, which is primarily called internally. |
public getConfig( ): Config | Returns the instance of the configuration to which section it belongs. |
public getConfigFilePath( ): string | Returns the path to the configuration file. Actually calls the getConfigFilePath method of the parent configuration. Useful for convenience and clarity. For example, when you are creating a tool that edits a specific database connection, you can work directly with an instance of that connection's configuration. |
public setConfigFilePath( string $config_file_path ): void | Sets the path to the configuration file. Effectively calls the setConfigFilePath method of the parent configuration. Useful for convenience and clarity. For example, when you create a tool that edits a specific database connection, you can work directly with an instance of that connection's configuration. |
public readConfigFileData( ): array | Read the raw configuration data. Actually calls the readConfigFileData method of the parent configuration. Useful for convenience and clarity. For example, when you create a tool that edits a specific database connection, you can work directly with the configuration instance of that connection. |
public saveConfigFile( ): void | Writes data to the configuration file. Effectively calls the saveConfigFile method of the parent configuration. Useful for convenience and clarity. For example, when you are creating a tool that edits a specific database connection, you can work directly with an instance of that connection's configuration. |