\Phergie\IrcParser

__construct()

__construct()

Constructs regular expressions used to parse messages.

parse()

parse(string $message) : array|null

Implements ParserInterface::parse().

array(

'prefix' => ':Angel',
'nick' => 'Angel',
'command' => 'USER',
'params' => array(
    'username' => 'guest',
    'hostname' => 'tolmoon',
    'servername' => 'tolsun',
    'realname' => 'Ronnie Regan',
    'all' => 'guest tolmoon tolsun :Ronnie Regan',
),
'targets' => array('guest'),
'message' => "USER guest tolmoon tolsun :Ronnie Regan\r\n",
'tail' => 'NICK :Wiz',

),

The prefix and its components and individual targets as described in Section 2.3.1 of RFC 1459 are referenced by the 'prefix' and 'targets' keys, respectively. A string containing the first full parsed message is referenced by the 'message' key. Any remaining data after the first message is referenced by the 'tail' key. The command and its parameters are referenced by the 'command' and 'params' keys, respectively. Keys used for parameters follow the naming conventions described in Section 4 of RFC 1459. See unit tests for Phergie\Irc\Parser for examples.

Parameters

Returns

Associative array containing parsed data if the

    message is successfully parsed, null otherwise

parseAll()

parseAll(string $message) : array

Implements ParserInterface::parseAll().

Parameters

Returns

Enumerated array of associative arrays each containing

    parsed data for a single message if any messages are
    successfully parsed, an empty array otherwise

consume()

consume(string $message) : array|null

Implements ParserInterface::consume().

Parameters

Returns

Associative array containing parsed data if a

    message is successfully parsed, null otherwise

consumeAll()

consumeAll(string $message) : array

Implements ParserInterface::consumeAll().

Parameters

Returns

Enumerated array of associative arrays each containing

    parsed data for a single message if any messages are
    successfully parsed, an empty array otherwise

strip()

strip(string $param) : string

Strips leading space and colon from a given parameter string.

Parameters

Returns

removeIntegerKeys()

removeIntegerKeys(array $array) : array

Removes elements with numeric keys from an array.

Parameters

Returns