\Phabstractic\Data\Types\ResourcePriorityInterface

The basic priority interface

This is used mainly for the Priority based lists

This allows many different objects to be priority objects, rather than messing with hard coded arrays, etc.

If you need data to be a priority you can easily use the Priority class.

CHANGELOG

1.0: Created PriorityInterface - May 26th, 2013 2.0: Refactored and re-formatted for inclusion in primus - April 11th, 2015 3.0: added setPriority method for dynamic priority management reformatted for inclusion in phabstractic - July 21st, 2016

Summary

Methods

Constants

getData()
getDataReference()
getPriority()
setPriority()

No constants found

No protected methods found

N/A

No private methods found

N/A

File: Data/Types/Resource/PriorityInterface.php
Package: \Data
See also: [English]

Methods

getData()

getData() : mixed

Retrieve the data associated with this priority

Returns

mixed —

$data The given data

getDataReference()

getDataReference() : mixed

Retrieve the data associated with this priority as a reference

Returns

mixed —

&$data The given data

getPriority()

getPriority() : integer

Get the priority of the object

Generally, 0 is most urgent.

Returns

integer —

The priority of the data

setPriority()

setPriority(  $priority) : boolean

Set the priority of the object

Generally, 0 is most urgent.

Parameters

$priority

Returns

boolean —

True if set