Manager EmailGatewayManager

public class EmailGatewayManager extends Manager

class.emailgatewaymanager.php #14

A manager to standardize the finding and listing of installed gateways.

Methods

void __construct(Administration $parent)

The constructor for Manager. This sets the $this->_Parent to be an instance of the Administration class.

Parameters
  • $parent AdministrationThe Administration object that this manager has been created from passed by reference

string|boolean __find(string $name)

Finds the gateway by name

Parameters
  • $name stringThe gateway to look for

Returns

If the gateway is found, the path to the folder containing the gateway is returned. If the gateway is not found, false is returned.

string __getClassName(string $name)

Returns the classname from the gateway name. Does not check if the gateway exists.

string|boolean __getClassPath(string $name)

Alias for __find

string|boolean __getDriverPath(string $name)

Returns the path to the gateway file.

Parameters
  • $name stringThe gateway to look for

string|boolean __getHandleFromFilename(string $filename)

Finds the name from the filename. Does not check if the gateway exists.

EmailGateway create(string $name)

Creates a new object from a gateway name.

Parameters
  • $name stringThe gateway to look for

Returns

If the gateway is found, an instantiated object is returned. If the gateway is not found, an error is triggered.

string getDefaultGateway()

Returns the default gateway. Will throw an exception if the gateway can not be found.

array listAll()

Returns an array of all gateways. Each item in the array will contain the return value of the about() function of each gateway.

void setDefaultGateway(string $name)

Sets the default gateway. Will throw an exception if the gateway can not be found.

Symphony • Open Source XSLT CMS

Server Requirements

  • PHP 5.3-5.6 or 7.0-7.3
  • PHP's LibXML module, with the XSLT extension enabled (--with-xsl)
  • MySQL 5.5 or above
  • An Apache or Litespeed webserver
  • Apache's mod_rewrite module or equivalent

Compatible Hosts

Sign in

Login details