public class EmailGatewayManager

class.emailgatewaymanager.php #11

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

Methods

static string __getClassName(string $name)

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

static string|boolean __getClassPath(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.

static string|boolean __getDriverPath(string $name)

Returns the path to the gateway file.

Parameters
  • $name stringThe gateway to look for

static string|boolean __getHandleFromFilename(string $filename)

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

static void about(mixed $name)
static 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.

static string getDefaultGateway()

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

static 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.

static 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