PHP Class AppserverIo\Appserver\Core\Api\Node\DatabaseNode

See link: https://github.com/appserver-io/appserver
See link: http://www.appserver.io
Author: Tim Wagner ([email protected])
Inheritance: extends AppserverIo\Description\Api\Node\AbstractNode, implements AppserverIo\Appserver\Core\Api\Node\DatabaseNodeInterface
Show file Open project: appserver-io/appserver

Protected Properties

Property Type Description
$charset AppserverIo\Appserver\Core\Api\Node\CharsetNode The database charset information.
$databaseHost AppserverIo\Appserver\Core\Api\Node\DatabaseHostNode The database host information.
$databaseName AppserverIo\Appserver\Core\Api\Node\DatabaseNameNode The database name information.
$databasePort AppserverIo\Appserver\Core\Api\Node\DatabasePortNode The database port information.
$driver AppserverIo\Appserver\Core\Api\Node\DriverNode The database driver information.
$driverOptions AppserverIo\Appserver\Core\Api\Node\DriverOptionsNode The database driver options.
$memory AppserverIo\Appserver\Core\Api\Node\MemoryNode The flag to run Sqlite in memory (mutually exclusive with the path option).
$password AppserverIo\Appserver\Core\Api\Node\PasswordNode The database password information.
$path AppserverIo\Appserver\Core\Api\Node\PathNode The database path information (when using sqlite for example).
$platform AppserverIo\Appserver\Core\Api\Node\PlatformNode The DB platform.
$serverVersion AppserverIo\Appserver\Core\Api\Node\ServerVersionNode The server version we want to connect to.
$unixSocket AppserverIo\Appserver\Core\Api\Node\UnixSocketNode The name of the socket used to connect to the database.
$user AppserverIo\Appserver\Core\Api\Node\UserNode The database user information.

Public Methods

Method Description
getCharset ( ) : AppserverIo\Appserver\Core\Api\Node\CharsetNode Returns the database charset to use.
getDatabaseHost ( ) : AppserverIo\Appserver\Core\Api\Node\DatabaseHostNode Returns the database host information.
getDatabaseName ( ) : AppserverIo\Appserver\Core\Api\Node\DatabaseNameNode Returns the database name information.
getDatabasePort ( ) : AppserverIo\Appserver\Core\Api\Node\DatabasePortNode Returns the database port information.
getDriver ( ) : AppserverIo\Appserver\Core\Api\Node\DriverNode Returns the database driver information.
getDriverOptions ( ) : AppserverIo\Appserver\Core\Api\Node\DriverOpionsNode Returns the database driver options.
getMemory ( ) : AppserverIo\Appserver\Core\Api\Node\PathNode Returns the flag to run Sqlite in memory (mutually exclusive with the path option).
getPassword ( ) : AppserverIo\Appserver\Core\Api\Node\PasswordNode Returns the database password information.
getPath ( ) : AppserverIo\Appserver\Core\Api\Node\PathNode Returns the database path information (when using sqlite for example).
getPlatform ( ) : AppserverIo\Appserver\Core\Api\Node\PlatformNode Returns the DB platform.
getServerVersion ( ) : AppserverIo\Appserver\Core\Api\Node\ServerVersionNode Returns the server version we want to connect to.
getUnixSocket ( ) : AppserverIo\Appserver\Core\Api\Node\UnixSocketNode Returns the name of the socket used to connect to the database.
getUser ( ) : AppserverIo\Appserver\Core\Api\Node\UserNode Returns the database user information.

Method Details

getCharset() public method

Returns the database charset to use.
public getCharset ( ) : AppserverIo\Appserver\Core\Api\Node\CharsetNode
return AppserverIo\Appserver\Core\Api\Node\CharsetNode The database charset

getDatabaseHost() public method

Returns the database host information.
public getDatabaseHost ( ) : AppserverIo\Appserver\Core\Api\Node\DatabaseHostNode
return AppserverIo\Appserver\Core\Api\Node\DatabaseHostNode The database host information

getDatabaseName() public method

Returns the database name information.
public getDatabaseName ( ) : AppserverIo\Appserver\Core\Api\Node\DatabaseNameNode
return AppserverIo\Appserver\Core\Api\Node\DatabaseNameNode The database name information

getDatabasePort() public method

Returns the database port information.
public getDatabasePort ( ) : AppserverIo\Appserver\Core\Api\Node\DatabasePortNode
return AppserverIo\Appserver\Core\Api\Node\DatabasePortNode The database port information

getDriver() public method

Returns the database driver information.
public getDriver ( ) : AppserverIo\Appserver\Core\Api\Node\DriverNode
return AppserverIo\Appserver\Core\Api\Node\DriverNode The database driver information

getDriverOptions() public method

Returns the database driver options.
public getDriverOptions ( ) : AppserverIo\Appserver\Core\Api\Node\DriverOpionsNode
return AppserverIo\Appserver\Core\Api\Node\DriverOpionsNode The database driver options

getMemory() public method

Returns the flag to run Sqlite in memory (mutually exclusive with the path option).
public getMemory ( ) : AppserverIo\Appserver\Core\Api\Node\PathNode
return AppserverIo\Appserver\Core\Api\Node\PathNode The flag to run Sqlite in memory

getPassword() public method

Returns the database password information.
public getPassword ( ) : AppserverIo\Appserver\Core\Api\Node\PasswordNode
return AppserverIo\Appserver\Core\Api\Node\PasswordNode The database password information

getPath() public method

Returns the database path information (when using sqlite for example).
public getPath ( ) : AppserverIo\Appserver\Core\Api\Node\PathNode
return AppserverIo\Appserver\Core\Api\Node\PathNode The database path information

getPlatform() public method

Returns the DB platform.
public getPlatform ( ) : AppserverIo\Appserver\Core\Api\Node\PlatformNode
return AppserverIo\Appserver\Core\Api\Node\PlatformNode The DB platform

getServerVersion() public method

Returns the server version we want to connect to.
public getServerVersion ( ) : AppserverIo\Appserver\Core\Api\Node\ServerVersionNode
return AppserverIo\Appserver\Core\Api\Node\ServerVersionNode The server version to connect to

getUnixSocket() public method

Returns the name of the socket used to connect to the database.
public getUnixSocket ( ) : AppserverIo\Appserver\Core\Api\Node\UnixSocketNode
return AppserverIo\Appserver\Core\Api\Node\UnixSocketNode The name of the socket

getUser() public method

Returns the database user information.
public getUser ( ) : AppserverIo\Appserver\Core\Api\Node\UserNode
return AppserverIo\Appserver\Core\Api\Node\UserNode The database user information

Property Details

$charset protected property

The database charset information.
protected CharsetNode,AppserverIo\Appserver\Core\Api\Node $charset
return AppserverIo\Appserver\Core\Api\Node\CharsetNode

$databaseHost protected property

The database host information.
protected DatabaseHostNode,AppserverIo\Appserver\Core\Api\Node $databaseHost
return AppserverIo\Appserver\Core\Api\Node\DatabaseHostNode

$databaseName protected property

The database name information.
protected DatabaseNameNode,AppserverIo\Appserver\Core\Api\Node $databaseName
return AppserverIo\Appserver\Core\Api\Node\DatabaseNameNode

$databasePort protected property

The database port information.
protected DatabasePortNode,AppserverIo\Appserver\Core\Api\Node $databasePort
return AppserverIo\Appserver\Core\Api\Node\DatabasePortNode

$driver protected property

The database driver information.
protected DriverNode,AppserverIo\Appserver\Core\Api\Node $driver
return AppserverIo\Appserver\Core\Api\Node\DriverNode

$driverOptions protected property

The database driver options.
protected DriverOptionsNode,AppserverIo\Appserver\Core\Api\Node $driverOptions
return AppserverIo\Appserver\Core\Api\Node\DriverOptionsNode

$memory protected property

The flag to run Sqlite in memory (mutually exclusive with the path option).
protected MemoryNode,AppserverIo\Appserver\Core\Api\Node $memory
return AppserverIo\Appserver\Core\Api\Node\MemoryNode

$password protected property

The database password information.
protected PasswordNode,AppserverIo\Appserver\Core\Api\Node $password
return AppserverIo\Appserver\Core\Api\Node\PasswordNode

$path protected property

The database path information (when using sqlite for example).
protected PathNode,AppserverIo\Appserver\Core\Api\Node $path
return AppserverIo\Appserver\Core\Api\Node\PathNode

$platform protected property

The DB platform.
protected PlatformNode,AppserverIo\Appserver\Core\Api\Node $platform
return AppserverIo\Appserver\Core\Api\Node\PlatformNode

$serverVersion protected property

The server version we want to connect to.
protected ServerVersionNode,AppserverIo\Appserver\Core\Api\Node $serverVersion
return AppserverIo\Appserver\Core\Api\Node\ServerVersionNode

$unixSocket protected property

The name of the socket used to connect to the database.
protected UnixSocketNode,AppserverIo\Appserver\Core\Api\Node $unixSocket
return AppserverIo\Appserver\Core\Api\Node\UnixSocketNode

$user protected property

The database user information.
protected UserNode,AppserverIo\Appserver\Core\Api\Node $user
return AppserverIo\Appserver\Core\Api\Node\UserNode