DisplayCondition class - Documentation for SproutCMS

Info Page:

class DisplayCondition

Base class for display conditions

This is known as the Context Engine, and is a set of display rules which affect
which widgets (content blocks) are shown or hidden on the page

File: /sprout/Helpers/DisplayConditions/DisplayCondition.php
Namespace: Sprout\Helpers\DisplayConditions
This class is abstract

Source code (20 results)

/sprout/Controllers/AdminAjaxController.php Highlighted file source

Line 140: 'fields' => Register::getDisplayConditions(),
Line 168: $inst = Sprout::instance($_GET['field'], ['Sprout\\Helpers\\DisplayConditions\\DisplayCondition']);

/sprout/Controllers/PageController.php Highlighted file source

Line 371: * @return array Environment which gets passed to {@see Widgets::checkDisplayConditions}
Line 399: $result = Widgets::checkDisplayConditions($conds_env, $conditions);

/sprout/Helpers/DisplayConditions/Acquisition/Referrer.php Highlighted file source

Line 14: namespace Sprout\Helpers\DisplayConditions\Acquisition;
Line 16: use Sprout\Helpers\DisplayConditions\DisplayConditionString;
Line 23: class Referrer extends DisplayConditionString

/sprout/Helpers/DisplayConditions/Acquisition/UtmCampaign.php Highlighted file source

Line 14: namespace Sprout\Helpers\DisplayConditions\Acquisition;
Line 16: use Sprout\Helpers\DisplayConditions\DisplayConditionString;
Line 23: class UtmCampaign extends DisplayConditionString

/sprout/Helpers/DisplayConditions/Acquisition/UtmMedium.php Highlighted file source

Line 14: namespace Sprout\Helpers\DisplayConditions\Acquisition;
Line 16: use Sprout\Helpers\DisplayConditions\DisplayConditionString;
Line 23: class UtmMedium extends DisplayConditionString

/sprout/Helpers/DisplayConditions/Acquisition/UtmSource.php Highlighted file source

Line 14: namespace Sprout\Helpers\DisplayConditions\Acquisition;
Line 16: use Sprout\Helpers\DisplayConditions\DisplayConditionString;
Line 23: class UtmSource extends DisplayConditionString

/sprout/Helpers/DisplayConditions/DisplayCondition.php Highlighted file source

Line 14: namespace Sprout\Helpers\DisplayConditions;
Line 23: abstract class DisplayCondition
Line 59: * @param string $op string One of the keys from the array returned by {@see DisplayCondition::getOperators}
Line 60: * @param string $val string Entered value OR one of the keys from {@see DisplayCondition::getParamValues}

/sprout/Helpers/DisplayConditions/DisplayConditionEnum.php Highlighted file source

Line 14: namespace Sprout\Helpers\DisplayConditions;
Line 20: abstract class DisplayConditionEnum extends DisplayCondition
Line 53: * Calls {@see DisplayConditionEnum::getCurrentValue} to get the current value
Line 57: * @param string $op string One of the keys from the array returned by {@see DisplayCondition::getOperators}
Line 58: * @param string $val string Entered value OR one of the keys from {@see DisplayCondition::getParamValues}
Line 77: * This is compared against the params returned by {@see DisplayCondition::getParamValues}

/sprout/Helpers/DisplayConditions/DisplayConditionInteger.php Highlighted file source

Line 14: namespace Sprout\Helpers\DisplayConditions;
Line 20: abstract class DisplayConditionInteger extends DisplayCondition
Line 57: * Calls {@see DisplayConditionEnum::getCurrentValue} to get the current value
Line 61: * @param string $op string One of the keys from the array returned by {@see DisplayCondition::getOperators}
Line 62: * @param string $val string Entered value OR one of the keys from {@see DisplayCondition::getParamValues}
Line 90: * This is compared against the params returned by {@see DisplayCondition::getParamValues}

/sprout/Helpers/DisplayConditions/DisplayConditionString.php Highlighted file source

Line 14: namespace Sprout\Helpers\DisplayConditions;
Line 20: abstract class DisplayConditionString extends DisplayCondition
Line 57: * Calls {@see DisplayConditionEnum::getCurrentValue} to get the current value
Line 61: * @param string $op string One of the keys from the array returned by {@see DisplayCondition::getOperators}
Line 62: * @param string $val string Entered value OR one of the keys from {@see DisplayCondition::getParamValues}
Line 89: * This is compared against the params returned by {@see DisplayCondition::getParamValues}

/sprout/Helpers/DisplayConditions/Platform/BrowserName.php Highlighted file source

Line 14: namespace Sprout\Helpers\DisplayConditions\Platform;
Line 16: use Sprout\Helpers\DisplayConditions\DisplayConditionEnum;
Line 23: class BrowserName extends DisplayConditionEnum
Line 47: * This is compared against the params returned by {@see DisplayCondition::getParamValues}

/sprout/Helpers/DisplayConditions/Platform/BrowserVersion.php Highlighted file source

Line 14: namespace Sprout\Helpers\DisplayConditions\Platform;
Line 16: use Sprout\Helpers\DisplayConditions\DisplayConditionInteger;
Line 25: class BrowserVersion extends DisplayConditionInteger
Line 30: * This is compared against the params returned by {@see DisplayCondition::getParamValues}

/sprout/Helpers/DisplayConditions/Platform/DeviceCategory.php Highlighted file source

Line 14: namespace Sprout\Helpers\DisplayConditions\Platform;
Line 16: use Sprout\Helpers\DisplayConditions\DisplayConditionEnum;
Line 23: class DeviceCategory extends DisplayConditionEnum
Line 43: * This is compared against the params returned by {@see DisplayCondition::getParamValues}

/sprout/Helpers/DisplayConditions/Session/ThisPageviews.php Highlighted file source

Line 14: namespace Sprout\Helpers\DisplayConditions\Session;
Line 16: use Sprout\Helpers\DisplayConditions\DisplayConditionInteger;
Line 24: class ThisPageviews extends DisplayConditionInteger

/sprout/Helpers/DisplayConditions/Session/TimeOnSite.php Highlighted file source

Line 14: namespace Sprout\Helpers\DisplayConditions\Session;
Line 16: use Sprout\Helpers\DisplayConditions\DisplayConditionInteger;
Line 23: class TimeOnSite extends DisplayConditionInteger

/sprout/Helpers/DisplayConditions/Session/TotalPageviews.php Highlighted file source

Line 14: namespace Sprout\Helpers\DisplayConditions\Session;
Line 16: use Sprout\Helpers\DisplayConditions\DisplayConditionInteger;
Line 23: class TotalPageviews extends DisplayConditionInteger

/sprout/Helpers/DisplayConditions/Session/UniquePageviews.php Highlighted file source

Line 14: namespace Sprout\Helpers\DisplayConditions\Session;
Line 16: use Sprout\Helpers\DisplayConditions\DisplayConditionInteger;
Line 23: class UniquePageviews extends DisplayConditionInteger

/sprout/Helpers/Register.php Highlighted file source

Line 597: * Condition classes must extend the base class {@see Sprout\Helpers\DisplayConditions\DisplayCondition}
Line 603: public static function displayCondition($class, $group, $label)
Line 618: public static function getDisplayConditions()

/sprout/Helpers/Widgets.php Highlighted file source

Line 249: public static function checkDisplayConditions(array $env, array $conditions)
Line 253: $inst = Sprout::instance($cond['field'], ['Sprout\\Helpers\\DisplayConditions\\DisplayCondition']);

/sprout/sprout_load.php Highlighted file source

Line 63: Register::displayCondition('Sprout\\Helpers\\DisplayConditions\\Platform\\DeviceCategory', 'Platform', 'Device category');
Line 64: Register::displayCondition('Sprout\\Helpers\\DisplayConditions\\Platform\\BrowserName', 'Platform', 'Browser name');
Line 65: Register::displayCondition('Sprout\\Helpers\\DisplayConditions\\Platform\\BrowserVersion', 'Platform', 'Browser version');
Line 66: Register::displayCondition('Sprout\\Helpers\\DisplayConditions\\Session\\TimeOnSite', 'Session', 'Minutes on site');
Line 67: Register::displayCondition('Sprout\\Helpers\\DisplayConditions\\Session\\ThisPageviews', 'Session', 'Pageviews');
Line 68: Register::displayCondition('Sprout\\Helpers\\DisplayConditions\\Session\\TotalPageviews', 'Session', 'Pageviews (total)');
Line 69: Register::displayCondition('Sprout\\Helpers\\DisplayConditions\\Session\\UniquePageviews', 'Session', 'Pageviews (unique)');
Line 70: Register::displayCondition('Sprout\\Helpers\\DisplayConditions\\Acquisition\\UtmSource', 'Acquisition', 'Source');
Line 71: Register::displayCondition('Sprout\\Helpers\\DisplayConditions\\Acquisition\\UtmMedium', 'Acquisition', 'Medium');
Line 72: Register::displayCondition('Sprout\\Helpers\\DisplayConditions\\Acquisition\\UtmCampaign', 'Acquisition', 'Campaign');
Line 73: Register::displayCondition('Sprout\\Helpers\\DisplayConditions\\Acquisition\\Referrer', 'Acquisition', 'Full referrer');

A total of 78 lines in 20 files were found

SproutCMS

Search documentation

class DisplayCondition

Source code (20 results)