CirrusSearch\Maintenance\Set Class Reference

Simple set implementation so it's clear what the array is being used for when values are only stored as keys. More...

Inheritance diagram for CirrusSearch\Maintenance\Set:

Collaboration diagram for CirrusSearch\Maintenance\Set:

Public Member Functions
	__construct (array $elements=[])
	count ()
	add ( $element)
	addAll (array $elements)
	union (Set $other)
	contains ( $element)
	values ()

Detailed Description

Simple set implementation so it's clear what the array is being used for when values are only stored as keys.

Member Function Documentation

add()

CirrusSearch\Maintenance\Set::add

(

$element

)

Parameters

string

$element

Element to add to set

Returns

self

addAll()

CirrusSearch\Maintenance\Set::addAll

(

array

$elements

)

Parameters

string[]

$elements

Elements to add to set

Returns

self

contains()

CirrusSearch\Maintenance\Set::contains

(

$element

)

Parameters

string

$element

Value to test

Returns

bool True when the set contains $element

count()

CirrusSearch\Maintenance\Set::count

(

)

Returns

int Number of elements in the set

union()

CirrusSearch\Maintenance\Set::union

(

Set

$other

)

Parameters

Set

$other

Set to union into this one

Returns

self

values()

CirrusSearch\Maintenance\Set::values

(

)

Returns

string[] Elements of the set

---

The documentation for this class was generated from the following file:

• includes/Maintenance/Set.php