PHP3 Manual

Stig Sæther Bakken Alexander Aulbach Egon Schmid

Jim Winstead Lars Torben Wilson

Rasmus Lerdorf Zeev Suraski

Edited by

Stig Sæther Bakken

PHP3 Manual

by Stig Sæther Bakken, Alexander Aulbach, Egon Schmid, Jim Winstead, Lars Torben Wilson, Rasmus Lerdorf, and Zeev Suraski

Edited by Stig Sæther Bakken Published 1998-11-13

Copyright

This manual can be redistributed under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

PHP 3.0 is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

PHP 3.0 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

Date: 1998-11-13

Release: 3.0.6

Preface i

About this Manual i

I. Language Reference ............................................................................................................................	2
1. An introduction to PHP3 .............................................................................................................	1
What is PHP3? .......................................................................................................................	1
What can PHP3 do? ...............................................................................................................	1
A Brief History of PHP..........................................................................................................	1
2. PHP3 features ..............................................................................................................................	2
HTTP authentication with PHP..............................................................................................	2
GIF creation with PHP...........................................................................................................	2
File upload support ................................................................................................................	3
HTTP cookie support.............................................................................................................	4
Database support....................................................................................................................	4
Regular expressions ...............................................................................................................	4
Error handling ........................................................................................................................	5
PHP source viewer.................................................................................................................	5
3. Installation ...................................................................................................................................	6
Installing From Source on UNIX...........................................................................................	6

Downloading Source 6

Quick Installation Instructions (Apache Module Version) 6

Database Support Options 7

A custom ODBC library 10

Unified ODBC 10

LDAP 11

Other configure options 11

--with-xml 11

--enable-maintainer-mode 11

--with-system-regex 11

--with-config-file-path 11

--with-exec-dir 11

--disable-debug 12

--enable-safe-mode 12

--enable-track-vars 12

--enable-magic-quotes 12

--enable-debugger 12

--enable-discard-path 12

--enable-bcmath 13

--enable-force-cgi-redirect 13

--disable-short-tags 13

--enable-url-includes 13

--disable-syntax-hl 13

CPPFLAGS and LDFLAGS 14

Installing PHP on Windows95/NT 14

Apache/NT and Stronghold/NT 14

Configuration. 16

The php3.ini file 16

General Configuration Directives 16

Mail Configuration Directives 19

Safe Mode Configuration Directives 19

Debugger Configuration Directives 19

Extension Loading Directives 19

MySQL Configuration Directives 20

mSQL Configuration Directives 20

Postgres Configuration Directives 20

Sybase Configuration Directives 21

Sybase-CT Configuration Directives 21

BC Math Configuration Directives 21

Browser Capability Configuration Directives 21

Unified ODBC Configuration Directives 21

Apache Module 22

Apache module configuration directives 22

CGI redirection module/action module 22

CGI 22

Case 1: only public files served 23

Case 2: using --enable-force-cgi-redirect 23

Case 3: setting doc_root or user_dir 23

Case 4: PHP parser outside of web tree 24

Apache module 24

Syntax and grammar 25

Escaping from HTML 25

Instruction separation 25

Variable types 25

Variable initialization 25

Initializing Arrays 25

Initializing objects 26

Variable Scope 26

Variable variables 27

Variables from outside PHP 28

HTML Forms (GET and POST). 28

IMAGE SUBMIT variable names 28

HTTP Cookies 28

Environment variables 29

Server configuration directives 29

Type juggling 29

Determining variable types 30

Type casting 30

String conversion 30

Array manipulation 31

Language constructs 32

Alternative syntax for IF statements: IF(): ... ENDIF;. 35

Passing by reference 41

Default values 42

OLD_FUNCTION 43

CLASS 43

Expressions 45

Operators 45

Arithmetic Operators 45

String Operators 45

Assignment Operators 45

Bitwise Operators 46

Logical Operators 46

Comparison Operators 46

Precedence 47

Function Reference 48
1. Adabas D Functions 49

Apache Specific Functions 55

Array Functions 60

[BC (Arbitrary Precision) Functions.
74](#bc-arbitrary-precision-functions)

Calendar Functions 79

Date/Time Functions 86

dBase Functions 95

dbase_delete_record 99

dbase_get_record 99

dbase_numfields 100

dbase_numrecords 100

dbm Functions 101

Directory Functions 107

Dynamic Loading Functions 112

dl 114

Program Execution Functions 115

filePro Functions 119

filepro 121

filepro_fieldname 121

filepro_fieldtype 121

filepro_fieldwidth 122

filepro_retrieve 122

filepro_fieldcount 122

filepro_rowcount 123

Filesystem Functions 124

Functions related to HTTP 149

header 151

setcookie 152

Hyperwave functions 153

hw_DocByAnchorObj 161

hw_DocumentAttributes 161

hw_DocumentBodyTag 161

hw_GetChildCollObj 164

hw_GetSrcByDestObj 165

hw_GetObject 165

hw_GetAndLock 165

hw_GetText 166

hw_GetObjectByQuery. 166

hw_GetObjectByQueryObj 167

hw_GetObjectByQueryColl 167

hw_GetObjectByQueryCollObj 167

hw_GetChildDocColl 168

hw_GetChildDocCollObj 168

hw_InsertDocument 171

hw_New_Document 172

hw_Objrec2Array 172

hw_OutputDocument 172

Image functions 175

ImageColorAllocate 179

ImageColorTransparent 179

ImageCopyResized 179

ImageCreate 180

ImageCreateFromGif 180

ImageDashedLine 180

ImageDestroy 181

ImageFill 181

ImageFilledPolygon 181

ImageFilledRectangle 182

ImageFillToBorder 182

ImageColorClosest 190

ImageColorExact 190

ImageColorResolve. 191

ImageColorSet 191

ImageColorsForIndex 191

ImageColorsTotal 192

IMAP Functions 193

imap_createmailbox 196

imap_delete 197

imap_deletemailbox 197

imap_expunge 197

imap_fetchbody 198

imap_fetchstructure. 198

imap_header 199

imap_headers 200

imap_listmailbox 200

imap_listsubscribed. 201

imap_renamemailbox 204

imap_mailboxmsginfo 207

imap_rfc822_write_address 207

imap_rfc822_parse_adrlist 208

imap_setflag_full 208

imap_clearflag_full 208

imap_sort 209

imap_fetchheader 209

imap_uid 210

PHP options & information 211

Informix Functions 219

ifx_affected_rows 229

ifx_fetch_row 230

ifx_htmltbl_result 231

ifx_fieldtypes 232

ifx_fieldproperties 232

ifx_blobinfile_mode 237

ifx_textasvarchar 237

ifx_byteasvarchar 237

ifx_nullformat 238

ifxus_create_slob 238

InterBase Functions 241

ibase_free_result 244

LDAP Functions 246

ldap_count_entries 252

ldap_delete 252

ldap_dn2ufn 252

ldap_explode_dn 253

ldap_first_attribute 253

ldap_first_entry 254

ldap_free_result 254

ldap_get_attributes 255

ldap_next_attribute 258

Mail Functions 261

mail 263

Mathematical Functions 264

Miscellaneous Functions 277

register_shutdown_function 280

mSQL Functions 284

msql_fetch_object 290

MySQL Functions 300

mysql_affected_rows 302

mysql_fetch_array 306

mysql_fetch_field 307

mysql_fetch_lengths 308

mysql_fetch_object 308

mysql_fetch_row 309

mysql_field_name 309

mysql_field_seek 310

mysql_field_table 310

mysql_field_type. 310

mysql_field_flags 311

mysql_field_len 311

mysql_free_result 312

mysql_insert_id 312

mysql_list_fields 312

mysql_list_dbs 313

mysql_list_tables 313

Sybase Functions 317

sybase_affected_rows 319

sybase_close 319

sybase_connect 320

sybase_data_seek 320

sybase_fetch_array 321

sybase_fetch_field. 321

sybase_fetch_object 322

sybase_fetch_row 322

sybase_field_seek 323

sybase_free_result 323

sybase_num_fields 323

Network Functions 327

fsockopen 329

set_socket_blocking 330

ODBC Functions 334

Oracle functions 346

PDF functions 355

PDF_get_info 357

PDF_set_info_creator 357

PDF_set_info_title 358

PDF_set_info_subject 358

PDF_set_info_keywords 359

PDF_set_info_author 359

PDF_set_text_rendering 362

PDF_set_horiz_scaling 363

PDF_set_text_rise 363

PDF_set_text_matrix 363

PDF_set_text_pos 364

PDF_set_char_spacing 364

PDF_set_word_spacing 364

PDF_continue_text 365

PDF_setmiterlimit 368

PDF_closepath_stroke 372

PDF_fill 372

PDF_fill_stroke 372

PDF_closepath_fill_stroke 373

PDF_endpath 373

PDF_clip 373

PDF_setgray_fill 374

PDF_setgray_stroke 374

PDF_setgray 374

PDF_setrgbcolor_fill. 375

PDF_setrgbcolor_stroke 375

PDF_setrgbcolor 375

PDF_add_outline 376

PDF_set_transition 376

PDF_set_duration 376

PostgreSQL functions 377

Regular expression functions 394

Solid Functions 400

SNMP Functions 405

snmpget 407

snmpwalk 407

String functions 408

AddSlashes 410

Chop 410

Chr 410

convert_cyr_string 411

quoted_printable_decode 418

URL functions 432

Variable functions 437

Gz-file Functions 445

XL. XML Parser Functions 454

xml_parser_create 464

xml_set_element_handler 465

xml_set_character_data_handler 466

xml_set_processing_instruction_handler 467

xml_set_default_handler 468

xml_set_unparsed_entity_decl_handler 469

xml_set_notation_decl_handler 470

xml_set_external_entity_ref_handler 471

xml_parse 472

xml_get_error_code 472

xml_error_string 473

xml_get_current_line_number 474

xml_get_current_column_number 474

xml_get_current_byte_index 474

xml_parser_free 474

xml_parser_set_option 475

xml_parser_get_option 476

utf8_decode 476

utf8_encode 477

Appendixes 478

0. Migrating from PHP/FI 2.0 to PHP 3.0 479

About the incompatbilities in 3.0 479

Error messages have changed 481

Short-circuited boolean evaluation 481

Function true/false return values 482

Other incompatibilities 482

0. PHP development 484

Adding functions to PHP3 484

Function Prototype 484

Function Arguments 484

Variable Function Arguments 484

Using the Function Arguments 485

Memory Management in Functions 486

Setting Variables in the Symbol Table 486

Returning simple values 488

Returning complex values 489

Using the resource list 490

Using the persistent resource table 491

Adding runtime configuration directives 492

Calling User Functions 492

HashTable *function_table 493

pval *object 493

pval *function_name 493

Hitchhiker's guide to PHP internals 494

The PHP Debugger 495

Using the Debugger 495

Debugger Protocol 495

7-1. Arithmetic Operators 45

7-2. Bitwise Operators 46

7-3. Logical Operators 46

7-4. Comparson Operators 46

Calendar modes 84

1. Calendar week modes 85

1. Font file format 184

1. error_log log types 213

1. error_reporting bit values 214

1. LONGVARBINARY handling 337

1. XML parser options 475

1. UTF-8 encoding 477

0-1. PHP Internal Types 485

0-2. Debugger Error Types 496

2-1. HTTP Authentication example 2

2-2. GIF creation with PHP 3

2-3. File Upload Form. 3

2-4. Regular expression examples 4

5-1. Ways of escaping from HTML 25

5-2. SetCookie Example 29

1. GetAllHeaders() Example 58

1. array example 62

1. array_walk example 62

1. arsort example 63

1. asort example 64

each() examples 65
Traversing $HTTP_POST_VARS with each() 66

1. ksort example 67

1. list example 68

1. rsort example 70

1. sort example 71

1. uksort example 72

1. usort example 73

1. Calendar functions 81

date example 89
date and mktime example 90

1. strftime example 92

1. gmdate example 93

1. mktime example 93

1. Creating a dBase database file 97

1. Using dbase_numfields 100

1. Visiting every key/value pair in a dbm database. 105

1. Dir() Example 109

1. basename example 126

1. copy example 128

1. dirname example 129

1. fopen() example 136

1. tempnam() example. 147

1. SetCookie examples 152

GetImageSize 177
GetImageSize returning IPTC 177

1. ImageTTFText 189

1. error_log examples 213

1. getlastmod() example 215

1. phpversion() example 217

1. Setting an Environment Variable 218

1. Connect to a Informix database. 222

1. Closing a Informix connection 223

Show all rows of the "orders" table as a html table 224
Insert some values into the "catalog" table 225

1. Informix affected rows 229

1. Informix fetch rows 230

1. Informix results as HTML table 231

1. Fielnames and SQL fieldtypes 232

1. Informix SQL fieldproperties 232

1. Complete example with authenticated bind 250

Sending mail. 263
Sending mail with extra headers 263

1. base_convert() 267

1. eval() example - simple text merge 279

1. serialize example 281

1. unserialize example 282

1. msql_tablename() example 299

1. mysql fetch array. 306

1. mysql field types 310

1. mysql_tablename() example 316

1. fsockopen example 329

1. PDF_get_info 357

1. PDF_get_info 366

1. pg_cmdtuples 380

1. PostgreSQL fetch array 383

1. Postgres fetch object 384

1. Postgres fetch row 385

1. ereg() example 396

1. ereg_replace() example 397

1. split() example 398

1. sql_regcase() example 399

1. chop() example 410

1. chr() example 410

1. explode() example 413

1. implode() example 415

1. ord() example 416

1. Using parse_str 417

rawurlencode() example 1 419
rawurlencode() example 2 419

1. Soundex Examples 421

1. sprintf: zero-padded integers 423

1. strrchr() example 426

1. strtok() example 427

1. strtr() example 429

1. urldecode() example 434

1. urlencode() example 435

gzopen() example 449

0-1. Migration: old start/end tags 479

0-2. Migration: first new start/end tags 479

0-3. Migration: second new start/end tags 479

0-4. Migration: third new start/end tags 480

0-5. Migration: old if..endif syntax 480

0-6. Migration: new if..endif syntax 480

0-7. Migration: old while..endwhile syntax 480

0-8. Migration: new while..endwhile syntax 480

0-9. Migration from 2.0: return values, old code 482

0-10. Migration from 2.0: return values, new code 482

0-11. Migration from 2.0: concatenation for strings 482

0-1. Fetching function arguments 484

0-2. Variable function arguments 485

0-3. Checking whether $foo exists in a symbol table. 486

0-4. Finding a variable's size in a symbol table. 486

0-5. Initializing a new array 487

0-6. Adding entries to a new array 487

0-7. Adding a new resource 490

0-8. Using an existing resource 490

0-9. Deleting an existing resource 490

0-1. Example Debugger Message 497

Preface

PHP Version 3.0 is an HTML-embedded scripting language. Much of its syntax is borrowed from C, Java and Perl with a couple of unique PHP-specific features thrown in. The goal of the language is to allow web developers to write dynamically generated pages quickly.

About this Manual

This manual is written in SGML using the DocBook DTD, using DSSSL (Document Style and Semantics Specification Language) for formatting. The tools used for formatting HTML, TeX and RTF versions are Jade, written by James Clark and The Modular DocBook Stylesheets written by Norman Walsh. PHP3's documentation framework was assembled by Stig Sæther Bakken.