Class FileOptions

Summary

Fully Qualified Name: Zend\Mail\Transport\FileOptions
Extends: AbstractOptions

Description

Methods

Name Description Defined By
__construct() Constructor AbstractOptions
__get() Get a configuration property AbstractOptions
__isset() Test if a configuration property is null AbstractOptions
__set() Set a configuration property AbstractOptions
__unset() Set a configuration property to NULL AbstractOptions
getCallback() Get callback used to generate a file name FileOptions
getPath() Get path FileOptions
setCallback() Set callback used to generate a file name FileOptions
setFromArray() Set one or more configuration properties AbstractOptions
setPath() Set path to stored mail files FileOptions
toArray() Cast to array AbstractOptions

Method Details

__construct()

Constructor

Parameter Name Type Description
$options array|\Traversable|null

Returns:

__get()

Get a configuration property

Parameter Name Type Description
$key string

Returns: mixed

__isset()

Test if a configuration property is null

Parameter Name Type Description
$key string

Returns: bool

__set()

Set a configuration property

Parameter Name Type Description
$key string
$value mixed

Returns: void

__unset()

Set a configuration property to NULL

Parameter Name Type Description
$key string

Returns: void

getCallback()

Get callback used to generate a file name

Returns: callable

getPath()

Get path

If none is set, uses value from sys_get_temp_dir()

Returns: string

setCallback()

Set callback used to generate a file name

Parameter Name Type Description
$callback callable

Returns: \FileOptions

setFromArray()

Set one or more configuration properties

Parameter Name Type Description
$options array|\Traversable|\AbstractOptions

Returns: \AbstractOptions Provides fluent interface

setPath()

Set path to stored mail files

Parameter Name Type Description
$path string

Returns: \FileOptions

toArray()

Cast to array

Returns: array

Top