Class: Doctrine_Expression_Pgsql

Source Location: /Doctrine/Expression/Pgsql.php

Class Doctrine_Expression_Pgsql

Class Overview
Class Overview | Inherited Properties, Constants, and Methods | Properties | Method Summary | Methods Detail

Doctrine_Expression_Pgsql

Located in /Doctrine/Expression/Pgsql.php [line 33] 

Doctrine_Connection_Module
   |
   --Doctrine_Expression_Driver
      |
      --Doctrine_Expression_Pgsql
Author(s): Information Tags:
Version:  $Revision: 2276 $
Link:  www.phpdoctrine.com
Since:  1.0
License:  LGPL

Methods
[ Top ]
Inherited Properties, Constants, and Methods
Class Overview | | Inherited Properties, Constants, and Methods | Properties | Method Summary | Methods Detail
Inherited Properties Inherited Methods Inherited Constants

Inherited From Doctrine_Connection_Module

Doctrine_Connection_Module::$conn
Doctrine_Connection_Module::$moduleName

Inherited From Doctrine_Expression_Driver

Doctrine_Expression_Driver::acos()
returns arcus cosine SQL string
Doctrine_Expression_Driver::add()
Returns the SQL to add values or expressions together.
Doctrine_Expression_Driver::avg()
Returns the average value of a column
Doctrine_Expression_Driver::basicMath()
Returns the SQL to perform the same mathematical operation over an array of values or expressions.
Doctrine_Expression_Driver::between()
Returns SQL that checks if an expression evaluates to a value between two values.
Doctrine_Expression_Driver::concat()
Returns a series of strings concatinated
Doctrine_Expression_Driver::count()
Returns the number of rows (without a NULL value) of a column
Doctrine_Expression_Driver::div()
Returns the SQL to divide values or expressions by eachother.
Doctrine_Expression_Driver::eq()
Returns the SQL to check if two values are equal.
Doctrine_Expression_Driver::getIdentifier()
Doctrine_Expression_Driver::getIdentifiers()
Doctrine_Expression_Driver::gt()
Returns the SQL to check if one value is greater than another value.
Doctrine_Expression_Driver::gte()
Returns the SQL to check if one value is greater than or equal to another value.
Doctrine_Expression_Driver::guid()
Returns global unique identifier
Doctrine_Expression_Driver::in()
Returns the SQL to check if a value is one in a set of given values..
Doctrine_Expression_Driver::isNotNull()
Returns SQL that checks if a expression is not null.
Doctrine_Expression_Driver::isNull()
Returns SQL that checks if a expression is null.
Doctrine_Expression_Driver::length()
Returns the length of a text field.
Doctrine_Expression_Driver::locate()
locate returns the position of the first occurrence of substring $substr in string $str
Doctrine_Expression_Driver::lower()
lower Returns the string $str with all characters changed to lowercase according to the current character set mapping.
Doctrine_Expression_Driver::lt()
Returns the SQL to check if one value is less than another value.
Doctrine_Expression_Driver::lte()
Returns the SQL to check if one value is less than or equal to another value.
Doctrine_Expression_Driver::ltrim()
ltrim returns the string $str with leading space characters removed
Doctrine_Expression_Driver::max()
Returns the highest value of a column
Doctrine_Expression_Driver::md5()
Returns the md5 sum of a field.
Doctrine_Expression_Driver::min()
Returns the lowest value of a column
Doctrine_Expression_Driver::mod()
Returns the remainder of the division operation $expression1 / $expression2.
Doctrine_Expression_Driver::mul()
Returns the SQL to multiply values or expressions by eachother.
Doctrine_Expression_Driver::neq()
Returns the SQL to check if two values are unequal.
Doctrine_Expression_Driver::not()
Returns the SQL for a logical not.
Doctrine_Expression_Driver::now()
Returns the current system date.
Doctrine_Expression_Driver::regexp()
regexp returns the regular expression operator
Doctrine_Expression_Driver::round()
Rounds a numeric field to the number of decimals specified.
Doctrine_Expression_Driver::rtrim()
rtrim returns the string $str with proceeding space characters removed
Doctrine_Expression_Driver::soundex()
soundex Returns a string to call a function to compute the soundex encoding of a string
Doctrine_Expression_Driver::sub()
Returns the SQL to subtract values or expressions from eachother.
Doctrine_Expression_Driver::substring()
return string to call a function to get a substring inside an SQL statement
Doctrine_Expression_Driver::sum()
Returns the total sum of a column
Doctrine_Expression_Driver::trim()
trim returns the string $str with leading and proceeding space characters removed
Doctrine_Expression_Driver::upper()
upper Returns the string $str with all characters changed to uppercase according to the current character set mapping.
Doctrine_Expression_Driver::__call()
__call

Inherited From Doctrine_Connection_Module

Doctrine_Connection_Module::__construct()
Doctrine_Connection_Module::getConnection()
getConnection returns the connection object this module uses
Doctrine_Connection_Module::getModuleName()
getModuleName returns the name of this module

[ Top ]
Method Summary
Class Overview | Inherited Properties and Methods | Properties Method Summary | Methods Detail
string   age()   PostgreSQLs AGE(<timestamp1> [, <timestamp2>]) function.
void   concat()  
string   date_part()   PostgreSQLs DATE_PART( <text>, <time> ) function.
string   matchPattern()   build a pattern matching string
string   md5()   Returns the md5 sum of a field.
string   now()   Returns the SQL string to return the current system date and time.
return   random()   return string to call a function to get random value inside an SQL statement
string   regexp()   regexp
string   substring()   Returns part of a string.

[ Top ]
Properties
Class Overview | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
Methods
Class Overview | Inherited Properties and Methods | | Properties | Method Summary | Methods Detail
age  [line 104]

  string age( string $timestamp1, [string $timestamp2 = null]  )

PostgreSQLs AGE(<timestamp1> [, <timestamp2>]) function.

Parameters:
string   $timestamp1:  timestamp to subtract from NOW()
string   $timestamp2:  optional; if given: subtract arguments

API Tags:
Access:  public


[ Top ]
concat  [line 123]

  void concat( )


API Tags:
Access:  public

Redefinition of:
Doctrine_Expression_Driver::concat()
Returns a series of strings concatinated

[ Top ]
date_part  [line 118]

  string date_part( string $text, string $time  )

PostgreSQLs DATE_PART( <text>, <time> ) function.

Parameters:
string   $text:  what to extract
string   $time:  timestamp or interval to extract from

API Tags:
Access:  public


[ Top ]
matchPattern  [line 174]

  string matchPattern( array $pattern, [string $operator = null], [string $field = null]  )

build a pattern matching string

EXPERIMENTAL

WARNING: this function is experimental and may change signature at any time until labelled as non-experimental

 Parameters:
array   $pattern:  even keys are strings, odd are patterns (% and _)
string   $operator:  optional pattern operator (LIKE, ILIKE and maybe others in the future)
string   $field:  optional field name that is being matched against (might be required when emulating ILIKE)

API Tags:
Return:  SQL pattern
Access:  public


[ Top ]
md5  [line 53]

  string md5( $column  )

Returns the md5 sum of a field.

Note: Not SQL92, but common functionality

md5() works with the default PostgreSQL 8 versions.

If you are using PostgreSQL 7.x or older you need to make sure that the digest procedure is installed. If you use RPMS (Redhat and Mandrake) install the postgresql-contrib package. You must then install the procedure by running this shell command:

  1.  psql [dbname] < /usr/share/pgsql/contrib/pgcrypto.sql
You should make sure you run this as the postgres user.

 Parameters:
   $column: 

API Tags:
Access:  public

Redefinition of:
Doctrine_Expression_Driver::md5()
Returns the md5 sum of a field.

[ Top ]
now  [line 134]

  string now( )

Returns the SQL string to return the current system date and time.


API Tags:
Access:  public

Redefinition of:
Doctrine_Expression_Driver::now()
Returns the current system date.

[ Top ]
random  [line 153]

  return random( )

return string to call a function to get random value inside an SQL statement


API Tags:
Return:  string to generate float between 0 and 1
Access:  public


[ Top ]
regexp  [line 143]

  string regexp( )

regexp


API Tags:
Return:  the regular expression operator
Access:  public

Redefinition of:
Doctrine_Expression_Driver::regexp()
regexp returns the regular expression operator

[ Top ]
substring  [line 74]

  string substring( string $value, int $from, [int $len = null]  )

Returns part of a string.

Note: Not SQL92, but common functionality.

 Parameters:
string   $value:  the target $value the string or the string column.
int   $from:  extract from this characeter.
int   $len:  extract this amount of characters.

API Tags:
Return:  sql that extracts part of a string.
Access:  public

Redefinition of:
Doctrine_Expression_Driver::substring()
return string to call a function to get a substring inside an SQL statement

[ Top ]