$_config
$_config : array
Configuration sets.
Factory class for generating email transport instances.
$_registry : \Cake\Mailer\TransportRegistry
Transport Registry used for creating and using transport instances.
setConfig(string|array $key, array $config = null) : void
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.
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);| string|array | $key | The name of the configuration, or an array of multiple configs. |
| array | $config | An array of name => configuration data for adapter. |
When trying to modify an existing config.
When trying to store an invalid structured config array.
config(string|array $key, array|null $config = null) : array|null
This method can be used to define configuration adapters for an application or read existing configuration.
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.
Assuming that the class' name is Cache the following scenarios
are supported:
Reading config data back:
Cache::config('default');Setting a cache engine up.
Cache::config('default', $settings);Injecting a constructed adapter in:
Cache::config('default', $instance);Configure multiple adapters at once:
Cache::config($arrayOfConfig);| string|array | $key | The name of the configuration, or an array of multiple configs. |
| array|null | $config | An array of name => configuration data for adapter. |
When trying to modify an existing config.
Null when adding configuration or an array of configuration data when reading.
drop(string $config) : boolean
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.
| string | $config | An existing configuration you wish to remove. |
Success of the removal, returns false when the config does not exist.
parseDsn(string $dsn) : array
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.
| string | $dsn | The DSN string to convert to a configuration array |
If not passed a string, or passed an invalid string
The configuration array to be stored after parsing the DSN
getRegistry() : \Cake\Mailer\TransportRegistry
Returns the Transport Registry used for creating and using transport instances.
setRegistry(\Cake\Mailer\TransportRegistry $registry) : void
Sets the Transport Registry instance used for creating and using transport instances.
Also allows for injecting of a new registry instance.
| \Cake\Mailer\TransportRegistry | $registry | Injectable registry object. |
get(string $name) : \Cake\Mailer\AbstractTransport
Get transport instance.
| string | $name | Config name. |
Loading…