1. class
  2. Windwalker
  3. Utilities
  4. Queue
  5. PriorityQueue

PriorityQueue

class PriorityQueue extends SplPriorityQueue implements Serializable (View source)

The PriorityQueue class.

Constants

MIN

LOW

BELOW_NORMAL

NORMAL

ABOVE_NORMAL

HIGH

MAX

Methods

__construct(array|SplPriorityQueue $array = array(), int $priority = self::NORMAL)

Class init.

PriorityQueue
bind(array $array = array(), int $priority = self::NORMAL)

bind

PriorityQueue
insertArray(array $items)

register

void
insert(mixed $datum, mixed $priority)

Insert a value with a given priority

array
toArray()

Serialize to an array

string
serialize()

Serialize

void
unserialize(string $data)

Deserialize

static;
merge()

merge

int
compare(mixed $priority1, mixed $priority2)

compare

int
getSerial()

Method to get property Serial

PriorityQueue
setSerial(int $serial)

Method to set property serial

Details

at line line 37
__construct(array|SplPriorityQueue $array = array(), int $priority = self::NORMAL)

Class init.

Parameters

array|SplPriorityQueue $array
int $priority

at line line 57
PriorityQueue bind(array $array = array(), int $priority = self::NORMAL)

bind

Parameters

array $array
int $priority

Return Value

PriorityQueue

at line line 74
PriorityQueue insertArray(array $items)

register

Parameters

array $items

Return Value

PriorityQueue

at line line 95
void insert(mixed $datum, mixed $priority)

Insert a value with a given priority

Utilizes {@var $serial} to ensure that values of equal priority are emitted in the same order in which they are inserted.

Parameters

mixed $datum
mixed $priority

Return Value

void

at line line 116
array toArray()

Serialize to an array

Array will be priority => data pairs

Return Value

array

at line line 133
string serialize()

Serialize

Return Value

string

at line line 156
void unserialize(string $data)

Deserialize

Parameters

string $data

Return Value

void

at line line 169
static; merge()

merge

Return Value

static;

at line line 201
int compare(mixed $priority1, mixed $priority2)

compare

Parameters

mixed $priority1
mixed $priority2

Return Value

int

at line line 234
int getSerial()

Method to get property Serial

Return Value

int

at line line 246
PriorityQueue setSerial(int $serial)

Method to set property serial

Parameters

int $serial

Return Value

PriorityQueue Return self to support chaining.