PHP Class N98\Magento\Application\ConfigLocator

Has all the information encoded to retrieve the various config files

Datei anzeigen Open project: netz98/n98-magerun Class Usage Examples

Public Methods

Method	Description
__construct ( string $configFilename, string $magentoRootFolder )	ConfigLocator constructor.
getProjectConfigFile ( ) : ConfigFile \| null	Obtain the project-config-file, it is placed in the magento app/etc dir, e.g. app/etc/n98-magerun2.yaml
getStopFileConfigFile ( string $magerunStopFileFolder ) : ConfigFile \| null	Obtain the (optional) stop-file-config-file, it is placed in the folder of the stop-file, always prefixed with a dot: stop-file-folder/.n98-magerun2.yaml
getUserConfigFile ( ) : ConfigFile \| null	Obtain the user-config-file, it is placed in the homedir, e.g. ~/.n98-magerun2.yaml

Private Methods

Method	Description
getUserConfigFilePaths ( ) : array

Method Details

__construct() public method

ConfigLocator constructor.

public __construct ( string $configFilename, string $magentoRootFolder )
$configFilename	string
$magentoRootFolder	string

getProjectConfigFile() public method

Obtain the project-config-file, it is placed in the magento app/etc dir, e.g. app/etc/n98-magerun2.yaml

public getProjectConfigFile ( ) : ConfigFile \| null
return	ConfigFile \| null

getStopFileConfigFile() public method

Obtain the (optional) stop-file-config-file, it is placed in the folder of the stop-file, always prefixed with a dot: stop-file-folder/.n98-magerun2.yaml

public getStopFileConfigFile ( string $magerunStopFileFolder ) : ConfigFile \| null
$magerunStopFileFolder	string
return	ConfigFile \| null

getUserConfigFile() public method

Obtain the user-config-file, it is placed in the homedir, e.g. ~/.n98-magerun2.yaml

public getUserConfigFile ( ) : ConfigFile \| null
return	ConfigFile \| null