Horde_LoginTasks_Task_TosAgreement
extends Horde_LoginTasks_Task
in package
Login tasks module that presents a TOS Agreement page to user.
If user does not accept terms, user is not allowed to login.
Copyright 2002-2017 Horde LLC (http://www.horde.org/)
See the enclosed file LICENSE for license information (GPL). If you did not receive this file, see http://www.horde.org/licenses/gpl.
Tags
Table of Contents
- $display : int
- The style of the page output.
- $interval : int
- The interval at which to run the task.
- $priority : int
- The priority of the task.
- __construct() : mixed
- Constructor.
- describe() : string
- Returns the TOS agreement for display on the login tasks page.
- execute() : mixed
- Determine if user agreed with the terms or not. If the user does not agree, log him/her out immediately.
Properties
$display
The style of the page output.
public
int
$display
= \Horde_LoginTasks::DISPLAY_AGREE
$interval
The interval at which to run the task.
public
int
$interval
= \Horde_LoginTasks::FIRST_LOGIN
$priority
The priority of the task.
public
int
$priority
= \Horde_LoginTasks::PRIORITY_HIGH
Methods
__construct()
Constructor.
public
__construct() : mixed
Return values
mixed —describe()
Returns the TOS agreement for display on the login tasks page.
public
describe() : string
Return values
string —The terms of service agreement.
execute()
Determine if user agreed with the terms or not. If the user does not agree, log him/her out immediately.
public
execute() : mixed