LocalConfigurationHelpers
extends ConfigurationHelpers
in package
Uses
DbProfileHelpersTrait
Tags
Table of Contents
- $globalSetup : GlobalSetup
- global setup.
- $interactiveConfigurator : InteractiveConfigurator
- __construct() : mixed
- cli() : InteractiveConfigurator
- configFilePath() : string
- Path to the configuration directory.
- copyDirectoryContent() : mixed
- copy the whole content of a directory existing in the install/ directory of the component, to the given directory.
- copyFile() : mixed
- copy a file from the install/ directory to an other.
- createEntryPoint() : mixed
- Create a new entry point.
- declareDbProfile() : bool
- declare a new db profile. if the content of the section is not given, it will declare an alias to the default profile.
- declareGlobalWebAssets() : mixed
- declare web assets into the main configuration.
- findDbProfile() : array<string|int, mixed>
- forLocalConfiguration() : mixed
- getConfigIni() : IniModifierArray
- default config, main config combined with or without local config.
- getCoordPluginConfig() : null|array<string|int, mixed>
- return the section name of configuration of a plugin for the coordinator or the IniModifier for the configuration file of the plugin if it exists.
- getEntryPointsById() : EntryPointPreConfigurator
- getEntryPointsByType() : array<string|int, EntryPointPreConfigurator>
- getEntryPointsList() : array<string|int, EntryPointPreConfigurator>
- List of entry points of the application.
- getMainEntryPoint() : EntryPointPreConfigurator
- Main entrypoint of the application (in most of case, index.php).
- getProfilesIni() : mixed
- getSingleConfigIni() : IniModifierInterface|IniReaderInterface
- main config or local config ini file alone.
- removeDbProfile() : mixed
- remove a db profile.
- removeDirectoryContent() : mixed
- remove the whole content of a directory from the application.
- removeEntryPoint() : mixed
- Remove an entry point that was installed by a module
- removeFile() : mixed
- delete a file from the the application.
- removeGlobalWebAssets() : mixed
- remove web assets from the main configuration.
- setupModuleWebFiles() : mixed
- Install web files of a module.
- updateEntryPointFile() : mixed
- expandPath() : mixed
- updateOrCreateEntryPointFile() : mixed
Properties
$globalSetup
global setup.
protected
GlobalSetup
$globalSetup
Tags
$interactiveConfigurator
protected
InteractiveConfigurator
$interactiveConfigurator
Tags
Methods
__construct()
public
__construct(GlobalSetup $setup) : mixed
Parameters
- $setup : GlobalSetup
Tags
Return values
mixed —cli()
public
cli() : InteractiveConfigurator
Tags
Return values
InteractiveConfigurator —configFilePath()
Path to the configuration directory.
public
configFilePath([string $file = '' ]) : string
It gives the path to app/system or local/config, depending on if the configuration is for the application or for the instance
Parameters
- $file : string = ''
Tags
Return values
string —the path
copyDirectoryContent()
copy the whole content of a directory existing in the install/ directory of the component, to the given directory.
public
copyDirectoryContent(string $relativeSourcePath, string $targetPath[, mixed $overwrite = false ]) : mixed
Parameters
- $relativeSourcePath : string
-
relative path to the install/ directory of the component
- $targetPath : string
-
the path where to copy the content. the path may content Jelix shortcuts, see FileHelpersTrait
- $overwrite : mixed = false
Tags
Return values
mixed —copyFile()
copy a file from the install/ directory to an other.
public
copyFile(string $relativeSourcePath, string $targetPath[, mixed $overwrite = false ]) : mixed
Parameters
- $relativeSourcePath : string
-
relative path to the install/ directory of the file to copy
- $targetPath : string
-
the path where to copy the file. the path may content Jelix shortcuts, see FileHelpersTrait
- $overwrite : mixed = false
Tags
Return values
mixed —createEntryPoint()
Create a new entry point.
public
createEntryPoint(string $entryPointModelFile, string $entryPointWebPath, string $configFileName[, string $epType = 'classic' ][, string $configFileModel = '' ]) : mixed
Parameters
- $entryPointModelFile : string
-
the entrypoint file to copy
- $entryPointWebPath : string
-
the path of the entrypoint to create into the www directory
- $configFileName : string
-
name of the configuration file. path relative to app/system or var/config
- $epType : string = 'classic'
-
type of the entry point (classic)
- $configFileModel : string = ''
-
a configuration file to copy as $configFileName. default is an empty content.
Tags
Return values
mixed —declareDbProfile()
declare a new db profile. if the content of the section is not given, it will declare an alias to the default profile.
public
declareDbProfile(string $name[, null|array<string|int, mixed>|string $sectionContent = null ][, bool $force = true ]) : bool
Parameters
- $name : string
-
the name of the new section/alias
- $sectionContent : null|array<string|int, mixed>|string = null
-
the content of the new section, or null to create an alias
- $force : bool = true
-
true:erase the existing profile
Tags
Return values
bool —true if the ini file has been changed
declareGlobalWebAssets()
declare web assets into the main configuration.
public
declareGlobalWebAssets(string $name, array<string|int, mixed> $values, string $collection, bool $force) : mixed
Parameters
- $name : string
-
the name of webassets
- $values : array<string|int, mixed>
-
should be an array with one or more of these keys 'css' (array), 'js' (array), 'require' (string)
- $collection : string
-
the name of the webassets collection
- $force : bool
Tags
Return values
mixed —findDbProfile()
public
findDbProfile( $name) : array<string|int, mixed>
Parameters
Tags
Return values
array<string|int, mixed> —the first item is the profile content as an array (which may be empty if the profile does not exist), the second item is the real profile name in case $name is an alias.
forLocalConfiguration()
public
forLocalConfiguration() : mixed
Tags
Return values
mixed —getConfigIni()
default config, main config combined with or without local config.
public
getConfigIni() : IniModifierArray
Tags
Return values
IniModifierArray —getCoordPluginConfig()
return the section name of configuration of a plugin for the coordinator or the IniModifier for the configuration file of the plugin if it exists.
public
getCoordPluginConfig(string $pluginName[, IniReaderInterface $config = null ]) : null|array<string|int, mixed>
Parameters
- $pluginName : string
- $config : IniReaderInterface = null
-
the configuration file from which we should extract the plugin configuration. default is the full configuration.
Tags
Return values
null|array<string|int, mixed> —null if plugin is unknown, else array($iniModifier, $section)
getEntryPointsById()
public
getEntryPointsById( $epId) : EntryPointPreConfigurator
Parameters
Tags
Return values
EntryPointPreConfigurator —getEntryPointsByType()
public
getEntryPointsByType([string $type = 'classic' ]) : array<string|int, EntryPointPreConfigurator>
Parameters
- $type : string = 'classic'
Tags
Return values
array<string|int, EntryPointPreConfigurator> —getEntryPointsList()
List of entry points of the application.
public
getEntryPointsList() : array<string|int, EntryPointPreConfigurator>
Tags
Return values
array<string|int, EntryPointPreConfigurator> —getMainEntryPoint()
Main entrypoint of the application (in most of case, index.php).
public
getMainEntryPoint() : EntryPointPreConfigurator
Tags
Return values
EntryPointPreConfigurator —getProfilesIni()
public
getProfilesIni() : mixed
Tags
Return values
mixed —getSingleConfigIni()
main config or local config ini file alone.
public
getSingleConfigIni() : IniModifierInterface|IniReaderInterface
Tags
Return values
IniModifierInterface|IniReaderInterface —removeDbProfile()
remove a db profile.
public
removeDbProfile(string $name) : mixed
Parameters
- $name : string
-
the name of the section/alias
Tags
Return values
mixed —removeDirectoryContent()
remove the whole content of a directory from the application.
public
removeDirectoryContent(string $targetPath) : mixed
Parameters
- $targetPath : string
-
the path of the directory to remove the path may content Jelix shortcuts, see FileHelpersTrait
Tags
Return values
mixed —removeEntryPoint()
Remove an entry point that was installed by a module
public
removeEntryPoint(string $entryPointWebPath, string $configFileName[, string $epType = 'classic' ]) : mixed
Parameters
- $entryPointWebPath : string
-
the path of the entrypoint to create into the www directory
- $configFileName : string
-
name of the configuration file. path relative to app/system or var/config
- $epType : string = 'classic'
-
type of the entry point (classic)
Tags
Return values
mixed —removeFile()
delete a file from the the application.
public
removeFile(string $targetPath) : mixed
Parameters
- $targetPath : string
-
the path of the file the path may content Jelix shortcuts, see FileHelpersTrait
Tags
Return values
mixed —removeGlobalWebAssets()
remove web assets from the main configuration.
public
removeGlobalWebAssets(string $name, string $collection) : mixed
Parameters
- $name : string
-
the name of webassets
- $collection : string
-
the name of the webassets collection
Tags
Return values
mixed —setupModuleWebFiles()
Install web files of a module.
public
setupModuleWebFiles(string $wwwFilesMode, string $wwwDirectoryName, string $sourcePath) : mixed
It supports different way to install : copying files, creating a symbolic link or do nothing (aka you should create an alias nto the vhost of the web server)
Parameters
- $wwwFilesMode : string
-
should be 'copy' or '' (files will be copied), 'symlink' (a sym link is created) or any other value (do nothing/remove copied files)
- $wwwDirectoryName : string
-
the path inside the www path
- $sourcePath : string
-
the path of the directory
Tags
Return values
mixed —updateEntryPointFile()
public
updateEntryPointFile(string $entryPointModelFile, mixed $entryPointWebPath[, mixed $epType = 'classic' ]) : mixed
Parameters
- $entryPointModelFile : string
-
path to the entrypoint file to copy, from the install directory
- $entryPointWebPath : mixed
- $epType : mixed = 'classic'
Tags
Return values
mixed —expandPath()
protected
expandPath(mixed $path) : mixed
Parameters
- $path : mixed
Tags
Return values
mixed —updateOrCreateEntryPointFile()
protected
updateOrCreateEntryPointFile(mixed $entryPointFile, mixed $epPath) : mixed
Parameters
- $entryPointFile : mixed
- $epPath : mixed