PHP Class Platformsh\Cli\Local\LocalProject

Protected Properties

Method	Description
__construct ( CliConfig $config = null )
ensureGitRemote ( string $dir, string $url )	Ensure there are appropriate Git remotes in the repository.
ensureLocalDir ( string $projectRoot )
getLegacyProjectRoot ( ) : string \| false	Find the legacy root of the current project, from CLI versions <3.
getProjectConfig ( string $projectRoot = null ) : array \| null	Get the configuration for the current project.
getProjectRoot ( ) : string \| false	Find the root of the current project.
writeCurrentProjectConfig ( array $config, string $projectRoot = null, boolean $merge = false ) : array	Write configuration for a project.
writeGitExclude ( string $dir )	Write to the Git exclude file.

Method	Description
findTopDirectoryContaining ( string $file, callable $callback = null ) : string \| false	Find the highest level directory that contains a file.
getGitRemoteUrl ( string $dir ) : string \| false
parseGitUrl ( string $gitUrl ) : array \| false

public __construct ( CliConfig $config = null )
$config	Platformsh\Cli\CliConfig

Ensure there are appropriate Git remotes in the repository.

public ensureGitRemote ( string $dir, string $url )
$dir	string
$url	string

public ensureLocalDir ( string $projectRoot )
$projectRoot	string

Find the highest level directory that contains a file.

protected static findTopDirectoryContaining ( string $file, callable $callback = null ) : string \| false
$file	string	The filename to look for.
$callback	callable	A callback to validate the directory when found. Accepts one argument (the directory path). Return true to use the directory, or false to continue traversing upwards.
return	string \| false	The path to the directory, or false if the file is not found.

protected getGitRemoteUrl ( string $dir ) : string \| false
$dir	string
return	string \| false	The Git remote URL.

Find the legacy root of the current project, from CLI versions <3.

public getLegacyProjectRoot ( ) : string \| false
return	string \| false

Get the configuration for the current project.

public getProjectConfig ( string $projectRoot = null ) : array \| null
$projectRoot	string
return	array \| null	The current project's configuration.

Find the root of the current project.

public getProjectRoot ( ) : string \| false
return	string \| false

protected parseGitUrl ( string $gitUrl ) : array \| false
$gitUrl	string
return	array \| false	An array containing 'id' and 'host', or false on failure.

Configuration is stored as YAML, in the location configured by 'local.project_config'.

public writeCurrentProjectConfig ( array $config, string $projectRoot = null, boolean $merge = false ) : array
$config	array	The configuration.
$projectRoot	string	The project root.
$merge	boolean	Whether to merge with existing configuration.
return	array	The updated project configuration.

Write to the Git exclude file.

public writeGitExclude ( string $dir )
$dir	string

protected $config

protected $fs

protected static $projectConfigs