Erebot  latest
A modular IRC bot for PHP 7.0+
Erebot\IrcTextWrapper Class Reference

A wrapper that correctly splits messages received from an IRC server (data part). More...

+ Inheritance diagram for Erebot\IrcTextWrapper:

Public Member Functions

 __construct ($parts)
 
 __toString ()
 
 count ()
 
 current ()
 
 key ()
 
 next ()
 
 offsetExists ($offset)
 
 offsetGet ($offset)
 
 offsetSet ($offset, $value)
 
 offsetUnset ($offset)
 
 rewind ()
 
 valid ()
 

Protected Attributes

 $parts
 The parts wrapped by this instance.
 
 $position
 Position in the text.
 

Detailed Description

A wrapper that correctly splits messages received from an IRC server (data part).

See Also
RFC 1459 and RFC 2812 (ยง2.3.1) for information on the format recognized by this wrapper.

Definition at line 32 of file IrcTextWrapper.php.

Constructor & Destructor Documentation

Erebot\IrcTextWrapper::__construct (   $parts)

Constructs a new instance of a text wrapper.

Parameters
string | array$partsThe text to wrap.

Definition at line 46 of file IrcTextWrapper.php.

Member Function Documentation

Erebot\IrcTextWrapper::count ( )

Definition at line 119 of file IrcTextWrapper.php.

Erebot\IrcTextWrapper::current ( )

Definition at line 125 of file IrcTextWrapper.php.

Erebot\IrcTextWrapper::key ( )

Definition at line 131 of file IrcTextWrapper.php.

Erebot\IrcTextWrapper::next ( )

Definition at line 137 of file IrcTextWrapper.php.

Erebot\IrcTextWrapper::offsetExists (   $offset)

Definition at line 155 of file IrcTextWrapper.php.

Erebot\IrcTextWrapper::offsetGet (   $offset)

Definition at line 161 of file IrcTextWrapper.php.

Erebot\IrcTextWrapper::offsetSet (   $offset,
  $value 
)

Definition at line 173 of file IrcTextWrapper.php.

Erebot\IrcTextWrapper::offsetUnset (   $offset)

Definition at line 179 of file IrcTextWrapper.php.

Erebot\IrcTextWrapper::rewind ( )

Definition at line 143 of file IrcTextWrapper.php.

Erebot\IrcTextWrapper::valid ( )

Definition at line 149 of file IrcTextWrapper.php.


The documentation for this class was generated from the following file: