메소드 | 설명 | |
---|---|---|
__construct ( string | null $moduleName = null, string | null $path = null ) | Creates a new module file. | |
addBindingDescriptor ( Puli\Manager\Api\Discovery\BindingDescriptor $descriptor ) | Adds a binding descriptor. | |
addDependency ( string $moduleName ) | Adds a dependency to a module. | |
addExtraKeys ( array $values ) | Sets multiple extra keys at once. | |
addPathMapping ( |
Adds a path mapping. | |
addTypeDescriptor ( Puli\Manager\Api\Discovery\BindingTypeDescriptor $descriptor ) | Adds a type descriptor. | |
clearBindingDescriptors ( ) | Removes all binding descriptors. | |
clearDependencies ( ) | Removes all dependencies. | |
clearExtraKeys ( ) | Removes all extra keys. | |
clearPathMappings ( ) | Removes all path mappings. | |
clearTypeDescriptors ( ) | Removes all type descriptors. | |
getBindingDescriptor ( Rhumsaa\Uuid\Uuid $uuid ) : Puli\Manager\Api\Discovery\BindingDescriptor | Returns the binding descriptor with the given UUID. | |
getBindingDescriptors ( ) : Puli\Manager\Api\Discovery\BindingDescriptor[] | Returns the binding descriptors. | |
getDependencies ( ) : string[] | Returns the names of the modules this module overrides. | |
getExtraKey ( string $key, mixed $default = null ) : mixed | Returns the value of an extra key. | |
getExtraKeys ( ) : array | Returns all stored extra keys. | |
getModuleName ( ) : string | null | Returns the module name. | |
getPath ( ) : string | null | Returns the path to the module file. | |
getPathMapping ( string $repositoryPath ) : |
Returns the path mapping for a repository path. | |
getPathMappings ( ) : |
Returns the path mappings. | |
getTypeDescriptor ( string $typeName ) : Puli\Manager\Api\Discovery\BindingTypeDescriptor | Returns the type descriptor with the given name. | |
getTypeDescriptors ( ) : Puli\Manager\Api\Discovery\BindingTypeDescriptor[] | Returns the type descriptors. | |
getVersion ( ) : string | Returns the version of the module file. | |
hasBindingDescriptor ( Rhumsaa\Uuid\Uuid $uuid ) : boolean | Returns whether the binding descriptor exists in this file. | |
hasBindingDescriptors ( ) : boolean | Returns whether the file contains any binding descriptors. | |
hasDependencies ( ) : boolean | Returns whether the module has dependencies on other modules. | |
hasDependency ( string $moduleName ) : boolean | Returns whether the module depends on a given module. | |
hasExtraKey ( string $key ) : boolean | Returns whether the given extra key exists. | |
hasExtraKeys ( ) : boolean | Returns whether the file contains any extra keys. | |
hasPathMapping ( string $repositoryPath ) : boolean | Returns whether the file contains a path mapping for a repository path. | |
hasPathMappings ( ) : boolean | Returns whether the file contains any path mappings. | |
hasTypeDescriptor ( string $typeName ) : boolean | Returns whether a type is defined in this file. | |
hasTypeDescriptors ( ) : boolean | Returns whether the file contains any type descriptors. | |
removeBindingDescriptor ( Rhumsaa\Uuid\Uuid $uuid ) | Removes a binding descriptor. | |
removeDependency ( string $moduleName ) | Adds a dependency to a module. | |
removeExtraKey ( string $key ) | Removes an extra key. | |
removePathMapping ( string $repositoryPath ) | Removes the path mapping for a repository path. | |
removeTypeDescriptor ( string $typeName ) | Removes a type descriptor. | |
setDependencies ( array $moduleNames ) | Sets the names of the modules this module depends on. | |
setExtraKey ( string $key, mixed $value ) | Sets an extra key in the module file. | |
setExtraKeys ( array $values ) | Sets multiple extra keys at once. | |
setModuleName ( string | null $moduleName ) | Sets the module name. | |
setVersion ( string $version ) | Sets the version of the module file. |
public addBindingDescriptor ( Puli\Manager\Api\Discovery\BindingDescriptor $descriptor ) | ||
$descriptor | Puli\Manager\Api\Discovery\BindingDescriptor | The binding descriptor to add. |
public addDependency ( string $moduleName ) | ||
$moduleName | string | The name of the module. |
public addExtraKeys ( array $values ) | ||
$values | array | The values indexed by their key names. |
public addPathMapping ( |
||
$mapping | The path mapping. |
public addTypeDescriptor ( Puli\Manager\Api\Discovery\BindingTypeDescriptor $descriptor ) | ||
$descriptor | Puli\Manager\Api\Discovery\BindingTypeDescriptor | The type descriptor. |
public clearBindingDescriptors ( ) |
public getBindingDescriptor ( Rhumsaa\Uuid\Uuid $uuid ) : Puli\Manager\Api\Discovery\BindingDescriptor | ||
$uuid | Rhumsaa\Uuid\Uuid | The UUID of the binding descriptor. |
리턴 | Puli\Manager\Api\Discovery\BindingDescriptor | The binding descriptor. |
public getBindingDescriptors ( ) : Puli\Manager\Api\Discovery\BindingDescriptor[] | ||
리턴 | Puli\Manager\Api\Discovery\BindingDescriptor[] | The binding descriptors. |
public getDependencies ( ) : string[] | ||
리턴 | string[] | The names of the overridden modules. |
public getExtraKeys ( ) : array | ||
리턴 | array | The stored values indexed by their key names. |
public getModuleName ( ) : string | null | ||
리턴 | string | null | The module name or `null` if none is set. |
public getPathMapping ( string $repositoryPath ) : |
||
$repositoryPath | string | The repository path. |
리턴 | The corresponding path mapping. |
public getPathMappings ( ) : |
||
리턴 | The path mappings. |
public getTypeDescriptor ( string $typeName ) : Puli\Manager\Api\Discovery\BindingTypeDescriptor | ||
$typeName | string | The type name. |
리턴 | Puli\Manager\Api\Discovery\BindingTypeDescriptor | The type descriptor. |
public getTypeDescriptors ( ) : Puli\Manager\Api\Discovery\BindingTypeDescriptor[] | ||
리턴 | Puli\Manager\Api\Discovery\BindingTypeDescriptor[] | The type descriptors. |
public getVersion ( ) : string | ||
리턴 | string | The module file version. |
public hasBindingDescriptor ( Rhumsaa\Uuid\Uuid $uuid ) : boolean | ||
$uuid | Rhumsaa\Uuid\Uuid | The UUID of the binding descriptor. |
리턴 | boolean | Whether the file contains the binding descriptor. |
public hasBindingDescriptors ( ) : boolean | ||
리턴 | boolean | Returns `true` if the file contains binding descriptors and `false` otherwise. |
public hasDependencies ( ) : boolean | ||
리턴 | boolean | Returns `true` if the module depends on other modules and `false` otherwise. |
public hasDependency ( string $moduleName ) : boolean | ||
$moduleName | string | The name of the module. |
리턴 | boolean | Returns `true` if the module depends on the given module. |
public hasExtraKey ( string $key ) : boolean | ||
$key | string | The name of the key. |
리턴 | boolean | Returns `true` if the given extra key exists and `false` otherwise. |
public hasExtraKeys ( ) : boolean | ||
리턴 | boolean | Returns `true` if the file contains extra keys and `false` otherwise. |
public hasPathMapping ( string $repositoryPath ) : boolean | ||
$repositoryPath | string | The repository path. |
리턴 | boolean | Returns `true` if the file contains a mapping for the path. |
public hasPathMappings ( ) : boolean | ||
리턴 | boolean | Returns `true` if the file contains path mappings and `false` otherwise. |
public hasTypeDescriptor ( string $typeName ) : boolean | ||
$typeName | string | The type name. |
리턴 | boolean | Whether the type is defined in the file. |
public hasTypeDescriptors ( ) : boolean | ||
리턴 | boolean | Returns `true` if the file contains type descriptors and `false` otherwise. |
public removeBindingDescriptor ( Rhumsaa\Uuid\Uuid $uuid ) | ||
$uuid | Rhumsaa\Uuid\Uuid | The UUID of the binding descriptor to remove. |
public removeDependency ( string $moduleName ) | ||
$moduleName | string | The name of the module. |
public removeExtraKey ( string $key ) | ||
$key | string | The name of the key. |
public removePathMapping ( string $repositoryPath ) | ||
$repositoryPath | string | The repository path. |
public removeTypeDescriptor ( string $typeName ) | ||
$typeName | string | The type name. |
public setDependencies ( array $moduleNames ) | ||
$moduleNames | array | The names of the modules. |
public setExtraKey ( string $key, mixed $value ) | ||
$key | string | The name of the key. |
$value | mixed | The value to store. |
public setExtraKeys ( array $values ) | ||
$values | array | The values indexed by their key names. |
public setModuleName ( string | null $moduleName ) | ||
$moduleName | string | null | The module name or `null` to unset. |
public setVersion ( string $version ) | ||
$version | string | The module file version. |