PHP 클래스 PPI\Framework\Module\AbstractModule

저자: Paul Dragoonis ([email protected])
상속: implements PPI\Framework\Module\ModuleInterface, implements Zend\ModuleManager\Feature\ConfigProviderInterface
파일 보기 프로젝트 열기: ppi/framework

보호된 프로퍼티들

프로퍼티 타입 설명
$config null
$configLoader null | PPI\Framework\Config\ConfigLoader Configuration loader.
$name The Module name.
$reflected ReflectionObject
$routes null
$services null

공개 메소드들

메소드 설명
getCommandsPath ( ) : string Returns the default location of where Command classes are registered.
getConfig ( ) : array | Traversable Returns configuration to merge with application configuration.
getName ( ) : string Returns the module name. Defaults to the module namespace stripped of backslashes.
getNamespace ( ) : string Gets the Module namespace.
getPath ( ) : string Gets the Module directory path.
getService ( string $serviceName ) : mixed Get a particular service.
getServices ( ) : array Get the services.
loadConfig ( string $resource, null | string $type = null ) : array Loads a configuration file (PHP, YAML) or PHP array.
mergeConfig ( mixed $resources ) : array Loads and merges the configuration.
registerCommands ( PPI\Framework\Console\Application $application ) Finds and registers Commands.
setName ( string $Name ) Set the module name.
setServices ( string $services ) : Module Set services for our module.

보호된 메소드들

메소드 설명
getConfigLoader ( ) : ConfigLoader Returns a ConfigLoader instance.
loadAuraRoutes ( string $path ) : Aura\Router\Router
loadFastRouteRoutes ( $path ) : PPI\FastRoute\Wrapper\FastRouteWrapper
loadLaravelRoutes ( string $path ) : Aura\Router\Router
loadSymfonyRoutes ( string $path ) : RouteCollection Load up our routes.
loadYamlConfig ( string $path ) : array Load up our config results from the specific yaml file.
loadYamlRoutes ( string $path ) : RouteCollection Load up our routes.

메소드 상세

getCommandsPath() 공개 메소드

Override this in your child module if it differs from this default convention.
public getCommandsPath ( ) : string
리턴 string

getConfig() 공개 메소드

Returns configuration to merge with application configuration.
public getConfig ( ) : array | Traversable
리턴 array | Traversable

getConfigLoader() 보호된 메소드

Returns a ConfigLoader instance.
protected getConfigLoader ( ) : ConfigLoader
리턴 PPI\Framework\Config\ConfigLoader

getName() 공개 메소드

Returns the module name. Defaults to the module namespace stripped of backslashes.
public getName ( ) : string
리턴 string The Module name

getNamespace() 공개 메소드

Gets the Module namespace.
public getNamespace ( ) : string
리턴 string The Module namespace

getPath() 공개 메소드

Gets the Module directory path.
public getPath ( ) : string
리턴 string The Module absolute path

getService() 공개 메소드

Get a particular service.
public getService ( string $serviceName ) : mixed
$serviceName string
리턴 mixed

getServices() 공개 메소드

Get the services.
public getServices ( ) : array
리턴 array

loadAuraRoutes() 보호된 메소드

protected loadAuraRoutes ( string $path ) : Aura\Router\Router
$path string
리턴 Aura\Router\Router

loadConfig() 공개 메소드

Loads a configuration file (PHP, YAML) or PHP array.
public loadConfig ( string $resource, null | string $type = null ) : array
$resource string The resource
$type null | string The resource type
리턴 array

loadFastRouteRoutes() 보호된 메소드

protected loadFastRouteRoutes ( $path ) : PPI\FastRoute\Wrapper\FastRouteWrapper
$path
리턴 PPI\FastRoute\Wrapper\FastRouteWrapper

loadLaravelRoutes() 보호된 메소드

protected loadLaravelRoutes ( string $path ) : Aura\Router\Router
$path string
리턴 Aura\Router\Router

loadSymfonyRoutes() 보호된 메소드

Load up our routes.
protected loadSymfonyRoutes ( string $path ) : RouteCollection
$path string
리턴 Symfony\Component\Routing\RouteCollection

loadYamlConfig() 보호된 메소드

Load up our config results from the specific yaml file.
사용 중단: since version 2.1, to be removed in 2.2. Use "loadConfig()" instead.
protected loadYamlConfig ( string $path ) : array
$path string
리턴 array

loadYamlRoutes() 보호된 메소드

Load up our routes.
사용 중단: Please use loadSymfonyRoutes instead
protected loadYamlRoutes ( string $path ) : RouteCollection
$path string
리턴 Symfony\Component\Routing\RouteCollection

mergeConfig() 공개 메소드

Loads and merges the configuration.
public mergeConfig ( mixed $resources ) : array
$resources mixed
리턴 array

registerCommands() 공개 메소드

Override this method if your module commands do not follow the conventions: * Commands are in the 'Command' sub-directory * Commands extend PPI\Framework\Console\Command\AbstractCommand
public registerCommands ( PPI\Framework\Console\Application $application )
$application PPI\Framework\Console\Application An Application instance

setName() 공개 메소드

Set the module name.
public setName ( string $Name )
$Name string

setServices() 공개 메소드

Set services for our module.
public setServices ( string $services ) : Module
$services string
리턴 Module

프로퍼티 상세

$config 보호되어 있는 프로퍼티

protected null $config
리턴 null

$configLoader 보호되어 있는 프로퍼티

Configuration loader.
protected null|ConfigLoader,PPI\Framework\Config $configLoader
리턴 null | PPI\Framework\Config\ConfigLoader

$name 보호되어 있는 프로퍼티

The Module name.
protected $name

$reflected 보호되어 있는 프로퍼티

protected ReflectionObject $reflected
리턴 ReflectionObject

$routes 보호되어 있는 프로퍼티

protected null $routes
리턴 null

$services 보호되어 있는 프로퍼티

protected null $services
리턴 null