PHP 클래스 Components_Module_Distribute, horde

Copyright 2010-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
상속: extends Components_Module_Base
파일 보기 프로젝트 열기: horde/horde

공개 메소드들

메소드 설명
getActions ( ) : array Return the action arguments supported by this module.
getContextOptionHelp ( ) : array Return the options that should be explained in the context help.
getHelp ( string $action ) : string Return the help text for the specified action.
getOptionGroupDescription ( ) : string Return the description for the option group representing this module.
getOptionGroupOptions ( ) : array Return the options for this module.
getOptionGroupTitle ( ) : string Return the title for the option group representing this module.
getUsage ( ) : string Get the usage description for this module.
handle ( Components_Config $config ) : boolean Determine if this module should act. Run all required actions if it has been instructed to do so.

메소드 상세

getActions() 공개 메소드

Return the action arguments supported by this module.
public getActions ( ) : array
리턴 array A list of supported action arguments.

getContextOptionHelp() 공개 메소드

Return the options that should be explained in the context help.
public getContextOptionHelp ( ) : array
리턴 array A list of option help texts.

getHelp() 공개 메소드

Return the help text for the specified action.
public getHelp ( string $action ) : string
$action string The action.
리턴 string The help text.

getOptionGroupDescription() 공개 메소드

Return the description for the option group representing this module.
public getOptionGroupDescription ( ) : string
리턴 string The group description.

getOptionGroupOptions() 공개 메소드

Return the options for this module.
public getOptionGroupOptions ( ) : array
리턴 array The group options.

getOptionGroupTitle() 공개 메소드

Return the title for the option group representing this module.
public getOptionGroupTitle ( ) : string
리턴 string The group title.

getUsage() 공개 메소드

Get the usage description for this module.
public getUsage ( ) : string
리턴 string The description.

handle() 공개 메소드

Determine if this module should act. Run all required actions if it has been instructed to do so.
public handle ( Components_Config $config ) : boolean
$config Components_Config The configuration.
리턴 boolean True if the module performed some action.