PHP Manual

https://www.php.net/manual/en/
Admin
The PHP Manual provides comprehensive documentation for PHP, a popular general-purpose scripting...
Tokens:11,619,274
Snippets:90,117
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Create a daemon with PEAR System_Daemon

Source: https://www.php.net/manual/en/ref.pcntl.php

User-contributed example showing how to install and use the PEAR System_Daemon package to create a daemon in PHP. It includes installation via pear install -f system_daemon and a basic script that starts the daemon, runs a loop, and stops it.

```bash
pear install -f system_daemon
```

```php
<?php
// Include PEAR's Daemon Class
require_once "System/Daemon.php";

// Bare minimum setup
System_Daemon::setOption("appName", "mydaemonname");

// Spawn Deamon!
System_Daemon::start();

// Your PHP Here!
while (true) {
    doTask();
}

// Stop daemon!
System_Daemon::stop();
?>
```

--------------------------------

### Create and manage a Windows service with win32 functions

Source: https://www.php.net/manual/en/function.win32-create-service.php

A complete PHP example for creating and managing a Windows service using the win32 service functions. It supports actions (status, install, uninstall, start, stop, run, debug) via GET or CLI arguments, and includes a server loop that handles control messages. The author warns to evaluate the code first and use at your own risk.

```php
[An example of how to create a Windows service.  Evaluate code first and use at your own risk!]

<?php

//No timeouts, Flush Content immediatly
    set_time_limit(0);
    ob_implicit_flush();
    
//Service Settings
    $phpPath = "D:\\php\\php5.2.9";
    $ServiceName = 'phpServiceName';
    $ServiceDisplay = 'phpDisplayName';

//Windows Service Control
    $ServiceAction = "status";
    //$ServiceAction = "debug";
    if ( isset($_GET['ServiceAction']) and strlen($_GET['ServiceAction']) ) {
        $ServiceAction = addslashes($_GET['ServiceAction']);
    } else if ( isset($argv) and isset($argv[1]) and strlen($argv[1]) ) {
        $ServiceAction = $argv[1];
    }
    if( $ServiceAction == "status" ) {
        $ServiceStatus = win32_query_service_status($ServiceName);
        if ( $ServiceStatus['CurrentState'] == WIN32_SERVICE_STOPPED ) {
            echo "Service Stopped\n\n";
        } else if ( $ServiceStatus['CurrentState'] == WIN32_SERVICE_START_PENDING ) {
            echo "Service Start Pending\n\n";
        } else if ( $ServiceStatus['CurrentState'] == WIN32_SERVICE_STOP_PENDING ) {
            echo "Service Stop Pending\n\n";
        } else if ( $ServiceStatus['CurrentState'] == WIN32_SERVICE_RUNNING ) {
            echo "Service Running\n\n";
        } else if ( $ServiceStatus['CurrentState'] == WIN32_SERVICE_CONTINUE_PENDING ) {
            echo "Service Continue Pending\n\n";
        } else if ( $ServiceStatus['CurrentState'] == WIN32_SERVICE_PAUSE_PENDING ) {
            echo "Service Pause Pending\n\n";
        } else if ( $ServiceStatus['CurrentState'] == WIN32_SERVICE_PAUSED ) {
            echo "Service Paused\n\n";
        } else{
            echo "Service Unknown\n\n";
        }
      exit;
    } else if ( $ServiceAction == "install" ) {
    //Install Windows Service
        win32_create_service( Array(
            'service' => $ServiceName,
            'display' => $ServiceDisplay,
            'params' => __FILE__ . " run",
            'path' => $phpPath."\\php.exe",
        ));
        echo "Service Installed\n\n";
        exit;
    } else if ( $ServiceAction == "uninstall" ) {
    //Remove Windows Service
        win32_delete_service($ServiceName);
        echo "Service Removed\n\n";
        exit;
    } else if( $ServiceAction == "start") {
    //Start Windows Service
      win32_start_service($ServiceName);
      echo "Service Started\n\n";
      exit;
    } else if( $ServiceAction == "stop" ) {
    //Stop Windows Service
      win32_stop_service($ServiceName);
      echo "Service Stopped\n\n";
      exit;
    } else if ( $ServiceAction == "run" ) {
    //Run Windows Service
        win32_start_service_ctrl_dispatcher($ServiceName);
        win32_set_service_status(WIN32_SERVICE_RUNNING);
    } else if ( $ServiceAction == "debug" ) {
    //Debug Windows Service
        set_time_limit(10);
    } else {
        exit();
    }

//Server Loop
    while (1) {
    //Handle Windows Service Request
        usleep(100*1000);
        if ( $ServiceAction == "run" ) {
            switch ( win32_get_last_control_message() ) {
                case WIN32_SERVICE_CONTROL_CONTINUE:
                    break;
                case WIN32_SERVICE_CONTROL_INTERROGATE:
                    win32_set_service_status(WIN32_NO_ERROR);
                break;
                case WIN32_SERVICE_CONTROL_STOP:
                    win32_set_service_status(WIN32_SERVICE_STOPPED);
                    exit;
                default:
                    win32_set_service_status(WIN32_ERROR_CALL_NOT_IMPLEMENTED); 
            }
        }
    //User Loop
        sleep(1);
        echo "\n<BR>YOUR CODE HERE";
    }

//Exit
    if ( $ServiceAction == "run" ) {
        win32_set_service_status(WIN32_SERVICE_STOPPED);
    }
    exit();
?>
```

--------------------------------

### Debian Install Example with Apache httpd 2

Source: https://www.php.net/manual/en/install.unix.debian.php

Installs PHP core modules along with the Apache module and CLI using apt. APT automatically installs dependencies and activates the module.

```bash
# apt install php-common libapache2-mod-php php-cli
```

--------------------------------

### Yaf_Session::set() example

Source: https://www.php.net/manual/en/yaf-session.set.php

Shows how to set session values after starting the session in a Yaf controller action. The example verifies credentials, gets the session instance, starts it, sets 'user_id' and 'login_time', then redirects to '/dashboard'.

```php
<?php
class LoginController extends Yaf_Controller_Abstract
{
    public function indexAction()
    {
        // ... verify the credentials against the database
        $session = Yaf_Session::getInstance();
        $session->start();

        $session->set("user_id", $user->getId());
        $session->set("login_time", time());

        return $this->redirect("/dashboard");
    }
}
?>
```

--------------------------------

### Step-by-step Apache and PHP installation on Windows 7

Source: https://www.php.net/manual/en/install.windows.apache2.php

User contributed step-by-step guide for installing Apache and PHP on Windows 7 Home Premium. Covers downloading and installing Apache 2.2.22, testing it, installing PHP 5.3.10 as an Apache module, and testing PHP with a phpinfo() script. Includes specific file paths and browser URLs.

```text
1  In your browser go to h t t p : / / h t t p d . a p a c h e . o r g / d o w n l o a d . c g i
   (without the spaces)
2  Click on  httpd-2.2.22-win32-x86-no_ssl.msi
   (this is a self-installing executable file without crypto ... no Secure Socket Layer)
   (2.2.22 was the latest version on April 25, 2012)
3  Click on the httpd-2.2.22-win32-x86-no_ssl.msi file after it downloads 
   (single click on the file tab in Chrome or double click on the actual file in Downloads)
4  Click Next
5  Click I accept the terms in the license agreement
6  Click Next
7  Click Next
8  Type localhost in the top box
9  Type localhost in the middle box
10 Type admin@localhost.com in the bottom box
11 Click Next
12 Click Next
13 Click Next
14 Click Install and wait
15 Cick Yes to allow the program to make changes
16 Click Finish
```

```text
1  Type localhost in your browser location box (I use Chrome) or type h t t p : / / l o c a l h o s t
   (without the spaces)
2  The message It works! should appear.
```

```text
1  In your browser go to h t t p : / / w i n d o w s . p h p . n e t / d o w n l o a d /
   (without the spaces)
2  Click on the Installer link under PHP 5.3 (5.3.10)   VC9 x86 Thread Safe
   (Ignore the Do NOT use VC9 version with apache.org binaries comment on the side panel)
3  Click on the php-5.3.10-Win32-VC9-x86.msi file after in downloads
   (single click on the file tab in Chrome or double click on the actual file in Downloads)
4  Click Next
5  Click I accept the terms in the License Agreement
6  Click Next
7  Click Next
8  Click Apache 2.2.x Module
9  Click Next
10 Click Browse
11 Double click Apache Software Foundation
12 Double click Apache 2.2
13 Double click conf
14 Click OK
15 Click Next
16 Click Next
17 Click Install and wait
18 Cick Yes to allow the program to make changes
19 Click Finish
```

```text
1  Open Notepad
2  Type 'left bracket character'?php phpinfo(); ?'right bracket character'
3  Save the file to C:\Program Files (x86)\Apache Software Foundation\Apache2.2\htdocs as test.php
4  Type localhost/test.php in your browser location box (I use Chrome) or type h t t p : / / l o c a l h o s t / t e s t . p h p
5  A table with title PHP Version ... should appear
```

--------------------------------

### ibase_backup() example with arguments

Source: https://www.php.net/manual/en/function.ibase-backup.php

ibase_backup() example with arguments: attaches by server name and default port, then starts a backup using a database alias. Passes IBASE_BKP_METADATA_ONLY and IBASE_BKP_NON_TRANSPORTABLE to back up only metadata and create a non-transportable backup.

```php
<?php

// Attach to database server by name and default port
$service = ibase_service_attach ('fb-server.contoso.local', 'sysdba', 'masterkey');

// Start the backup process on database server
// Backup employee database using alias to /srv/backup/employees.fbk.
// Backup only the metadata. Don't create a transportable backup.
ibase_backup($service, 'employees.fdb', '/srv/backup/employees.fbk', IBASE_BKP_METADATA_ONLY | IBASE_BKP_NON_TRANSPORTABLE);

// Free the attached connection
ibase_service_detach ($service);
?>
```

--------------------------------

### Create, get, update, and delete $_SESSION variables

Source: https://www.php.net/manual/en/reserved.variables.session.php

Four PHP examples showing how to create, get, update, and delete a session variable using $_SESSION. Each example starts with session_start() and uses the key "newsession". The delete example uses unset() and notes that using the variable after deletion causes an error.

```php
<?php 
session_start();
/*session is started if you don't write this line can't use $_Session  global variable*/
$_SESSION["newsession"]=$value;
?>
```

```php
<?php 
session_start();
/*session is started if you don't write this line can't use $_Session  global variable*/
$_SESSION["newsession"]=$value;
/*session created*/
echo $_SESSION["newsession"];
/*session was getting*/
?>
```

```php
<?php 
session_start();
/*session is started if you don't write this line can't use $_Session  global variable*/
$_SESSION["newsession"]=$value;
/*it is my new session*/
$_SESSION["newsession"]=$updatedvalue;
/*session updated*/
?>
```

```php
<?php 
session_start();
/*session is started if you don't write this line can't use $_Session  global variable*/
$_SESSION["newsession"]=$value;
unset($_SESSION["newsession"]);
/*session deleted. if you try using this you've got an error*/
?>
```

--------------------------------

### Example output

Source: https://www.php.net/manual/en/mysqli.get-host-info.php

Sample output from the above examples, showing the host info string.

```text
Host info: Localhost via UNIX socket

```

--------------------------------

### VarnishAdmin::__construct() example

Source: https://www.php.net/manual/en/varnishadmin.construct.php

Example of creating a VarnishAdmin instance with configuration arguments including host, port, secret, and timeout.

```php
<?php
    $args = array(
        VARNISH_CONFIG_HOST => "::1",
        VARNISH_CONFIG_PORT => 6082,
        VARNISH_CONFIG_SECRET => "5174826b-8595-4958-aa7a-0609632ad7ca",
        VARNISH_CONFIG_TIMEOUT => 300,
    );
    $va = new VarnishAdmin($args);
?>
```

--------------------------------

### Setup php.ini

Source: https://www.php.net/manual/en/install.unix.apache2.php

Copy the development php.ini file to the installation directory.

```bash
cp php.ini-development /usr/local/lib/php.ini
```

--------------------------------

### Simple HTTP server example

Source: https://www.php.net/manual/en/eventhttp.construct.php

Example #1 shows a complete HTTP server using EventHttp. It sets allowed methods (GET and POST), registers callbacks for '/dump', '/about', and a default callback, binds to port 8010, and starts the event loop. The example includes instructions for testing with netcat and shows expected output.

```php
<?php
/*
 * Simple HTTP server.
 *
 * To test it:
 * 1) Run it on a port of your choice, e.g.:
 * $ php examples/http.php 8010
 * 2) In another terminal connect to some address on this port
 * and make GET or POST request(others are turned off here), e.g.:
 * $ nc -t 127.0.0.1 8010
 * POST /about HTTP/1.0
 * Content-Type: text/plain
 * Content-Length: 4
 * Connection: close
 * (press Enter)
 *
 * It will output
 * a=12
 * HTTP/1.0 200 OK
 * Content-Type: text/html; charset=ISO-8859-1
 * Connection: close
 *
 * $ nc -t 127.0.0.1 8010
 * GET /dump HTTP/1.0
 * Content-Type: text/plain
 * Content-Encoding: UTF-8
 * Connection: close
 * (press Enter)
 *
 * It will output:
 * HTTP/1.0 200 OK
 * Content-Type: text/html; charset=ISO-8859-1
 * Connection: close
 * (press Enter)
 *
 * $ nc -t 127.0.0.1 8010
 * GET /unknown HTTP/1.0
 * Connection: close
 *
 * It will output:
 * HTTP/1.0 200 OK
 * Content-Type: text/html; charset=ISO-8859-1
 * Connection: close
 *
 * 3) See what the server outputs on the previous terminal window.
 */

function _http_dump($req, $data) {
    static $counter      = 0;
    static $max_requests = 2;

    if (++$counter >= $max_requests)  {
        echo "Counter reached max requests $max_requests. Exiting\n";
        exit();
    }

    echo __METHOD__, " called\n";
    echo "request:"; var_dump($req);
    echo "data:"; var_dump($data);

    echo "\n===== DUMP =====\n";
    echo "Command:", $req->getCommand(), PHP_EOL;
    echo "URI:", $req->getUri(), PHP_EOL;
    echo "Input headers:"; var_dump($req->getInputHeaders());
    echo "Output headers:"; var_dump($req->getOutputHeaders());

    echo "\n >> Sending reply ...";
    $req->sendReply(200, "OK");
    echo "OK\n";

    echo "\n >> Reading input buffer ...\n";
    $buf = $req->getInputBuffer();
    while ($s = $buf->readLine(EventBuffer::EOL_ANY)) {
        echo $s, PHP_EOL;
    }
    echo "No more data in the buffer\n";
}

function _http_about($req) {
    echo __METHOD__, PHP_EOL;
    echo "URI: ", $req->getUri(), PHP_EOL;
    echo "\n >> Sending reply ...";
    $req->sendReply(200, "OK");
    echo "OK\n";
}

function _http_default($req, $data) {
    echo __METHOD__, PHP_EOL;
    echo "URI: ", $req->getUri(), PHP_EOL;
    echo "\n >> Sending reply ...";
    $req->sendReply(200, "OK");
    echo "OK\n";
}

$port = 8010;
if ($argc > 1) {
    $port = (int) $argv[1];
}
if ($port <= 0 || $port > 65535) {
    exit("Invalid port");
}

$base = new EventBase();
$http = new EventHttp($base);
$http->setAllowedMethods(EventHttpRequest::CMD_GET | EventHttpRequest::CMD_POST);

$http->setCallback("/dump", "_http_dump", array(4, 8));
$http->setCallback("/about", "_http_about");
$http->setDefaultCallback("_http_default", "custom data value");

$http->bind("0.0.0.0", 8010);
$base->loop();
?>
```

--------------------------------

### Install pthreads on Linux (detailed steps)

Source: https://www.php.net/manual/en/pthreads.installation.php

Detailed steps to install required libraries, download and compile PHP, install pthreads via PECL, and verify the installation.

```text
# Required libraries
sudo apt-get install gcc make libzzip-dev libreadline-dev libxml2-dev \
libssl-dev libmcrypt-dev libcurl4-openssl-dev lib32bz2-dev 

# Download PHP
cd /usr/local/src

wget http://www.php.net/distributions/php-<version>.tar.gz
( e.g. wget http://www.php.net/distributions/php-5.5.8.tar.gz )

# Extract
tar zxvf php-<version>.tar.gz
(e.g. tar zxvf php-5.5.8.tar.gz )

# Configure
cd /usr/local/src/php-<version>
( e.g. cd /usr/local/src/php-5.5.8 )

./configure --prefix=/usr --with-config-file-path=/etc --enable-maintainer-zts

# Compile
make && make install
( make -j3 && make -j3 install) -> Faster building

# Copy configuration
cp php.ini-development /etc/php.ini

# Install pthreads
pecl install pthreads
echo "extension=pthreads.so" >> /etc/php.ini

# Check installation
php -m | grep pthreads
```

--------------------------------

### STDIN STDOUT proc_open example with test.php and test_gen.php

Source: https://www.php.net/manual/en/function.proc-open.php

A complete STDIN/STDOUT example with two files: test.php launches test_gen.php via proc_open and sends commands (start, get, stop) through the pipe, reading responses. test_gen.php is a child process that reads from STDIN and responds accordingly. The example demonstrates bidirectional communication between parent and child processes.

```php
<?php
$descriptorspec = array(
   0 => array("pipe", "r"), 
   1 => array("pipe", "w"), 
   2 => array("pipe", "r")
);
$process = proc_open('php test_gen.php', $descriptorspec, $pipes, null, null); //run test_gen.php
echo ("Start process:\n");
if (is_resource($process)) 
{
    fwrite($pipes[0], "start\n");    // send start
    echo ("\n\nStart ....".fgets($pipes[1],4096)); //get answer
    fwrite($pipes[0], "get\n");    // send get
    echo ("Get: ".fgets($pipes[1],4096));    //get answer
    fwrite($pipes[0], "stop\n");    //send stop
    echo ("\n\nStop ....".fgets($pipes[1],4096));  //get answer

    fclose($pipes[0]);
    fclose($pipes[1]);
    fclose($pipes[2]);
    $return_value = proc_close($process);  //stop test_gen.php
    echo ("Returned:".$return_value."\n");
}
?>
```

```php
<?php
$keys=0;
function play_stop()
{
global $keys;
        $stdin_stat_arr=fstat(STDIN);
        if($stdin_stat_arr[size]!=0)
        {
            $val_in=fread(STDIN,4096);
            switch($val_in)
            {
            case "start\n":    echo "Started\n";
                    return false;
                    break;
            case "stop\n":    echo "Stopped\n";
                    $keys=0;
                    return false;
                    break;
            case "pause\n":    echo "Paused\n";
                    return false;
                    break;
            case "get\n":    echo ($keys."\n");
                    return true;
                    break;
            default:    echo("Передан не верный параметр: ".$val_in."\n"); 
                    return true;
                    exit();
            }
        }else{return true;}
}
while(true)
{
while(play_stop()){usleep(1000);}
while(play_stop()){$keys++;usleep(10);}
}
?>
```

--------------------------------

### Wizard layout example using UI\Window

Source: https://www.php.net/manual/en/class.ui-window.php

A user-contributed example showing how to build a wizard layout with the UI library. It creates a window, adds a form with entries, arranges buttons in a grid, and runs the UI event loop. Requires the UI extension and uses classes like Window, Size, Grid, Box, Form, Entry, and Label.

```php
<?php

/*
 * Wizard sample layout builded with PHP UI
 */

use UI\Window;
use UI\Size;
use UI\Controls\Button;
use UI\Controls\Grid;
use UI\Controls\Box;
use UI\Controls\Form;
use UI\Controls\Entry;
use UI\Controls\Label;

/*
 * The window
 */
$window = new Window('Wizard Sample Layout', new Size(640, 480), TRUE);
$window->setMargin(true);

/*
 * Wizard content (sample)
 */
$content = new Form();
$content->setPadded(true);
$content->append('User:', new Entry());
$content->append('Password:', new Entry(Entry::Password));

/*
 * Layout to title, content and buttons
 */
$grid = new Grid();
$grid->setPadded(false);

/*
 * Title
 */
$grid->append(new Label('Wizard Sample'), 0, 0, 6, 1, true, Grid::Fill, false, Grid::Fill);

/*
 * Append content
 */
$grid->append($content, 0, 1, 6, 1, false, Grid::Fill, true, Grid::Fill);

/*
 * Left buttons
 */
$left_box = new Box(Box::Horizontal);
$left_box->append(new Button('&About'));
$left_box->append(new Button('&Help'));

/*
 * Right buttons
 */
$right_box = new Box(Box::Horizontal);
$right_box->append(new Button('&Back'));
$right_box->append(new Button('&Forward'));
$right_box->append(new Button('&Close'));

/**
 * Append buttons
 */
$grid->append($left_box, 0, 2, 1, 1, true, Grid::Start, false, Grid::Fill);
$grid->append($right_box, 5, 2, 1, 1, true, Grid::End, false, Grid::Fill);

/*
 * Append layout and show.
 */
$window->add($grid);

$window->show();

UI\run();

?>
```

--------------------------------

### Basic gettext usage: echo _("Good Morning")

Source: https://www.php.net/manual/en/book.gettext.php

A minimal PHP script that uses the gettext alias _() to output a translated message. This is the starting point for the Windows setup example.

```php
<?php 
 echo  _("Good Morning");
?>
```

--------------------------------

### sqlsrv_fetch() example

Source: https://www.php.net/manual/en/function.sqlsrv-fetch.php

Demonstrates how to retrieve a row with sqlsrv_fetch() and get the row fields with sqlsrv_get_field(). Field indices start at 0 and must be retrieved in order; retrieving row fields by name is not supported by sqlsrv_get_field.

```php
<?php
$serverName = "serverName\sqlexpress";
$connectionInfo = array( "Database"=>"dbName", "UID"=>"username", "PWD"=>"password");
$conn = sqlsrv_connect( $serverName, $connectionInfo);
if( $conn === false ) {
     die( print_r( sqlsrv_errors(), true));
}

$sql = "SELECT Name, Comment
        FROM Table_1
        WHERE ReviewID=1";
$stmt = sqlsrv_query( $conn, $sql);
if( $stmt === false ) {
     die( print_r( sqlsrv_errors(), true));
}

// Make the first (and in this case, only) row of the result set available for reading.
if( sqlsrv_fetch( $stmt ) === false) {
     die( print_r( sqlsrv_errors(), true));
}

// Get the row fields. Field indices start at 0 and must be retrieved in order.
// Retrieving row fields by name is not supported by sqlsrv_get_field.
$name = sqlsrv_get_field( $stmt, 0);
echo "$name: ";

$comment = sqlsrv_get_field( $stmt, 1);
echo $comment;
?>
```

--------------------------------

### Install GD dependencies and configure flags

Source: https://www.php.net/manual/en/image.installation.php

Install libpng-dev, libjpeg-dev, and libwebp-dev via apt-get, then use --with-png-dir --with-jpeg-dir --with-webp-dir without values.

```text
On Ubuntu I was missing the libpng-dev, libjpeg-dev (and in my case) libwebp-dev libraries, all gettable with apt-get.

Also once those libraries are installed, including --with-png-dir --with-jpeg-dir --with-webp-dir, without any values (i.e. =/dir) appeared to be valid ... though admittedly I didn't try without (in case the configure script autodetected them).

```

--------------------------------

### Starting Threads with Thread::start

Source: https://www.php.net/manual/en/thread.start.php

Example #1 shows how to start a new thread by creating a class that extends Thread, implementing the run method, and calling start(). The example outputs bool(true) on success.

```php
<?php
class My extends Thread {
    public function run() {
        /** ... **/
    }
}
$my = new My();
var_dump($my->start());
?>
```

```text
bool(true)
```

--------------------------------

### Example output of getPost()

Source: https://www.php.net/manual/en/yaf-request-abstract.getpost.php

Sample output from the example above, showing the values of the POST parameters.

```text
string(8) "laruence"
string(3) "yes"
```

--------------------------------

### Get image size in bytes with example output

Source: https://www.php.net/manual/en/imagick.getimagesize.php

A user note showing how to get the image size in bytes using getImageSize(), with an example output.

```php
/* get the size of the image in bytes */
$image=new Imagick("c:/htdocs/rose.jpg");
$size=$image->getImageSize();
print "the size of the picture is ".$size." bytes";

result

the size of the picture is 3461 bytes
```

--------------------------------

### rpmdefine() example

Source: https://www.php.net/manual/en/function.rpmdefine.php

Demonstrates using rpmdefine to configure custom database paths and backends for different chroot environments, followed by retrieving information with rpmdbinfo.

```php
<?php
// use an old database (bdb) from an EL-8 chroot
rpmdefine("_dbpath /var/lib/mock/almalinux-8-x86_64/root/var/lib/rpm");
rpmdefine("_db_backend bdb_ro");
print_r(rpmdbinfo("almalinux-release")[0]["Summary"]);

// use a new database (sqlite) from a Fedora-41 chroot
rpmdefine("_dbpath /var/lib/mock/fedora-41-x86_64/root/usr/lib/sysimage/rpm");
rpmdefine("_db_backend sqlite");
print_r(rpmdbinfo("fedora-release")[0]["Summary"]);
?>
```

```text
AlmaLinux release file
Fedora release files
```

--------------------------------

### rand() example with output

Source: https://www.php.net/manual/en/function.rand.php

Example #1 rand() example. Shows calling rand() without arguments to get a pseudo-random integer between 0 and getrandmax(), and with min and max arguments to get a value in a specific range (5 to 15 inclusive). The output is an example of what the code might produce.

```php
<?php
echo rand(), "\n";
echo rand(), "\n";

echo rand(5, 15), "\n";
?>
```

```text
7771
22264
11
```

--------------------------------

### Example output: Protocol version

Source: https://www.php.net/manual/en/mysqli.get-proto-info.php

Shows the expected output from the examples above.

```text
Protocol version: 10

```

--------------------------------

### ReflectionGenerator::getTrace() example

Source: https://www.php.net/manual/en/reflectiongenerator.gettrace.php

Shows how to use ReflectionGenerator::getTrace() to get the trace of a generator. The example defines three generator functions (foo, bar, baz) where bar yields from foo and baz yields from bar. After starting the generator with valid(), it creates a ReflectionGenerator and calls getTrace(). The output shows the trace array with file, line, function, and args for each frame.

```php
<?php
function foo() {
    yield 1;
}

function bar()
{
    yield from foo();
}

function baz()
{
    yield from bar();
}

$gen = baz();
$gen->valid(); // start the generator

var_dump((new ReflectionGenerator($gen))->getTrace());
```

--------------------------------

### Windows installation steps (Jimmy Christensen)

Source: https://www.php.net/manual/en/pthreads.installation.php

Windows installation steps for pthreads: download matching version, extract, move DLLs, and add extension line to php.ini.

```text
On Windows the installation is as follows:

Download the pthreads that matches your php version.
I found mine at: http://windows.php.net/downloads/pecl/releases/pthreads/
(I used version 0.44 wich is the newest at the time of writing this, and then downloaded the one for php 5.3 which is the version I am using).

Extract the zip.
Move php_pthreads.dll to the php\ext\ directory.
Move pthreadVC2.dll to the php\ directory.

Open php\php.ini and add
extension=php_pthreads.dll

You are done.
```

--------------------------------

### Run the Application - Output

Source: https://www.php.net/manual/en/yaf.tutorials.quickstart.php

Example output when running the application and pointing the browser to the configured domain (e.g., http://www.example.com).

```html
<html>
 <head>
   <title>Hello World</title>
 </head>
 <body>
   hello world
 </body>
</html>

```

--------------------------------

### HTTPS SOAP client setup with authentication

Source: https://www.php.net/manual/en/ref.soap.php

Guide for setting up a password-protected SOAP client over HTTPS on Windows/Apache 1.3. Requires enabling php_soap.dll and php_openssl.dll extensions, and copying OpenSSL DLLs. The example shows passing login/password in both the WSDL URI and options array.

```php
$client = new SoapClient("https://yourLogin:yourPassword@foo.com/bar.wsdl", array(
    "login"      => "yourLogin", 
    "password"   => "yourPassword",
    "trace"      => 1, 
    "exceptions" => 0)); 

$client->yourFunction();

print "<pre>\n"; 
print "Request: \n".htmlspecialchars($client->__getLastRequest()) ."\n"; 
print "Response: \n".htmlspecialchars($client->__getLastResponse())."\n"; 
print "</pre>"; 
```

--------------------------------

### Setup Apache and PHP on macOS 10.12.6

Source: https://www.php.net/manual/en/install.macosx.bundled.php

Step-by-step commands to start Apache, locate the configuration file, edit it, load the PHP module, add PHP MIME types, restart Apache, and test with a PHP file.

```bash
sudo apachectl start
```

```bash
sudo apachectl -t -D DUMP_INCLUDES
```

```bash
sudo vim  /opt/local/etc/apache2/httpd.conf
```

```apache
LoadModule php5_module /usr/libexec/apache2/libphp5.so
<IfModule unixd_module>
```

```apache
<IfModule mod_php5.c>
    AddType application/x-httpd-php .php
    AddType application/x-httpd-php-source .phps
    <IfModule mod_dir.c>
        DirectoryIndex index.html index.php
    </IfModule>
</IfModule>
```

```bash
sudo apachectl restart
```

```php
<?php
    phpinfo();
?>
```

--------------------------------

### Yaf_Application::run() example

Source: https://www.php.net/manual/en/yaf-application.run.php

Example #1 shows how to start a Yaf application. It defines APPLICATION_PATH as the current directory, creates a Yaf_Application from the configuration file, then calls bootstrap() and run() to start the application.

```php
<?php
defined('APPLICATION_PATH')
    || define('APPLICATION_PATH', __DIR__);

$application = new Yaf_Application(APPLICATION_PATH.'/conf/application.ini');
$application->bootstrap()->run();
?>

```

--------------------------------

### SQLite3::__construct() example

Source: https://www.php.net/manual/en/sqlite3.construct.php

Shows how to instantiate SQLite3 with a filename, create a table, insert a row, and fetch a result. The example uses the default flags (SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE) and no encryption key.

```php
<?php
$db = new SQLite3('mysqlitedb.db');

$db->exec('CREATE TABLE foo (bar TEXT)');
$db->exec("INSERT INTO foo (bar) VALUES ('This is a test')");

$result = $db->query('SELECT bar FROM foo');
var_dump($result->fetchArray());
?>
```

--------------------------------

### Start Apache httpd

Source: https://www.php.net/manual/en/install.unix.apache2.php

Start the Apache httpd server using the installed apachectl binary.

```bash
/usr/local/apache2/bin/apachectl start
```

--------------------------------

### mhash_get_hash_name() example

Source: https://www.php.net/manual/en/function.mhash-get-hash-name.php

Example of using mhash_get_hash_name() to get the name of the MHASH_MD5 hash. Outputs 'MD5'.

```php
<?php

echo mhash_get_hash_name(MHASH_MD5); // MD5

?>
```

--------------------------------

### Install pthreads on Linux

Source: https://www.php.net/manual/en/pthreads.installation.php

Step-by-step instructions to download PHP sources, install PEAR, install pthreads via PECL, configure, compile, and test the extension on Linux.

```text
HOW TO INSTALL IN LINUX SYSTEM'S:
------------------------------------

1) Download PHP sources and Unpack PHP

2) Download PEAR
     wget http://pear.php.net/go-pear.phar
     php go-pear.phar

3) Download pthreads
Get PECL extension (PECL is a repository for PHP Extensions)

# pecl install pthread-0.4.4

4) Unpack pthreads
copy pthread-0.4.4  to  php/ext
(for ./configure allow  add option --enable-pthreads)

# mv build/php-src-master/ext/pthreads-master    build/php-src-master/ext/pthreads

5)  Reconfigure sources
# ./buildconf --force
# ./configure --help | grep pthreads

You should see the appropriate --enable-pthreads option listed as a result, if you do not, then

# rm -rf aclocal.m4
# rm -rf autom4te.cache/
# ./buildconf --force

6) Build PHP
Compile PHP source code
Add:
# ./configure --enable-debug --enable-maintainer-zts --enable-pthreads

7) Installing PHP
# make
# sudo make install

8) Update php.ini
Add in php.ini
extension=pthreads.so
Include_path = "/usr/local/lib/php"

9) Check Modules
php -m (check pthread loaded)

10) Test Thread Class
# php SimpleTest.php
```

--------------------------------

### Get timezonedb version with timezone_version_get()

Source: https://www.php.net/manual/en/function.timezone-version-get.php

Example #1 shows how to call timezone_version_get() and echo its return value. The output is a string like '2022.2'. If the timezone database is old, update PHP or install the timezonedb PECL package. On some Linux distributions, the function may return '0.system'.

```php
<?php
echo timezone_version_get();

```

```text
2022.2

```

--------------------------------

### chdir() example output

Source: https://www.php.net/manual/en/function.chdir.php

Example output of the chdir() example, showing the current directory before and after the change.

```text
/home/vincent
/home/vincent/public_html

```

--------------------------------

### collator_get_sort_key() example

Source: https://www.php.net/manual/en/collator.getsortkey.php

Shows how to get a sort key for a string using the procedural collator_get_sort_key() function. The example creates a collator for 'en_US', gets the sort key for 'Hello', and outputs the hexadecimal representation of the key.

```php
<?php

$s1 = 'Hello';

$coll = collator_create('en_US');
$res  = collator_get_sort_key($coll, $s1);

echo bin2hex($res);
?>
```

--------------------------------

### ibase_backup() basic example

Source: https://www.php.net/manual/en/function.ibase-backup.php

Basic ibase_backup() example: attaches to the database server by IP address and port, starts a backup of the employee database using full paths, and detaches. No special options are passed.

```php
<?php

// Attach to database server by ip address and port
$service = ibase_service_attach ('10.1.11.200/3050', 'sysdba', 'masterkey');

// Start the backup process on database server
// Backup employee database using full path to /srv/backup/employees.fbk
// Don't use any special arguments
ibase_backup($service, '/srv/firebird/employees.fdb', '/srv/backup/employees.fbk');

// Free the attached connection
ibase_service_detach ($service);
?>
```

--------------------------------

### mt_rand() example with and without arguments

Source: https://www.php.net/manual/en/function.mt-rand.php

Example #1 shows how to call mt_rand() without arguments to get a random integer between 0 and mt_getrandmax(), and with min and max arguments to get a random integer in a specific range (5 to 15 inclusive). The output is an example of what the function might return.

```php
<?php
echo mt_rand(), "\n";
echo mt_rand(), "\n";

echo mt_rand(5, 15), "\n";
?>
```

```text
1604716014
1478613278
6
```

--------------------------------

### User contributed note: Windows desktop wallpaper example

Source: https://www.php.net/manual/en/ffi.examples-basic.php

User-contributed example showing how to use FFI with Windows API to set the desktop wallpaper. Includes error handling and requires the FFI extension.

```php
<?
  if(!dl("ffi")) // Load the extension
      throw new Exception('Cound not load the FFI extension.');

  function setWindowsDesktop($bmpFilePath)
  {
    define('SPI_SETDESKWALLPAPER'  , 0x14);
    define('SPIF_UPDATEINIFILE'    ,  0x1);
    define('SPIF_SENDWININICHANGE' ,  0x2);
    assert(File_Exists($bmpFilePath));
    
    // declare the Win32 API function used to change desktop settings.
    $User32 = FFI::cdef(<<<'IDL'
      int SystemParametersInfoA(int uAction, int uParam, char *lpvParam, int fuWinIni);
    IDL, 'User32.dll');
    $Kernel32 = FFI::cdef(<<<'IDL'
      int GetLastError();
    IDL, 'Kernel32.dll');
    // call the Windows API to update the desktop background.
    $Ret = $User32->SystemParametersInfoA(SPI_SETDESKWALLPAPER, 0, $bmpFilePath, SPIF_UPDATEINIFILE || SPIF_SENDWININICHANGE);
    if ($Ret == 0)
    {
      $Error = $Kernel32->GetLastError();
      throw new Exception("The call to the Windows API failed (error {$Error}).");
    }
  }
  
  $Url='https://www.php.net//images/news/phpkonf_2015.png';
  $Img=File_Get_Contents($Url);
  File_Put_Contents($File=basename($Url), $Img);
  setWindowsDesktop(realpath($File));
?>
```

--------------------------------

### Example output

Source: https://www.php.net/manual/en/mysqli.get-server-version.php

Sample output from the above examples, showing the server version as an integer.

```text
Server version: 80021
```

--------------------------------

### Comment style guide example

Source: https://www.php.net/manual/en/language.basic-syntax.comments.php

User-contributed example showing various comment styles for organizing code.

```php
<?php

//======================================================================
// CATEGORY LARGE FONT
//======================================================================

//-----------------------------------------------------
// Sub-Category Smaller Font
//-----------------------------------------------------

/* Title Here Notice the First Letters are Capitalized */

# Option 1
# Option 2
# Option 3

/*
 * This is a detailed explanation
 * of something that should require
 * several paragraphs of information.
 */
 
// This is a single line quote.
?>
```

--------------------------------

### Install ImageMagick on UwAmp for Windows (Detailed Guide)

Source: https://www.php.net/manual/en/imagick.setup.php

Step-by-step guide for installing ImageMagick on UwAmp for Windows, including downloading the correct DLL from PECL, copying it to the PHP extension folder, editing php.ini, and verifying installation via PHPInfo. Requires matching PHP version and thread safety.

```text
Steps to Install ImageMagick on UwAmp for Windows:
as of March 31, 2016
Detailed guide for newbies like me.

... continued

4. Goto:

    http://pecl.php.net/package/imagick

    as of today, latest is 3.4.1 so I went to:
    http://pecl.php.net/package/imagick/3.4.1/windows

    My PHP version is: 5.6.18, and Thread Safety is Yes from
    Step #1, so I downloaded:
       5.6 Thread Safe (TS) x86
    I got: php_imagick-3.4.1-5.6-ts-vc11-x86.zip

5. Unzip and copy "php_imagick.dll" to the php extension folder:

    In my case:
    php_imagick.dll --> C:\UwAmp\bin\php\php-5.6.18\ext

    Note: this ZIP also contains dlls which other guides says
    to extract to the extension folder of apache.
    NO NEED TO DO IT. Step #3 has taken care of it.

6. Edit "php.ini" and add at the very end (could be 
    anywhere I suppose):

      [Imagick]
      extension=php_imagick.dll

      For super newbies: click the edit button in the UwAmp UI,
      "php_uwamp.ini" will open and edit it. It will be copied to
      the correct php.ini when UwAmp is restarted. I had 
      trouble at first since there are several php*.ini scattered 
      all over.

7. Restart Apache

8. Check PHPInfo
    scroll to section (or find): imagick    
    number of supported formats: 234

    If there is no "imagick" section or "supported format" is 0,
    something went wrong.

Hope this helps.
```

--------------------------------

### ftp_mkdir() example

Source: https://www.php.net/manual/en/function.ftp-mkdir.php

Official example showing how to create a directory on an FTP server using ftp_mkdir(). It connects, logs in, attempts to create a directory, and prints a success or failure message.

```php
<?php

$dir = 'www';

// set up basic connection
$ftp = ftp_connect($ftp_server);

// login with username and password
$login_result = ftp_login($ftp, $ftp_user_name, $ftp_user_pass);

// try to create the directory $dir
if (ftp_mkdir($ftp, $dir)) {
 echo "successfully created $dir\n";
} else {
 echo "There was a problem while creating $dir\n";
}

// close the connection
ftp_close($ftp);
?>
```
Tokens:
Raw