SproutCMS

This is the code documentation for the SproutCMS project

Page options:

Inherited members

class BrowserName

Display condtion for browser - firefox, chrome, safari, etc

Functions

NameVisibilityDescription
getCurrentValueprotectedReturn the current value of the variable
getOperatorspublicReturn the list of operators for the condition value
getParamTypepublicReturn the type of parameter for UI display
getParamValuespublicReturn the available values for dropdowns
matchpublicDoes a given condition match?

protected getCurrentValue

string $BrowserName->getCurrentValue ( array $env );

Return the current value of the variable
This is compared against the params returned by DisplayCondition::getParamValues

public getOperators (from DisplayConditionEnum)

array $DisplayConditionEnum->getOperators ( );

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

public getParamType (from DisplayConditionEnum)

string $DisplayConditionEnum->getParamType ( );

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

public getParamValues

array $BrowserName->getParamValues ( );

Return the available values for dropdowns

public match (from DisplayConditionEnum)

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

Does a given condition match?

Calls DisplayConditionEnum::getCurrentValue to get the current value
And then does the comparison against $val based on $op