PEAR Manual
Prev		Next

DB_common::quoteIdentifier()

DB_common::quoteIdentifier() -- Format string so it can be safely used as an identifier

Synopsis

string DB::quoteIdentifier (string $str)

Description

Format input so it can be safely used as a delimited identifier in a query. Identifiers are objects such as table or column names.

The format returned depends on the database type being used.

Delimited identifiers are known to generally work correctly under the following drivers:

mssql

mysql

mysqli

oci8

odbc(access)

odbc(db2)

pgsql

sqlite

sybase

InterBase doesn't seem to be able to use delimited identifiers via PHP 4. They work fine under PHP 5.

Parameter

string $str: the input to be quoted

Return value

string - the formatted string

Note

This function can not be called statically.

Function available since: Release 1.6.0

Warning

Just because you CAN use delimited identifiers doesn't mean you SHOULD use them. In general, they end up causing way more problems than they solve.

Portability is broken by using the following characters inside delimited identifiers:

backtick (`) -- due to MySQL

double quote (") -- due to Oracle

brackets ([ or ]) -- due to Access

Example

Example 21-1. Using quoteIdentifier()

<?php // Once you have a valid DB object named $db... $sql = 'SELECT ' . $db->quoteIdentifier('company name')        . ', address FROM clients';  $result =& $db->query($sql); ?>

See

quoteSmart()

Prev	Home	Next
DB_common::quote()	Up	DB_common::quoteSmart()

Who's Online
Guest Users: 14

Free Sample Chapters
	Deliver First Class Web Sites: 101 Essential Checklists Want to learn how to make your web sites usable and accessible? Want to ensure that your sites meet current best practice, without spending hours trawling through incomprehensible specifications and recommendations from dozens of different books, research papers, and web sites? Want to make sure that the sites you build are "right the first time," requiring no costly redevelopments?
More Sample Chapters

PHP General