CoolCMS API

SmtpSetting extends BaseEntity
in package
implements IdentifiableInterface uses IdentifiableTrait

AbstractYes
Attributes
#[MappedSuperclass]
#[TableAlias]
$alias: 'smtpSetting'

Table of Contents

Interfaces

IdentifiableInterface
Entity with a simple integer primary key. Most entities have one (often via {@see \App\Core\Traits\Shared\Models\Entities\IdentifiableTrait}); texts and links with a composite key do not, which is why `getId()` is not on {@see \App\Core\Base\BaseEntity}. Code that needs the id of a generic entity asks for this interface (parameter type, template bound, `instanceof`).

Properties

$clientHost  : string|null
$context  : string|null
$emailAddress  : string|null
$host  : string|null
$id  : int|null
$password  : string|null
$persistent  : string|null
$port  : string|null
$secure  : string|null
$timeout  : int|null
$username  : string|null
$useSmtp  : bool

Methods

__construct()  : mixed
callInitMethods()  : void
Calls `init{TraitName}()` for every used trait that defines such a method.
getAllTraits()  : array<string, string>
Returns all traits the class uses, including those used by parent classes and nested traits.
getClientHost()  : string|null
getContext()  : string|null
getEmailAddress()  : string|null
getHost()  : string|null
getId()  : int|null
getPassword()  : string|null
getPersistent()  : string|null
getPort()  : string|null
getSecure()  : string|null
getTimeout()  : int|null
getUsername()  : string|null
getUseSmtp()  : bool
isPersisted()  : bool
setClientHost()  : $this
setContext()  : $this
setEmailAddress()  : $this
setHost()  : $this
setId()  : $this
setPassword()  : $this
setPersistent()  : $this
setPort()  : $this
setSecure()  : $this
setTimeout()  : $this
setUsername()  : $this
setUseSmtp()  : $this
getTraitsRecursive()  : array<string, string>
Walks the trait list recursively and collects nested traits too.

Properties

$clientHost

protected string|null $clientHost = null
Attributes
#[Column]
$name: 'client_host'
$type: 'text'
$nullable: true

$context

protected string|null $context = null
Attributes
#[Column]
$name: 'context'
$type: 'text'
$nullable: true

$emailAddress

protected string|null $emailAddress = null
Attributes
#[Column]
$name: 'email_address'
$type: 'string'
$length: 255
$nullable: true

$host

protected string|null $host = null
Attributes
#[Column]
$name: 'host'
$type: 'string'
$length: 100
$nullable: true

$id

protected int|null $id = null
Attributes
#[Column]
$name: 'email_address_setting_id'
$type: 'integer'
#[GeneratedValue]
$strategy: 'AUTO'
#[Id]

$password

protected string|null $password = null
Attributes
#[Column]
$name: 'password'
$type: 'string'
$length: 100
$nullable: true
#[ExternalReadonly]
#[FieldAccess]
$read: Audience::Internal
$insert: Audience::All
$update: Audience::All

$persistent

protected string|null $persistent = null
Attributes
#[Column]
$name: 'persistent'
$type: 'string'
$length: 20
$nullable: true

$port

protected string|null $port = null
Attributes
#[Column]
$name: 'port'
$type: 'string'
$length: 10
$nullable: true

$secure

protected string|null $secure = null
Attributes
#[Column]
$name: 'secure'
$type: 'string'
$length: 10
$nullable: true

$timeout

protected int|null $timeout = null
Attributes
#[Column]
$name: 'timeout'
$type: 'integer'
$nullable: true

$username

protected string|null $username = null
Attributes
#[Column]
$name: 'username'
$type: 'string'
$length: 100
$nullable: true

$useSmtp

protected bool $useSmtp = true
Attributes
#[Column]
$name: 'use_smtp'
$type: 'boolean'

Methods

__construct()

public __construct([int|null $id = null ][, string|null $emailAddress = null ][, string|null $host = null ][, string|null $username = null ][, string|null $password = null ][, string|null $secure = null ][, string|null $port = null ][, string|null $context = null ][, int|null $timeout = null ][, string|null $persistent = null ][, string|null $clientHost = null ][, bool $useSmtp = true ]) : mixed
Parameters
$id : int|null = null
$emailAddress : string|null = null
$host : string|null = null
$username : string|null = null
$password : string|null = null
$secure : string|null = null
$port : string|null = null
$context : string|null = null
$timeout : int|null = null
$persistent : string|null = null
$clientHost : string|null = null
$useSmtp : bool = true

callInitMethods()

Calls `init{TraitName}()` for every used trait that defines such a method.

public callInitMethods() : void

getAllTraits()

Returns all traits the class uses, including those used by parent classes and nested traits.

public getAllTraits() : array<string, string>
Return values
array<string, string>

getClientHost()

public getClientHost() : string|null
Return values
string|null

getContext()

public getContext() : string|null
Return values
string|null

getEmailAddress()

public getEmailAddress() : string|null
Return values
string|null

getHost()

public getHost() : string|null
Return values
string|null

getPassword()

public getPassword() : string|null
Return values
string|null

getPersistent()

public getPersistent() : string|null
Return values
string|null

getPort()

public getPort() : string|null
Return values
string|null

getSecure()

public getSecure() : string|null
Return values
string|null

getTimeout()

public getTimeout() : int|null
Return values
int|null

getUsername()

public getUsername() : string|null
Return values
string|null

getUseSmtp()

public getUseSmtp() : bool
Return values
bool

setClientHost()

public setClientHost(string|null $clientHost) : $this
Parameters
$clientHost : string|null
Return values
$this

setContext()

public setContext(string|null $context) : $this
Parameters
$context : string|null
Return values
$this

setEmailAddress()

public setEmailAddress(string|null $emailAddress) : $this
Parameters
$emailAddress : string|null
Return values
$this

setHost()

public setHost(string|null $host) : $this
Parameters
$host : string|null
Return values
$this

setId()

public setId(int|null $id) : $this
Parameters
$id : int|null
Return values
$this

setPassword()

public setPassword(string|null $password) : $this
Parameters
$password : string|null
Return values
$this

setPersistent()

public setPersistent(string|null $persistent) : $this
Parameters
$persistent : string|null
Return values
$this

setPort()

public setPort(string|null $port) : $this
Parameters
$port : string|null
Return values
$this

setSecure()

public setSecure(string|null $secure) : $this
Parameters
$secure : string|null
Return values
$this

setTimeout()

public setTimeout(int|null $timeout) : $this
Parameters
$timeout : int|null
Return values
$this

setUsername()

public setUsername(string|null $username) : $this
Parameters
$username : string|null
Return values
$this

setUseSmtp()

public setUseSmtp(bool $useSmtp) : $this
Parameters
$useSmtp : bool
Return values
$this

getTraitsRecursive()

Walks the trait list recursively and collects nested traits too.

private static getTraitsRecursive(array<string, string> $traits) : array<string, string>
Parameters
$traits : array<string, string>
Return values
array<string, string>
On this page

Search results