- Symphony 2.2.5
-
› assets
11 -
› boot
9 -
› core
22 -
› email-gateways
3 -
› toolkit
67 -
› Unknown
33 - Delegates87
- Deprecated30
Versions
- 2.7.9
- 2.7.8
- 2.7.7
- 2.7.6
- 2.7.5
- 2.7.3
- 2.7.2
- 2.7.10
- 2.7.1
- 2.7.0
- 2.6.9
- 2.6.8
- 2.6.7
- 2.6.6
- 2.6.5
- 2.6.4
- 2.6.3
- 2.6.2
- 2.6.11
- 2.6.10
- 2.6.1
- 2.6.0
- 2.5.3
- 2.5.2
- 2.5.1
- 2.5.0
- 2.4
- 2.3.6
- 2.3.5
- 2.3.4
- 2.3.3
- 2.3.2
- 2.3.1
- 2.3
- 2.2.5
- 2.2.4
- 2.2.3
- 2.2.2
- 2.2.1
- 2.2
Options
Manager EmailGatewayManager
public class EmailGatewayManager extends Manager
class.emailgatewaymanager.php #14A 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
string|boolean __find(
$name)
Finds the gateway by name
Parameters
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(
$name)
Returns the classname from the gateway name. Does not check if the gateway exists.
string|boolean __getClassPath(
$name)
Alias for __find
string|boolean __getDriverPath(
$name)
Returns the path to the gateway file.
Parameters
string|boolean __getHandleFromFilename(
$filename)
Finds the name from the filename. Does not check if the gateway exists.
EmailGateway create(
$name)
Creates a new object from a gateway name.
Parameters
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(
$name)
Sets the default gateway. Will throw an exception if the gateway can not be found.