PHP Class Pastie_Driver_Sql, horde

Required values for $params:

'phptype' - The database type (e.g. 'pgsql', 'mysql', etc.).
'table' - The name of the foo table in 'database'.
'charset' - The database's internal charset.

Required by some database implementations:

'database' - The name of the database.
'hostspec' - The hostname of the database server.
'protocol' - The communication protocol ('tcp', 'unix', etc.).
'username' - The username with which to connect to the database.
'password' - The password associated with 'username'.
'options' - Additional options to pass to the database.
'tty' - The TTY on which to connect to the database.
'port' - The port on which to connect to the database.

The table structure can be created by the scripts/sql/pastie.sql script. Copyright 2007-2016 Horde LLC (http://www.horde.org/) See the enclosed file LICENSE for license information (BSD). If you did not receive this file, see http://www.horde.org/licenses/bsd.

Author: Ben Klang ([email protected])

Inheritance: extends Pastie_Driver

Show file Open project: horde/horde

Protected Properties

Property	Type	Description
$_connected	boolean	Boolean indicating whether or not we're connected to the SQL server.
$_db	DB	Handle for the current database connection.
$_params	array	Hash containing connection parameters.
$_write_db	DB	Handle for the current database connection, used for writing. Defaults to the same handle as $_db if a separate write database is not required.

Public Methods

Method	Description
__construct ( array $params = [] )	Constructs a new SQL storage object.
getPaste ( array $params ) : array	Retrieves the paste from the database.
getPastes ( $bin, $limit = null, $start = null )
savePaste ( $bin, $paste, $syntax = 'none', $title = '' )

Protected Methods

Method	Description
_connect ( )	Attempts to open a persistent connection to the SQL server.
_disconnect ( )	Disconnects from the SQL server and cleans up the connection.

Method Details

__construct() public method

Constructs a new SQL storage object.

public __construct ( array $params = [] )
$params	array	A hash containing connection parameters.

_connect() protected method

Attempts to open a persistent connection to the SQL server.

protected _connect ( )

_disconnect() protected method

Disconnects from the SQL server and cleans up the connection.

protected _disconnect ( )

getPaste() public method

Retrieves the paste from the database.

public getPaste ( array $params ) : array
$params	array	Array of selectors to find the paste.
return	array	Array of paste information

getPastes() public method

public getPastes ( $bin, $limit = null, $start = null )

savePaste() public method

public savePaste ( $bin, $paste, $syntax = 'none', $title = '' )

Property Details

$_connected protected property

Boolean indicating whether or not we're connected to the SQL server.

protected bool $_connected
return	boolean

$_db protected property

Handle for the current database connection.

protected DB $_db
return	DB

$_params protected property

Hash containing connection parameters.

protected array $_params
return	array

$_write_db protected property

Handle for the current database connection, used for writing. Defaults to the same handle as $_db if a separate write database is not required.

protected DB $_write_db
return	DB