core\message\inbound\manager Class Reference

Variable Envelope Return Path manager class. More...

Static Public Member Functions
static	create_missing_messageinbound_handlers_for_component ($componentname)
	Update the database to contain a list of handlers for a component, adding any handlers which do not exist in the database. More...
static	get_handler ($classname)
	Load the Inbound Message handler details for a given classname. More...
static	get_handler_from_id ($id)
	Load the Inbound Message handler with a given ID. More...
static	is_enabled ()
	Whether the Inbound Message interface is enabled. More...
static	load_default_handlers_for_component ($componentname)
	Load handler instances for all of the handlers defined in db/messageinbound_handlers.php for the specified component. More...
static	record_from_handler ($handler)
	Create a flat stdClass for the handler, appropriate for inserting into the database. More...
static	remove_messageinbound_handler ($handler)
	Remove the specified handler. More...
static	update_handlers_for_component ($componentname)
	Update the database to create, update, and remove handlers. More...

Static Protected Member Functions
static	handler_from_record ($record)
	Load the Inbound Message handler details for a given record. More...

Detailed Description

Variable Envelope Return Path manager class.

Copyright

2014 Andrew Nicols andre.nosp@m.w@ni.nosp@m.cols..nosp@m.co.u.nosp@m.k

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

create_missing_messageinbound_handlers_for_component()

static core\message\inbound\manager::create_missing_messageinbound_handlers_for_component (   $componentname )

static

Update the database to contain a list of handlers for a component, adding any handlers which do not exist in the database.

Parameters

string

$componentname

- The frankenstyle component name.

get_handler()

static core\message\inbound\manager::get_handler (   $classname )

static

Load the Inbound Message handler details for a given classname.

Parameters

string

$classname

The name of the class for the handler.

Return values

core::message::inbound::handler

or false

get_handler_from_id()

static core\message\inbound\manager::get_handler_from_id (   $id )

static

Load the Inbound Message handler with a given ID.

Parameters

int

$id

Return values

core::message::inbound::handler

or false

handler_from_record()

static core\message\inbound\manager::handler_from_record (   $record )

staticprotected

Load the Inbound Message handler details for a given record.

Parameters

stdClass

$record

The record to retrieve the handler for.

Return values

core::message::inbound::handler

or false

is_enabled()

static core\message\inbound\manager::is_enabled ( )

static

Whether the Inbound Message interface is enabled.

Return values

bool

load_default_handlers_for_component()

static core\message\inbound\manager::load_default_handlers_for_component (   $componentname )

static

Load handler instances for all of the handlers defined in db/messageinbound_handlers.php for the specified component.

Parameters

string

$componentname

- The name of the component to fetch the handlers for.

Return values

core::message::inbound::handler[]

- List of handlers for this component.

record_from_handler()

static core\message\inbound\manager::record_from_handler (   $handler )

static

Create a flat stdClass for the handler, appropriate for inserting into the database.

Parameters

core::message::inbound::handler

$handler

The handler to retrieve the record for.

Return values

stdClass

remove_messageinbound_handler()

static core\message\inbound\manager::remove_messageinbound_handler (   $handler )

static

Remove the specified handler.

Parameters

core::message::inbound::handler

$handler

The handler to remove

update_handlers_for_component()

static core\message\inbound\manager::update_handlers_for_component (   $componentname )

static

Update the database to create, update, and remove handlers.

Parameters

string

$componentname

- The frankenstyle component name.

---

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

• lib/classes/message/inbound/manager.php