Overview

Namespaces

  • Charcoal
    • Loader
    • Model
      • Service
      • ServiceProvider
    • Source
      • Database
    • Validator

Classes

  • AbstractSource
  • DatabaseSource
  • DatabaseSourceConfig
  • Filter
  • Order
  • Pagination
  • SourceConfig

Interfaces

  • DatabaseSourceInterface
  • FilterInterface
  • OrderInterface
  • PaginationInterface
  • SourceInterface
  • StorableInterface

Traits

  • StorableTrait
  • Overview
  • Namespace
  • Class

Class DatabaseSourceConfig

Charcoal\Config\AbstractConfig
Extended by Charcoal\Source\SourceConfig
Extended by Charcoal\Source\DatabaseSourceConfig
Namespace: Charcoal\Source
Located at Charcoal/Source/DatabaseSourceConfig.php
Methods summary
public array
# defaults( )

Returns

array

Overrides

Charcoal\Source\SourceConfig::defaults()
public Charcoal\Source\DatabaseSourceConfig
# setHostname( string $hostname )

Set hostname

Set hostname

Parameters

$hostname
The database hostname.

Returns

Charcoal\Source\DatabaseSourceConfig
Chainable

Throws

InvalidArgumentException
If hostname is not a string.
public string
# hostname( )

Get hostname

Get hostname

Returns

string
public Charcoal\Source\DatabaseSourceConfig
# setUsername( string $username )

Set username

Set username

Parameters

$username
The database username.

Returns

Charcoal\Source\DatabaseSourceConfig
Chainable

Throws

InvalidArgumentException
If username is not a string.
public string
# username( )

Get username

Get username

Returns

string
public Charcoal\Source\DatabaseSourceConfig
# setPassword( string $password )

Set password

Set password

Parameters

$password
The database password.

Returns

Charcoal\Source\DatabaseSourceConfig
Chainable

Throws

InvalidArgumentException
If password is not a string.
public string
# password( )

Get password

Get password

Returns

string
public Charcoal\Source\DatabaseSourceConfig
# setDatabase( string $database )

Set database

Set database

Parameters

$database
The database name.

Returns

Charcoal\Source\DatabaseSourceConfig
Chainable

Throws

InvalidArgumentException
If database is not a string.
public string
# database( )

Get database

Get database

Returns

string
public Charcoal\Source\DatabaseSourceConfig
# setDisableUtf8( boolean $disableUtf8 )

Parameters

$disableUtf8
The "disable UTF8" flag.

Returns

Charcoal\Source\DatabaseSourceConfig
Chainable
public bools
# disableUtf8( )

Returns

bools
Methods inherited from Charcoal\Source\SourceConfig
setType(), type()
API documentation generated by ApiGen