SMW\Schema\CompartmentIterator Class Reference

Inheritance diagram for SMW\Schema\CompartmentIterator:

Collaboration diagram for SMW\Schema\CompartmentIterator:

Public Member Functions
	__construct (array $compartments=[], ?string $type=null)
	has (string $key)
	current ()
	find (string $key, ?string $flag=null)

Public Attributes
const	MATCH_KEY = 'match/key'
const	RULE_COMPARTMENT = 'type/rule'

Detailed Description

GNU GPL v2+

Since

3.1

Author

mwjames

Constructor & Destructor Documentation

__construct()

SMW\Schema\CompartmentIterator::__construct	(	array	$compartments = [],
		?string	$type = null
	)

Since

3.1

Parameters

array	$compartments
string | null	$type

Member Function Documentation

current()

SMW\Schema\CompartmentIterator::current

(

)

See also

Iterator::current

Since

3.1

find()

SMW\Schema\CompartmentIterator::find	(	string	$key,
		?string	$flag = null
	)

Since

3.2

Parameters

string	$key
string | null	$flag

Returns

CompartmentIterator

has()

SMW\Schema\CompartmentIterator::has

(

string

$key

)

Since

3.2

Parameters

string

$key

Returns

bool

Member Data Documentation

MATCH_KEY

const SMW\Schema\CompartmentIterator::MATCH_KEY = 'match/key'

Directly match a specific key without iterating for additional compartments.

RULE_COMPARTMENT

const SMW\Schema\CompartmentIterator::RULE_COMPARTMENT = 'type/rule'

Defines a rule compartment type

---

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

• CompartmentIterator.php