PHP 클래스 Horde_LoginTasks_Task, horde

저자: Michael Slusarz ([email protected])

공개 프로퍼티들

프로퍼티	타입	설명
$active	boolean	Should the task be run?
$display	integer	[1] Horde_LoginTasks::DISPLAY_CONFIRM_NO Horde_LoginTasks::DISPLAY_CONFIRM_YES Each output from describe() will have a checkbox associated with it. For each checkbox selected, execute() for that task will be run. More than 1 confirmation message can be displayed on the confirmation page at once. DISPLAY_CONFIRM_YES will be checked by default, DISPLAY_CONFIRM_NO will be unchecked by default. [2] Horde_LoginTasks::DISPLAY_AGREE The output from describe() should be text asking the user to agree/disagree to specified terms. If 'yes' is selected, the POST variable 'agree' will be set. If 'no' is selected, the POST variable 'not_agree' will be set. In either case, execute() will ALWAYS be run. This style will be displayed on its own confirmation page. [3] Horde_LoginTasks::DISPLAY_NOTICE The output from describe() should be any non-interactive text desired. There will be a single 'Click to Continue' button below this text. execute() will ALWAYS be run. This style will be displayed on its own confirmation page. [4] Horde_LoginTasks::DISPLAY_NONE Don't display any confirmation to the user.
$interval	integer	The interval at which to run the task.
$priority	integer	The priority of the task.

공개 메소드들

메소드	설명
describe ( ) : string	Return description information for the login task.
execute ( )	Do login task (if it has been confirmed).
joinDisplayWith ( Horde_LoginTasks_Task $previous ) : boolean	Indicates if the display of the current task should be joined with the given previous task.
needsDisplay ( ) : boolean	Does the task need to be displayed?

비공개 메소드들

메소드	설명
_isConfirmTask ( Horde_Login_Task $task ) : boolean	Is this a confirmation task?

메소드 상세

describe() 공개 메소드

Return description information for the login task.

public describe ( ) : string
리턴	string	Description that will be displayed on the login task confirmation page.

execute() 추상적인 공개 메소드

Do login task (if it has been confirmed).

abstract public execute ( )

joinDisplayWith() 공개 메소드

Indicates if the display of the current task should be joined with the given previous task.

public joinDisplayWith ( Horde_LoginTasks_Task $previous ) : boolean
$previous	Horde_LoginTasks_Task	The previous task to display.
리턴	boolean	True if both tasks should be displayed together.

needsDisplay() 공개 메소드

Does the task need to be displayed?

public needsDisplay ( ) : boolean
리턴	boolean	True if the task should be displayed.

프로퍼티 상세

$active 공개적으로 프로퍼티

Should the task be run?

public bool $active
리턴	boolean

$display 공개적으로 프로퍼티

[1] Horde_LoginTasks::DISPLAY_CONFIRM_NO Horde_LoginTasks::DISPLAY_CONFIRM_YES Each output from describe() will have a checkbox associated with it. For each checkbox selected, execute() for that task will be run. More than 1 confirmation message can be displayed on the confirmation page at once. DISPLAY_CONFIRM_YES will be checked by default, DISPLAY_CONFIRM_NO will be unchecked by default. [2] Horde_LoginTasks::DISPLAY_AGREE The output from describe() should be text asking the user to agree/disagree to specified terms. If 'yes' is selected, the POST variable 'agree' will be set. If 'no' is selected, the POST variable 'not_agree' will be set. In either case, execute() will ALWAYS be run. This style will be displayed on its own confirmation page. [3] Horde_LoginTasks::DISPLAY_NOTICE The output from describe() should be any non-interactive text desired. There will be a single 'Click to Continue' button below this text. execute() will ALWAYS be run. This style will be displayed on its own confirmation page. [4] Horde_LoginTasks::DISPLAY_NONE Don't display any confirmation to the user.

public int $display
리턴	integer

$interval 공개적으로 프로퍼티

The interval at which to run the task.

public int $interval
리턴	integer

$priority 공개적으로 프로퍼티

The priority of the task.

public int $priority
리턴	integer