ScripturNum ScripturNumArray

ScripturNum\ScripturNumArray

A class that contains a number of ScripturNum objects, but which can do useful things like print a human-readable string.

• Class name: ScripturNumArray
• Namespace: \ScripturNum
• This class implements: ArrayAccess, Iterator, Countable

Properties

container

protected  container = []

• Visibility: protected

sortEnqueued

protected mixed sortEnqueued = false

• Visibility: protected

hasMultipleBooks

protected mixed hasMultipleBooks = false

• Visibility: protected

hasMultiplePassagesFromABook

protected mixed hasMultiplePassagesFromABook = false

• Visibility: protected

hasMultiplePassagesFromAChapter

protected mixed hasMultiplePassagesFromAChapter = false

• Visibility: protected

Methods

__construct

mixed ScripturNum\ScripturNumArray::__construct(array initialValues)

Constructor

• Visibility: public

Arguments

• initialValues array - An array of initial values to add to the container. These can be ScripturNum objects or strings/integers that can be parsed into ScripturNum objects.

Returns

• mixed

sortCompare

int ScripturNum\ScripturNumArray::sortCompare(\ScripturNum\ScripturNum a, \ScripturNum\ScripturNum b)

• Visibility: protected
• This method is static.

Arguments

• a ScripturNum\ScripturNum* b ScripturNum\ScripturNum

Returns

• int -

sort

void ScripturNum\ScripturNumArray::sort()

Sorts the container.

• Visibility: protected

combineAdjacents

void ScripturNum\ScripturNumArray::combineAdjacents()

• Visibility: protected

sortAndCombineIfNeeded

mixed ScripturNum\ScripturNumArray::sortAndCombineIfNeeded()

• Visibility: protected

Returns

• mixed

offsetExists

bool ScripturNum\ScripturNumArray::offsetExists(mixed offset)

Whether an offset exists

• Visibility: public

Arguments

• offset mixed - An offset to check for.

Returns

• bool - true on success or false on failure.

The return value will be cast to boolean if non-boolean was returned.

offsetGet

\ScripturNum\ScripturNum ScripturNum\ScripturNumArray::offsetGet(mixed offset)

Offset to retrieve

• Visibility: public

Arguments

• offset mixed - The offset to retrieve.

Returns

• \ScripturNum\ScripturNum - Value Can return all value types.

offsetSet

void ScripturNum\ScripturNumArray::offsetSet(mixed offset, \ScripturNum\ScripturNum value)

Offset to set

• Visibility: public

Arguments

• offset mixed - The offset to assign the value to.
• value ScripturNum\ScripturNum - The value to set.

offsetUnset

void ScripturNum\ScripturNumArray::offsetUnset(mixed offset)

Offset to unset

• Visibility: public

Arguments

• offset mixed - The offset to unset.

current

\ScripturNum\ScripturNum ScripturNum\ScripturNumArray::current()

Return the current element

• Visibility: public

Returns

• \ScripturNum\ScripturNum - Can return any type.

next

void ScripturNum\ScripturNumArray::next()

Move forward to next element

• Visibility: public

key

int|string|null ScripturNum\ScripturNumArray::key()

Return the key of the current element

• Visibility: public

Returns

• int|string|null - TKey on success, or null on failure.

valid

bool ScripturNum\ScripturNumArray::valid()

Checks if current position is valid

• Visibility: public

Returns

• bool - The return value will be cast to boolean and then evaluated. Returns true on success or false on failure.

rewind

void ScripturNum\ScripturNumArray::rewind()

Rewind the Iterator to the first element

• Visibility: public

count

int<0, max> ScripturNum\ScripturNumArray::count()

Count elements of an object

• Visibility: public

Returns

• int<0, max> - The custom count as an integer.

remove

\ScripturNum\ScripturNumArray ScripturNum\ScripturNumArray::remove(\ScripturNum\ScripturNum other)

Subtract a passage from this array of passages.

• Visibility: public

Arguments

• other ScripturNum\ScripturNum

Returns

• \ScripturNum\ScripturNumArray -

removeAll

\ScripturNum\ScripturNumArray ScripturNum\ScripturNumArray::removeAll(\ScripturNum\ScripturNumArray others)

Subtract all passages in another ScripturNumArray from this array of passages.

• Visibility: public

Arguments

• others ScripturNum\ScripturNumArray

Returns

• \ScripturNum\ScripturNumArray -

__toString

string ScripturNum\ScripturNumArray::__toString()

• Visibility: public

Returns

• string -

getString

string ScripturNum\ScripturNumArray::getString(string|array options)

Alias for toString(), but returns an empty string on error.

• Visibility: public

Arguments

• options string|array

Returns

• string -

toString

string ScripturNum\ScripturNumArray::toString(string|array options)

Return a human-readable string representation of the contained passages.

• Visibility: public

Arguments

• options string|array - The setting set to use, or an array of options.

Returns

• string -