DisplayCondition class - Documentation for SproutCMS

Info Page:

Page options:

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

Functions

Name	Visibility	Description
getOperators	public	Return the list of operators for the condition value
getParamType	public	Return the type of parameter for UI display
getParamValues	public	Return the available values for dropdowns
match	public	Does a given condition match?

public getOperators

array $DisplayCondition->getOperators ( );

Return the list of operators for the condition value
Common values would be 'equals', 'not equals', 'less than', 'contains', etc

public getParamType

string $DisplayCondition->getParamType ( );

Return the type of parameter for UI display
Only two types are supported - 'text' or 'dropdown'

public getParamValues

array $DisplayCondition->getParamValues ( );

Return the available values for dropdowns

public match

bool $DisplayCondition->match ( array $env , string $op , string $val );

Does a given condition match?