Class TransportFactory

Factory class for generating email transport instances.

Namespace: Cake\Mailer

Properties summary

  • $_config protected static
    array

    Configuration sets.

  • $_dsnClassMap protected static
    string[]

    An array mapping url schemes to fully qualified Transport class names

  • $_registry protected static
    \Cake\Mailer\TransportRegistry|null

    Transport Registry used for creating and using transport instances.

Method Summary

  • _buildTransport() protected static

    Finds and builds the instance of the required tranport class.

  • configured() public static

    Returns an array containing the named configurations

  • drop() public static

    Drops a constructed adapter.

  • get() public static

    Get transport instance.

  • getConfig() public static

    Reads existing configuration.

  • getConfigOrFail() public static

    Reads existing configuration for a specific key.

  • getDsnClassMap() public static

    Returns the DSN class map for this class.

  • getRegistry() public static

    Returns the Transport Registry used for creating and using transport instances.

  • parseDsn() public static

    Parses a DSN into a valid connection configuration

  • setConfig() public static

    This method can be used to define configuration adapters for an application.

  • setDsnClassMap() public static

    Updates the DSN class map for this class.

  • setRegistry() public static

    Sets the Transport Registry instance used for creating and using transport instances.

Method Detail

_buildTransport() protected static 

_buildTransport(string $name)

Finds and builds the instance of the required tranport class.

Parameters

string $name

Name of the config array that needs a tranport instance built

Throws

InvalidArgumentException
When a tranport cannot be created.

configured() public static 

configured()

Returns an array containing the named configurations

Returns

string[]

Array of configurations.

drop() public static 

drop(string $config)

Drops a constructed adapter.

If you wish to modify an existing configuration, you should drop it, change configuration and then re-add it.

If the implementing objects supports a $_registry object the named configuration will also be unloaded from the registry.

Parameters

string $config

An existing configuration you wish to remove.

Returns

bool

Success of the removal, returns false when the config does not exist.

get() public static 

get(string $name)

Get transport instance.

Parameters

string $name

Config name.

Returns

\Cake\Mailer\AbstractTransport

getConfig() public static 

getConfig(string $key)

Reads existing configuration.

Parameters

string $key

The name of the configuration.

Returns

mixed|null

Configuration data at the named key or null if the key does not exist.

getConfigOrFail() public static 

getConfigOrFail(string $key)

Reads existing configuration for a specific key.

The config value for this key must exist, it can never be null.

Parameters

string $key

The name of the configuration.

Returns

mixed

Configuration data at the named key.

Throws

InvalidArgumentException
If value does not exist.

getDsnClassMap() public static 

getDsnClassMap()

Returns the DSN class map for this class.

Returns

string[]

getRegistry() public static 

getRegistry()

Returns the Transport Registry used for creating and using transport instances.

Returns

\Cake\Mailer\TransportRegistry

parseDsn() public static 

parseDsn(string $dsn)

Parses a DSN into a valid connection configuration

This method allows setting a DSN using formatting similar to that used by PEAR::DB. The following is an example of its usage:

$dsn = 'mysql://user:pass@localhost/database?';
$config = ConnectionManager::parseDsn($dsn);

$dsn = 'Cake\Log\Engine\FileLog://?types=notice,info,debug&file=debug&path=LOGS';
$config = Log::parseDsn($dsn);

$dsn = 'smtp://user:secret@localhost:25?timeout=30&client=null&tls=null';
$config = Email::parseDsn($dsn);

$dsn = 'file:///?className=\My\Cache\Engine\FileEngine';
$config = Cache::parseDsn($dsn);

$dsn = 'File://?prefix=myapp_cake_core_&serialize=true&duration=+2 minutes&path=/tmp/persistent/';
$config = Cache::parseDsn($dsn);

For all classes, the value of scheme is set as the value of both the className unless they have been otherwise specified.

Note that querystring arguments are also parsed and set as values in the returned configuration.

Parameters

string $dsn

The DSN string to convert to a configuration array

Returns

array

The configuration array to be stored after parsing the DSN

Throws

InvalidArgumentException
If not passed a string, or passed an invalid string

setConfig() public static 

setConfig(mixed $key, mixed $config)

This method can be used to define configuration adapters for an application.

To change an adapter's configuration at runtime, first drop the adapter and then reconfigure it.

Adapters will not be constructed until the first operation is done.

Usage

Assuming that the class' name is Cache the following scenarios are supported:

Setting a cache engine up.

Cache::setConfig('default', $settings);

Injecting a constructed adapter in:

Cache::setConfig('default', $instance);

Configure multiple adapters at once:

Cache::setConfig($arrayOfConfig);

Parameters

string|array $key

The name of the configuration, or an array of multiple configs.

array|object|null $config optional

An array of name => configuration data for adapter.

Throws

BadMethodCallException
When trying to modify an existing config.
LogicException
When trying to store an invalid structured config array.

setDsnClassMap() public static 

setDsnClassMap(array $map)

Updates the DSN class map for this class.

Parameters

string[] $map

Additions/edits to the class map to apply.

setRegistry() public static 

setRegistry(\Cake\Mailer\TransportRegistry $registry)

Sets the Transport Registry instance used for creating and using transport instances.

Also allows for injecting of a new registry instance.

Parameters

\Cake\Mailer\TransportRegistry $registry

Injectable registry object.

Property Detail

$_config protected static

Configuration sets.

Type

array

$_dsnClassMap protected static

An array mapping url schemes to fully qualified Transport class names

Type

string[]

$_registry protected static

Transport Registry used for creating and using transport instances.

Type

\Cake\Mailer\TransportRegistry|null

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.1/class-Cake.Mailer.TransportFactory.html