\Pvra\ResultMessageLocator

terminateCallbackChain()

terminateCallbackChain() 

Terminate callback chain from inside a callback

This method may be called from inside of a callback chain to break out in the next iteration *

Throws

\LogicException

Thrown if no callback chain is executing when called

addMissingMessageHandler()

addMissingMessageHandler(callable  $locator, integer  $position = self::CALLBACK_POSITION_APPEND) : $this

Append a function to handle missing messages.

The callbacks given to this method is executed when the corresponding MessageLocator could not find a valid message for a given id. The callback should return a string. The callback may also prevent return false to allow subsequent callbacks to execute. $locator->addMissingMessageHandler(function($msgId, MessageLocator $locator) {

if(MyOwnLocator::canLocate($msgId)) {
    return $msg;
}
$locator->terminateCallbackChain();

});

Parameters

Returns

messageExists()

messageExists(string|integer  $messageId) : boolean

Parameters

Throws

\Exception

Returns

getMessage()

getMessage(integer|string  $messageId, boolean  $ignoreCachedEntries = false) : string|null

Parameters

Throws

\Exception

Returns

getMessageWithInfo()

getMessageWithInfo(integer|string  $messageId, boolean  $ignoreCachedEntries = false) : array

Parameters

Returns

fromPhpFile()

fromPhpFile(  $string) : \Pvra\Result\MessageLocator

Parameters

Returns

fromJsonFile()

fromJsonFile(  $file) 

Parameters

fromArray()

fromArray(  $array) : static

Parameters

Returns

addMessageSearcher()

addMessageSearcher(callable  $searcher, integer  $position = self::CALLBACK_POSITION_APPEND) : $this

Parameters

Returns

clearInstanceCache()

clearInstanceCache() 

offsetExists()

offsetExists(string|integer  $id) : boolean

OffsetExists Whether a message with the given id can be found without invoking missing message handlers

Parameters

Returns

true on success or false on failure.

offsetGet()

offsetGet(string|integer  $id) : string

OffsetGet This method proxies ::getMessage($offset)

Parameters

Returns

the message template

offsetSet()

offsetSet(null  $offset, callable  $value) 

Appends a new message searcher Only the following syntax is valid: `$locator[] = function($id, $locator) {};

Parameters

Throws

\InvalidArgumentException

Exception is thrown if an offset is specified or the value is not callable

offsetUnset()

offsetUnset(mixed  $offset) 

Parameters

Throws

\RuntimeException

Is always thrown as this operation is not supported

inCallbackChain()

inCallbackChain(boolean  $areWeInCallbackChain) 

Modify the status of current callback execution

This method can be used by the callback calling code to make sure other methods react properly.

Parameters

isCallbackChainToBeTerminated()

isCallbackChainToBeTerminated() : boolean

Get the status of the callback chain termination

This method can be used to determine if the callback chain is to be terminated prematurely.

Returns

markCallbackChainTerminated()

markCallbackChainTerminated() 

Mark callback chain terminated

This method should be called after the callback chain was terminated, either by breaking out of it prematurely or after finishing all callback handlers.

fetchMessage()

fetchMessage(string|integer  $messageId, boolean  $runMissingMessageHandlers = true) : array|boolean

Parameters

Throws

\Exception

Returns

validateMessageId()

validateMessageId(string|integer  $mId) : boolean

Parameters

Returns