Класс TransportFactory

_buildTransport()source protected static

_buildTransport( string $name )

Поиск и создание экземпляра необходимого класса транспорта.

Параметры

строка $name

Имя конфигурационного массива, для которого требуется создать экземпляр транспорта

Исключения

InvalidArgumentException
Когда транспорт не может быть создан.

get()source public static

get( string $name )

Получение экземпляра транспорта.

Параметры

строка $name

Имя конфигурации.

Возвращает

Cake\Mailer\AbstractTransport

getRegistry()source public static

getRegistry( )

Возвращает реестр транспорта, используемый для создания и использования экземпляров транспорта.

Возвращает

Cake\Mailer\TransportRegistry

setRegistry()source public static

setRegistry( Cake\Mailer\TransportRegistry $registry )

Устанавливает экземпляр реестра транспорта, используемый для создания и использования экземпляров транспорта.

Также позволяет вводить новый экземпляр реестра.

Параметры

Cake\Mailer\TransportRegistry $registry

Объект реестра для ввода.

config()source public static deprecated

config( string|array $key , array|null $config = null )

Этот метод может использоваться для определения адаптеров конфигурации для приложения или чтения существующей конфигурации.

Для изменения конфигурации адаптера во время выполнения сначала необходимо удалить адаптер, а затем переконфигурировать его.

Адаптеры будут созданы только после выполнения первого действия.

Использование

Предполагая, что имя класса Cache поддерживаются следующие сценарии:

Чтение данных конфигурации обратно:

Cache::config('default');

Настройка движка кэша.

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

Ввод уже созданного адаптера:

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

Конфигурирование нескольких адаптеров одновременно:

Cache::config($arrayOfConfig);

Устаревший

3.4.0 Используйте setConfig()/getConfig() вместо этого.

Параметры

строка|массив $key

Имя конфигурации или массив нескольких конфигураций.

массив|null $config необязательно null

Массив name => данные конфигурации для адаптера.

Возвращает

массив|null
Null при добавлении конфигурации или массив данных конфигурации при чтении.

Исключения

BadMethodCallException
При попытке изменить существующую конфигурацию.

configured()source public static

configured( )

Возвращает массив, содержащий именованные конфигурации

Возвращает

строка[]
Массив конфигураций.

drop()source public static

drop( string $config )

Удаляет созданный адаптер.

Если необходимо изменить существующую конфигурацию, необходимо удалить её, изменить конфигурацию, а затем добавить её заново.

Если реализующие объекты поддерживают объект $_registry именованная конфигурация также будет выгружена из реестра.

Параметры

строка $config

Существующая конфигурация, которую необходимо удалить.

Возвращает

boolean
Успех удаления, возвращает false, когда конфигурация не существует.

dsnClassMap()source public static deprecated

dsnClassMap( array $map = null )

Возвращает или обновляет карту классов DSN для этого класса.

Устаревший

3.4.0 Используйте setDsnClassMap()/getDsnClassMap() вместо этого.

Параметры

массив $map необязательно null

Добавления/изменения в карту классов для применения.

Возвращает

массив

getConfig()source public static

getConfig( string $key )

Читает существующую конфигурацию.

Параметры

строка $key

Имя конфигурации.

Возвращает

массив|null
Массив данных конфигурации.

getDsnClassMap()source public static

getDsnClassMap( )

Возвращает карту классов DSN для этого класса.

Возвращает

массив

parseDsn()source public static

parseDsn( string $dsn )

Разбирает DSN в корректную конфигурацию соединения

Этот метод позволяет задать DSN с форматированием, аналогичным тому, которое используется PEAR::DB. Вот пример его использования:

$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);

Для всех классов значение scheme устанавливается как значение обоих className, если они не были указаны иным образом.

Обратите внимание, что аргументы строки запроса также анализируются и устанавливаются как значения в возвращаемой конфигурации.

Параметры

строка $dsn

Строка DSN для преобразования в массив конфигурации

Возвращает

массив
Массив конфигурации для хранения после анализа DSN

Исключения

InvalidArgumentException
Если не передана строка или передана некорректная строка

setConfig()source public static

setConfig( string|array $key , array $config = null )

Этот метод можно использовать для определения адаптеров конфигурации для приложения.

Чтобы изменить конфигурацию адаптера во время выполнения, сначала удалите адаптер, а затем переконфигурируйте его.

Адаптеры не будут созданы до тех пор, пока не будет выполнено первое действие.

Использование

Предполагая, что имя класса Cache, поддерживаются следующие сценарии:

Настройка движка кэша.

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

Вставка построенного адаптера в:

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

Конфигурирование нескольких адаптеров одновременно:

Cache::setConfig($arrayOfConfig);

Параметры

строка|массив $key

Имя конфигурации или массив с несколькими конфигурациями.

массив $config необязательно null

Массив пар имя => данные конфигурации для адаптера.

Исключения

BadMethodCallException
При попытке изменить существующую конфигурацию.
LogicException
При попытке сохранить массив конфигурации с неверной структурой.

setDsnClassMap()source public static

setDsnClassMap( array $map )

Обновляет карту соответствия DSN для этого класса.

Параметры

массив $map

Добавления/изменения в карту классов для применения.

[
    'debug' => 'Cake\Mailer\Transport\DebugTransport',
    'mail' => 'Cake\Mailer\Transport\MailTransport',
    'smtp' => 'Cake\Mailer\Transport\SmtpTransport',
]