Erebot\NumericProfile\Base Class Reference

Abstract class that serves as a base to create a numeric profile for an IRCd server. More...

Inheritance diagram for Erebot\NumericProfile\Base:

Public Member Functions
	__construct ()
	Constructs a new instance of this numeric profile.
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)

Public Attributes
const	ERR_ALREADYREGISTERED = 'ERR_ALREADYREGISTRED'
	Alias for Erebot::Interfaces::Numerics::ERR_ALREADYREGISTRED.
const	ERR_ALREADYREGISTRED = 'ERR_ALREADYREGISTERED'
	Alias for Erebot::Interfaces::Numerics::ERR_ALREADYREGISTERED.
const	ERR_BADPING = 'ERR_NEEDPONG'
	Alias for Erebot::Interfaces::Numerics::ERR_NEEDPONG.
const	ERR_CANTCHANGENICK = 'ERR_NONICKCHANGE'
	Alias for Erebot::Interfaces::Numerics::ERR_NONICKCHANGE.
const	ERR_CANTJOINOPERSONLY = 'ERR_OPERONLY'
	Alias for Erebot::Interfaces::Numerics::ERR_OPERONLY.
const	ERR_CHANOPPRIVSNEEDED = 'ERR_CHANOPRIVSNEEDED'
	Alias for Erebot::Interfaces::Numerics::ERR_CHANOPRIVSNEEDED.
const	ERR_CHANOPRIVSNEEDED = 'ERR_CHANOPPRIVSNEEDED'
	Alias for Erebot::Interfaces::Numerics::ERR_CHANOPPRIVSNEEDED.
const	ERR_DELAYREJOIN = 'ERR_KICKNOREJOIN'
	Alias for Erebot::Interfaces::Numerics::ERR_KICKNOREJOIN.
const	ERR_KICKNOREJOIN = 'ERR_DELAYREJOIN'
	Alias for Erebot::Interfaces::Numerics::ERR_DELAYREJOIN.
const	ERR_LAST_ERR_MSG = 'ERR_NUMERICERR'
	Alias for Erebot::Interfaces::Numerics::ERR_NUMERICERR.
const	ERR_NCHANGETOOFAST = 'ERR_NICKTOOFAST'
	Alias for Erebot::Interfaces::Numerics::ERR_NICKTOOFAST.
const	ERR_NEEDPONG = 'ERR_BADPING'
	Alias for Erebot::Interfaces::Numerics::ERR_BADPING.
const	ERR_NICKTOOFAST = 'ERR_NCHANGETOOFAST'
	Alias for Erebot::Interfaces::Numerics::ERR_NCHANGETOOFAST.
const	ERR_NOCTCP = 'ERR_NOCTCPALLOWED'
	Alias for Erebot::Interfaces::Numerics::ERR_NOCTCP.
const	ERR_NOCTCPALLOWED = 'ERR_NOCTCP'
	Alias for Erebot::Interfaces::Numerics::ERR_NOCTCPALLOWED.
const	ERR_NONICKCHANGE = 'ERR_CANTCHANGENICK'
	Alias for Erebot::Interfaces::Numerics::ERR_CANTCHANGENICK.
const	ERR_NOSSL = 'ERR_NOTSSLCLIENT'
	Alias for Erebot::Interfaces::Numerics::ERR_NOTSSLCLIENT.
const	ERR_NOSWEAR = 'ERR_WORDFILTERED'
	Alias for Erebot::Interfaces::Numerics::ERR_WORDFILTERED.
const	ERR_NOTSSLCLIENT = 'ERR_NOSSL'
	Alias for Erebot::Interfaces::Numerics::ERR_NOSSL.
const	ERR_NUMERIC_ERR = 'ERR_LAST_ERR_MSG'
	Alias for Erebot::Interfaces::Numerics::ERR_LAST_ERR_MSG.
const	ERR_NUMERICERR = 'ERR_NUMERIC_ERR'
	Alias for Erebot::Interfaces::Numerics::ERR_NUMERIC_ERR.
const	ERR_OPERONLY = 'ERR_OPERONLYCHAN'
	Alias for Erebot::Interfaces::Numerics::ERR_OPERONLYCHAN.
const	ERR_OPERONLYCHAN = 'ERR_CANTJOINOPERSONLY'
	Alias for Erebot::Interfaces::Numerics::ERR_CANTJOINOPERSONLY.
const	ERR_STARTTLS = 'ERR_STARTTLSFAIL'
	Alias for Erebot::Interfaces::Numerics::ERR_STARTTLSFAIL.
const	ERR_STARTTLSFAIL = 'ERR_STARTTLS'
	Alias for Erebot::Interfaces::Numerics::ERR_STARTTLS.
const	ERR_TARGETTOFAST = 'ERR_TARGETTOOFAST'
	Alias for Erebot::Interfaces::Numerics::ERR_TARGETTOOFAST.
const	ERR_TARGETTOOFAST = 'ERR_TARGETTOFAST'
	Alias for Erebot::Interfaces::Numerics::ERR_TARGETTOFAST.
const	ERR_WORDFILTERED = 'ERR_NOSWEAR'
	Alias for Erebot::Interfaces::Numerics::ERR_NOSWEAR.
const	RPL_BOUNCE = 'RPL_REDIR'
	Alias for Erebot::Interfaces::Numerics::RPL_REDIR.
const	RPL_CHANNELCREATED = 'RPL_CREATIONTIME'
	Alias for Erebot::Interfaces::Numerics::RPL_CREATIONTIME.
const	RPL_COMMANDSYNTAX = 'RPL_LISTSYNTAX'
	Alias for Erebot::Interfaces::Numerics::RPL_LISTSYNTAX.
const	RPL_CREATED = 'RPL_SERVERCREATED'
	Alias for Erebot::Interfaces::Numerics::RPL_SERVERCREATED.
const	RPL_CREATIONTIME = 'RPL_CHANNELCREATED'
	Alias for Erebot::Interfaces::Numerics::RPL_CHANNELCREATED.
const	RPL_ENDMAP = 'RPL_MAPEND'
	Alias for Erebot::Interfaces::Numerics::RPL_MAPEND.
const	RPL_ENDOFEXCEPTLIST = 'RPL_ENDOFEXEMPTLIST'
	Alias for Erebot::Interfaces::Numerics::RPL_ENDOFEXEMPTLIST.
const	RPL_ENDOFEXEMPTLIST = 'RPL_ENDOFEXLIST'
	Alias for Erebot::Interfaces::Numerics::RPL_ENDOFEXLIST.
const	RPL_ENDOFEXLIST = 'RPL_ENDOFEXCEPTLIST'
	Alias for Erebot::Interfaces::Numerics::RPL_ENDOFEXCEPTLIST.
const	RPL_ENDOFINVEXLIST = 'RPL_ENDOFINVITELIST'
	Alias for Erebot::Interfaces::Numerics::RPL_ENDOFINVITELIST.
const	RPL_ENDOFINVITELIST = 'RPL_ENDOFINVEXLIST'
	Alias for Erebot::Interfaces::Numerics::RPL_ENDOFINVEXLIST.
const	RPL_ENDOFRULES = 'RPL_RULESEND'
	Alias for Erebot::Interfaces::Numerics::RPL_RULESEND.
const	RPL_ENDOFTRACE = 'RPL_TRACEEND'
	Alias for Erebot::Interfaces::Numerics::RPL_TRACEEND.
const	RPL_EXCEPTLIST = 'RPL_EXEMPTLIST'
	Alias for Erebot::Interfaces::Numerics::RPL_EXEMPTLIST.
const	RPL_EXEMPTLIST = 'RPL_EXLIST'
	Alias for Erebot::Interfaces::Numerics::RPL_EXLIST.
const	RPL_EXLIST = 'RPL_EXCEPTLIST'
	Alias for Erebot::Interfaces::Numerics::RPL_EXCEPTLIST.
const	RPL_INVEXLIST = 'RPL_INVITELIST'
	Alias for Erebot::Interfaces::Numerics::RPL_INVITELIST.
const	RPL_INVITELIST = 'RPL_INVEXLIST'
	Alias for Erebot::Interfaces::Numerics::RPL_INVEXLIST.
const	RPL_LISTSYNTAX = 'RPL_COMMANDSYNTAX'
	Alias for Erebot::Interfaces::Numerics::RPL_COMMANDSYNTAX.
const	RPL_LOAD2HI = 'RPL_TRYAGAIN'
	Alias for Erebot::Interfaces::Numerics::RPL_TRYAGAIN.
const	RPL_MAPEND = 'RPL_ENDMAP'
	Alias for Erebot::Interfaces::Numerics::RPL_ENDMAP.
const	RPL_MYINFO = 'RPL_SERVERVERSION'
	Alias for Erebot::Interfaces::Numerics::RPL_SERVERVERSION.
const	RPL_NAMEREPLY = 'RPL_NAMREPLY'
	Alias for Erebot::Interfaces::Numerics::RPL_NAMREPLY.
const	RPL_NAMREPLY = 'RPL_NAMEREPLY'
	Alias for Erebot::Interfaces::Numerics::RPL_NAMEREPLY.
const	RPL_REDIR = 'RPL_BOUNCE'
	Alias for Erebot::Interfaces::Numerics::RPL_BOUNCE.
const	RPL_RULESEND = 'RPL_ENDOFRULES'
	Alias for Erebot::Interfaces::Numerics::RPL_ENDOFRULES.
const	RPL_RULESSTART = 'RPL_RULESTART'
	Alias for Erebot::Interfaces::Numerics::RPL_RULESTART.
const	RPL_RULESTART = 'RPL_RULESSTART'
	Alias for Erebot::Interfaces::Numerics::RPL_RULESSTART.
const	RPL_SERVERCREATED = 'RPL_CREATED'
	Alias for Erebot::Interfaces::Numerics::RPL_CREATED.
const	RPL_SERVERVERSION = 'RPL_MYINFO'
	Alias for Erebot::Interfaces::Numerics::RPL_MYINFO.
const	RPL_STARTTLS = 'RPL_STARTTLSOK'
	Alias for Erebot::Interfaces::Numerics::RPL_STARTTLSOK.
const	RPL_STARTTLSOK = 'RPL_STARTTLS'
	Alias for Erebot::Interfaces::Numerics::RPL_STARTTLS.
const	RPL_TOPICTIME = 'RPL_TOPICWHOTIME'
	Alias for Erebot::Interfaces::Numerics::RPL_TOPICWHOTIME.
const	RPL_TOPICWHOTIME = 'RPL_TOPICTIME'
	Alias for Erebot::Interfaces::Numerics::RPL_TOPICTIME.
const	RPL_TRACEEND = 'RPL_ENDOFTRACE'
	Alias for Erebot::Interfaces::Numerics::RPL_ENDOFTRACE.
const	RPL_TRYAGAIN = 'RPL_LOAD2HI'
	Alias for Erebot::Interfaces::Numerics::RPL_LOAD2HI.
const	RPL_USINGSSL = 'RPL_WHOISSECURE'
	Alias for Erebot::Interfaces::Numerics::RPL_WHOISSECURE.
const	RPL_WHOISSECURE = 'RPL_USINGSSL'
	Alias for Erebot::Interfaces::Numerics::RPL_USINGSSL.
const	RPL_YOUAREOPER = 'RPL_YOUREOPER'
	Alias for Erebot::Interfaces::Numerics::RPL_YOUREOPER.
const	RPL_YOUREOPER = 'RPL_YOUAREOPER'
	Alias for Erebot::Interfaces::Numerics::RPL_YOUAREOPER.
const	RPL_YOURHOST = 'RPL_YOURHOSTIS'
	Alias for Erebot::Interfaces::Numerics::RPL_YOURHOSTIS.
const	RPL_YOURHOSTIS = 'RPL_YOURHOST'
	Alias for Erebot::Interfaces::Numerics::RPL_YOURHOST.
const	RPL_YOURID = 'RPL_YOURUUID'
	Alias for Erebot::Interfaces::Numerics::RPL_YOURUUID.
const	RPL_YOURUUID = 'RPL_YOURID'
	Alias for Erebot::Interfaces::Numerics::RPL_YOURID.

Protected Attributes
	$reflector
	Reflection object for this class.

Detailed Description

Abstract class that serves as a base to create a numeric profile for an IRCd server.

Note

Several constants are defined by this class, that match common aliases found in IRC server softwares.

Definition at line 33 of file Base.php.

Member Function Documentation

Erebot\NumericProfile\Base::offsetExists

(

$offset

)

Whether or not an offset exists.

This method is executed when using isset() or empty() on objects implementing ArrayAccess.

Parameters

mixed

$offset

An offset to check for.

Return values

bool	true is returned when the offset exists, false when it doesn't.

See also

http://php.net/arrayaccess.offsetexists.php

Note

When using empty() ArrayAccess::offsetGet() will be called and checked for emptyness only if ArrayAccess::offsetExists() returns true.

Implements ArrayAccess.

Definition at line 225 of file Base.php.

Erebot\NumericProfile\Base::offsetGet

(

$offset

)

Returns the value at specified offset.

This method is executed when checking if offset is empty().

Parameters

mixed

$offset

The offset to retrieve.

Return values

mixed

Value at the specified offset.

See also

http://php.net/arrayaccess.offsetget.php

Implements ArrayAccess.

Definition at line 231 of file Base.php.

Erebot\NumericProfile\Base::offsetSet	(		$offset,
			$value
	)

Assigns a value to the specified offset.

Parameters

mixed	$offset	The offset to assign the value to.
mixed	$value	The value to set.

See also

http://php.net/arrayaccess.offsetset.php

Implements ArrayAccess.

Definition at line 264 of file Base.php.

Erebot\NumericProfile\Base::offsetUnset

(

$offset

)

Unsets an offset.

Parameters

mixed

$offset

The offset to unset.

See also

http://php.net/arrayaccess.offsetunset.php

Note

This method will not be called when type-casting to (unset).

Implements ArrayAccess.

Definition at line 270 of file Base.php.

---

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

• vendor/erebot/api/src/NumericProfile/Base.php