UtmCampaign class - Documentation for SproutCMS

Info Page:

Page options:

class UtmCampaign

Display condtion for the 'utm_campaign' field

File: /sprout/Helpers/DisplayConditions/Acquisition/UtmCampaign.php
Namespace: Sprout\Helpers\DisplayConditions\Acquisition
Extends: DisplayConditionString

Functions

Name	Visibility	Description
getCurrentValue	protected	Return the current value of the variable
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?

protected getCurrentValue

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

Return the current value of the variable

public getOperators (from DisplayConditionString)

array $DisplayConditionString->getOperators ( );

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

public getParamType (from DisplayConditionString)

string $DisplayConditionString->getParamType ( );

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

public getParamValues (from DisplayCondition)

array $DisplayCondition->getParamValues ( );

Return the available values for dropdowns

public match (from DisplayConditionString)

bool $DisplayConditionString->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

SproutCMS