CirrusSearch\UserTestingStatus Class Reference

Reports UserTesting bucketing decision. More...

Public Member Functions
	isActive ()
	getTestName ()
	getBucket ()
	getTrigger ()

Static Public Member Functions
static	hasInstance ()
static	getInstance ()
	Reports bucketing decision for the main request context.
static	active (string $testName, string $bucket)
static	inactive ()

Detailed Description

Reports UserTesting bucketing decision.

See UserTestingEngine for initialization.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. http://www.gnu.org/copyleft/gpl.html

Member Function Documentation

active()

static CirrusSearch\UserTestingStatus::active ( string $testName, string $bucket )

static

Parameters

string	$testName
string	$bucket

Returns

UserTestingStatus status representing a test bucket active for this request

getBucket()

CirrusSearch\UserTestingStatus::getBucket

(

)

Returns

string

Exceptions

NoActiveTestException

getInstance()

static CirrusSearch\UserTestingStatus::getInstance ( )

static

Reports bucketing decision for the main request context.

If not created yet, uses configuration and query string from request context to make a bucketing decision and activate that decision. This must be called as early in the request as is sensible to ensure the test configuration is applied.

Returns

UserTestingStatus

getTestName()

CirrusSearch\UserTestingStatus::getTestName

(

)

Returns

string

Exceptions

NoActiveTestException

getTrigger()

CirrusSearch\UserTestingStatus::getTrigger

(

)

Returns

string When active returns a string that will enable the same test configuration when provided to UserTestingEngine.

hasInstance()

static CirrusSearch\UserTestingStatus::hasInstance ( )

static

Returns

bool True when a bucketing decision has been made for the main request context

inactive()

static CirrusSearch\UserTestingStatus::inactive ( )

static

Returns

UserTestingStatus status representing user testing as inactive

isActive()

CirrusSearch\UserTestingStatus::isActive

(

)

Returns

bool True when a test is currently active

---

The documentation for this class was generated from the following file:

• includes/UserTestingStatus.php