Method | Description | |
---|---|---|
clearModules ( ) | Removes all modules. | |
findModules ( Webmozart\Expression\Expression $expr ) : |
Returns all modules matching the given expression. | |
getContext ( ) : Puli\Manager\Api\Context\ProjectContext | Returns the manager's context. | |
getModule ( string $name ) : Puli\Manager\Api\Module\Module | Returns a module by name. | |
getModules ( ) : |
Returns all installed modules. | |
getRootModule ( ) : Puli\Manager\Api\Module\RootModule | Returns the root module. | |
hasModule ( string $name ) : boolean | Returns whether the manager has the module with the given name. | |
hasModules ( Webmozart\Expression\Expression $expr = null ) : boolean | Returns whether the manager has any modules. | |
installModule ( string $installPath, string | null $name = null, string $installerName = InstallInfo::DEFAULT_INSTALLER_NAME, string $env = Environment::PROD ) | Installs the module at the given path in the repository. | |
removeModule ( string $name ) | Removes the module with the given name. | |
removeModules ( Webmozart\Expression\Expression $expr ) | Removes all modules matching the given expression. | |
renameModule ( string $name, string $newName ) | Renames the module with the given name. |
public clearModules ( ) |
public findModules ( Webmozart\Expression\Expression $expr ) : |
||
$expr | Webmozart\Expression\Expression | The search criteria. |
return | The modules matching the expression. |
public getContext ( ) : Puli\Manager\Api\Context\ProjectContext | ||
return | Puli\Manager\Api\Context\ProjectContext | The project context. |
public getModules ( ) : |
||
return | The installed modules. |
public getRootModule ( ) : Puli\Manager\Api\Module\RootModule | ||
return | Puli\Manager\Api\Module\RootModule | The root module. |
public hasModules ( Webmozart\Expression\Expression $expr = null ) : boolean | ||
$expr | Webmozart\Expression\Expression | The search criteria. |
return | boolean | Returns `true` if the manager has modules and `false` otherwise. If an expression was passed, this method only returns `true` if the manager has modules matching the expression. |
public installModule ( string $installPath, string | null $name = null, string $installerName = InstallInfo::DEFAULT_INSTALLER_NAME, string $env = Environment::PROD ) | ||
$installPath | string | The path to the module. |
$name | string | null | The module name or `null` if the name should be read from the module's puli.json. |
$installerName | string | The name of the installer. |
$env | string | The environment to install the module in. |
public removeModule ( string $name ) | ||
$name | string | The module name. |
public removeModules ( Webmozart\Expression\Expression $expr ) | ||
$expr | Webmozart\Expression\Expression | The search criteria. |
public renameModule ( string $name, string $newName ) | ||
$name | string | The module name. |
$newName | string | The new module name. |