Aplus Framework Docs
DropTable
extends Statement
in package
Class DropTable.
Tags
Table of Contents
- $database : Database
- $sql : array<string|int, mixed>
- SQL clauses and parts.
- __construct() : mixed
- Statement constructor.
- __toString() : string
- commentToSave() : static
- ifExists() : static
- renderWait() : string|null
- reset() : static
- Resets SQL clauses and parts.
- run() : int|string
- Runs the DROP TABLE statement.
- sql() : string
- Renders the SQL statement.
- table() : static
- temporary() : static
- wait() : static
- renderCommentToSave() : string|null
- renderIfExists() : string|null
- renderTables() : string
- renderTemporary() : string|null
Properties
$database
protected
Database
$database
$sql
SQL clauses and parts.
protected
array<string|int, mixed>
$sql
= []
Methods
__construct()
Statement constructor.
public
__construct(Database $database) : mixed
Parameters
- $database : Database
Return values
mixed —__toString()
public
__toString() : string
Return values
string —commentToSave()
public
commentToSave(string $comment) : static
Parameters
- $comment : string
Return values
static —ifExists()
public
ifExists() : static
Return values
static —renderWait()
public
renderWait() : string|null
Return values
string|null —reset()
Resets SQL clauses and parts.
public
reset([string|null $sql = null ]) : static
Parameters
- $sql : string|null = null
-
A part name or null to reset all
Tags
Return values
static —run()
Runs the DROP TABLE statement.
public
run() : int|string
Return values
int|string —The number of affected rows
sql()
Renders the SQL statement.
public
sql() : string
Return values
string —table()
public
table(string $table, string ...$tables) : static
Parameters
- $table : string
- $tables : string
Return values
static —temporary()
public
temporary() : static
Return values
static —wait()
public
wait(int $seconds) : static
Parameters
- $seconds : int
Return values
static —renderCommentToSave()
protected
renderCommentToSave() : string|null
Return values
string|null —renderIfExists()
protected
renderIfExists() : string|null
Return values
string|null —renderTables()
protected
renderTables() : string
Return values
string —renderTemporary()
protected
renderTemporary() : string|null