Documentation

Condition

This contract represents a Compound Condition rule.

Table of Contents

getChildOptions()  : array<string|int, mixed>
Returns a list of options supported beneth this condition.
getText()  : string
Returns a condition text summary when displaying to the user.
getTitle()  : string
Returns a condition title for displaying in the condition settings form

Methods

getChildOptions()

Returns a list of options supported beneth this condition.

public getChildOptions(array<string|int, mixed> $options) : array<string|int, mixed>

Options can contain these keys:

  • ruleType: Rule type as specified by ConditionBase::TYPE_* constants
  • parentIds: An array of parent ids to constrain child conditions
  • extraRules: An array of additional condition classes to use
Parameters
$options : array<string|int, mixed>
Return values
array<string|int, mixed>

getText()

Returns a condition text summary when displaying to the user.

public getText() : string
Return values
string

getTitle()

Returns a condition title for displaying in the condition settings form

public getTitle() : string
Return values
string

Search results