Docs For Class RewriteBaseRule

## Class RewriteBaseRule

Description

Located in /rewriteengine.php (line 26)

Variable Summary
array $caps
array $errors
array $info
array $messages
array $plan
array $warnings
Method Summary
static boolean has_capability (string $cap)
static boolean is_select (array $parsed)
static string remove_comments (string $sql)
static array _ENTRY (string|array $s, array $t, array $p, array $settings, [string $RULE = 'RewriteBaseRule'])
RewriteBaseRule __construct ([ $settings = array()])
array rewrite (string|array $sql, array $table_info, [array $process_info = null], [array $settings = null])
boolean set_capability (string $cap, string $value)
Variables
array $caps = array () (line 59)

Capability list

- access: protected

array $errors = array() (line 51)

Errors

array $info = array() (line 41)

Information messages (like notices)

array $messages = array() (line 31)

A place for optimizer messages like explain plans.

array $plan = array() (line 46)

Query plan (array of queries that represents a DAG)

array $warnings = array() (line 36)
Methods
static method has_capability (line 149)

This static function returns the requested capabilitity

static boolean has_capability (string $cap)

- string $cap

static method is_select (line 140)

This static function returns true when a parsed query is SELECT only, with no CREATE or INSERT, etc associated with it.

static boolean is_select (array $parsed)

- array $parsed

static method remove_comments (line 131)

This static function can be used by rules to remove comments.

static string remove_comments (string $sql)

- string $sql

static method _ENTRY (line 98)

This static function is used as the entry point for execution in most cases. Returns a DAG.

Specify a SUBCLASS in RULE to rewrite a query. Default is to not subclass which returns the same query as input.

static array _ENTRY (string|array $s, array $t, array $p, array $settings, [string $RULE = 'RewriteBaseRule'])

- string|array $s
- array $t
- array $p
- array $settings
- string $RULE

Constructor __construct (line 67)

- access: public

RewriteBaseRule __construct ([ $settings = array()])

- $settings

rewrite (line 82)

Rewrite a query returing a DAG

- access: public

array rewrite (string|array $sql, array $table_info, [array $process_info = null], [array $settings = null])

- string|array $sql
- array $table_info
- array $process_info
- array $settings

set_capability (line 159)

This static function sets the given capabilitity to the given value

- access: protected

boolean set_capability (string $cap, string $value)

- string $cap
- string $value

Documentation generated on Sun, 10 Nov 2013 03:41:49 -0800 by phpDocumentor 1.4.3