PHP Manual

https://www.php.net/manual/
Admin
The PHP Manual is the official and comprehensive documentation for the PHP programming language,...
Tokens:2,068,313
Snippets:8,291
Trust Score:10
Update:6 months ago
Show doc for...
Tokens:
Raw
### Installation and Configuration

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

Guides on how to install and configure the Enchant extension and its backends.

```APIDOC
## Installing/Configuring Enchant

### Description
Instructions and requirements for installing and configuring the Enchant PHP extension and its supported spelling libraries.

### Sections

- **Requirements**
- **Installation**
- **Resource Types**

### Note on Configuration Directories

As of PHP 5.4.13 and 5.3.23, it is possible to override the default Enchant brokers directory using:

- **Windows:** Registry key `HKLM/Software/Enchant/Config/Module_Dir`
- **Linux:** Environment variable `ENCHANT_CONFIG_DIR`

```

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

### Guide to Installing PHP with SuEXEC (External Resource)

Source: https://www.php.net/manual/es/security.cgi-bin.php

This entry points to an external guide detailing the setup of PHP with SuEXEC, specifically addressing the need to avoid shebangs (!#/usr/bin/php4) in PHP scripts. The linked resource aims to help users with PHP security configurations.

```text
I have setup a guide to installing PHP with SuEXEC in such a way that shebangs (!#/usr/bin/php4) are not needed. Hope this is of some help to you.

http://www.pookey.co.uk/php-security.xml
```

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

### Guide to Installing PHP with SuEXEC Without Shebangs

Source: https://www.php.net/manual/ru/security.cgi-bin.php

References an external guide for setting up PHP with SuEXEC in a way that eliminates the need for shebang lines in PHP scripts. Provides a URL to the guide.

```text
http://www.pookey.co.uk/php-security.xml
```

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

### Configure PHP as Apache Module or CGI

Source: https://www.php.net/manual/fr/configuration.php

Provides examples for setting custom php.ini locations via .htaccess for both Apache module and CGI execution modes, including a wrapper script example for FastCGI.

```apache
# When php run as Apache Module
SetEnv PHPRC /home/user/dir-containing-phpinifile

# When php run as CGI
AddHandler php-cgi .php .htm
Action php-cgi /cgi-bin/php5.cgi

# Wrapper script for FastCGI
#!/bin/sh
export PHP_FCGI_CHILDREN=3
exec /user/htdocs/cgi-bin/php.cgi -c /home/user/php.ini
```

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

### Configure PHP Extension and INI Paths

Source: https://www.php.net/manual/pt_BR/configuration.php

Examples for setting up the zend_extension path in php.ini using double quotes to handle spaces and configuring the PHPIniDir directive in Apache's httpd.conf.

```ini
zend_extension="/usr/local/php5/lib/php/extensions/no-debug-non-zts-20060613/xdebug.so"
```

```apache
PHPIniDir "C:/Archivos de programa/PHP/"
```

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

### Create a PHP Daemon using System_Daemon

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

This snippet shows the basic setup for creating a daemon process in PHP using the System_Daemon PEAR package. It covers installation, application naming, starting the daemon, and a simple infinite loop for task execution. Ensure the System_Daemon package is installed via PEAR.

```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();
?>
```

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

### Retrieving PHP Installation Configuration Line

Source: https://www.php.net/manual/en/faq.build.php

This demonstrates how to find the './configure' command used to build the current PHP installation. This is useful for replicating or modifying the build configuration. It can be found in the 'config.nice' file within the source tree or by examining the output of 'phpinfo()'.

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

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

### Example of svn_fs_is_file in PHP

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

Provides a practical example of using the `svn_fs_is_file` function, which requires handles to a Subversion repository and a specific revision. The example demonstrates opening a repository, getting a filesystem handle, determining the youngest revision, and obtaining a revision root handle.

```php
<?php

# Get a handle to the on-disk repository. Note that this
# is NOT a checked out project, but the actual svn repository!

$repos_handle = svn_repos_open('/var/lib/svn');
$fs_handle = svn_repos_fs($repos_handle);

# Now we need to open a revision because that's what the
# svn_fs_* methods need. You'll probably want the latest
# revision and we have a helper method for that.

$youngest_rev = svn_fs_youngest_rev($fs_handle);
$fs_rev_handle = svn_fs_revision_root($fs_handle, $youngest_rev);

# Now we can actually start doing stuff, for example the

```

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

### PHP-FPM Init Script Setup

Source: https://www.php.net/manual/en/install.fpm.php

Instructions for setting up an init script for PHP-FPM, including copying the provided script, setting permissions, configuring essential variables like the binary path and PID file, and managing the service (start, stop, reload).

```bash
$ cp <php-5.3.3-source-dir>/sapi/fpm/init.d.php-fpm.in /etc/init.d/php-fpm
$ chmod 755 /etc/init.d/php-fpm
```

```ini
pid = /var/run/php-fpm.pid
```

```bash
prefix=
exec_prefix=
php_fpm_BIN=/sbin/php-fpm
php_fpm_CONF=/etc/php-fpm.conf
php_fpm_PID=/var/run/php-fpm.pid
```

```bash
$ /etc/init.d/php-fpm start
$ /etc/init.d/php-fpm stop
$ /etc/init.d/php-fpm reload
```

```bash
$ /sbin/chkconfig php-fpm on
```

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

### Get and Set Base Path in PHP

Source: https://www.php.net/manual/en/seaslog.examples.php

Demonstrates how to retrieve the current base path for logs and set a new base path using SeasLog functions. It shows the initial and updated paths.

```php
<?php
$basePath1 = SeasLog::getBasePath();

SeasLog::setBasePath('/log/base_test');
$basePath2 = SeasLog::getBasePath();

var_dump($basePath1,$basePath2);

?>
```

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

### Implement SSL Echo Server

Source: https://www.php.net/manual/en/event.examples.php

Shows the setup of an SSL-enabled server using the PHP Event extension. It initializes an SSL context and uses EventListener to handle secure connections, echoing received data back to the client.

```php
class MySslEchoServer {
    public $port, $base, $listener, $ctx;

    function __construct ($port, $host = "127.0.0.1") {
        $this->ctx = $this->init_ssl();
        $this->base = new EventBase();
        $this->listener = new EventListener($this->base, array($this, "ssl_accept_cb"), $this->ctx, EventListener::OPT_CLOSE_ON_FREE | EventListener::OPT_REUSEABLE, -1, "$host:$port");
    }

    function ssl_read_cb($bev, $ctx) {
        $in = $bev->input;
        $bev->writeBuffer($in);
    }
}
```

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

### Configure PHP as Apache Module or CGI

Source: https://www.php.net/manual/pt_BR/configuration.php

Directives for setting up PHP environments via .htaccess or wrapper scripts, including handling PHPRC environment variables for custom php.ini locations.

```apache
SetEnv PHPRC /home/user/dir-containing-phpinifile
```

```bash
#!/bin/sh
export PHP_FCGI_CHILDREN=3
exec /user/htdocs/cgi-bin/php.cgi -c /home/user/php.ini
```

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

### Checking PHP Version from Command Line

Source: https://www.php.net/manual/de/features.commandline.php

Demonstrates the command to execute PHP from the command line with the `-v` switch to display the currently running PHP version. This is useful for verifying the correct PHP installation and version.

```bash
php -v
```

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

### Initialize Office Applications via COM

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

Shows how to instantiate Office applications like Access or Excel. This includes tips for handling service-level permission issues when running PHP under the Apache SYSTEM account.

```PHP
$app = new COM("Access.Application");
$app->Visible = true;
```

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

### PHP cURL: Get Web Content as String

Source: https://www.php.net/manual/en/curl.examples.php

This example demonstrates how to use PHP's cURL extension to fetch the content of a URL and store it as a string. It initializes a cURL session, sets the URL andRETURNTRANSFER options, executes the request, and then closes the session. Ensure the cURL extension is enabled in your PHP installation.

```php
<?php
        // create curl resource
        $ch = curl_init();

        // set url
        curl_setopt($ch, CURLOPT_URL, "example.com");

        //return the transfer as a string
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

        // $output contains the output string
        $output = curl_exec($ch);

        // close curl resource to free up system resources
        curl_close($ch);
?>

```

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

### PHP EventHttp Server Setup and Request Handling

Source: https://www.php.net/manual/en/event.examples.php

This snippet demonstrates setting up an EventHttp server in PHP, defining callbacks for different URI routes, and handling incoming requests. It includes functions for dumping request details, responding to '/about' and '/err400' URIs, and a default handler. It also shows how to initialize an SSL context for secure connections.

```php
<?php

function _http_dump($req) {
    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";  
  
 $buf = $req->getInputBuffer();  
    echo "\n >> Reading input buffer (", $buf->length, ") ...\n";  
    while ($s = $buf->read(1024)) {  
        echo $s;  
    }  
    echo "\nNo 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";
}

function _http_400($req) {
 $req->sendError(400);
}

function _init_ssl() {
 $local_cert = __DIR__."/ssl-echo-server/cert.pem";
 $local_pk   = __DIR__."/ssl-echo-server/privkey.pem";

 $ctx = new EventSslContext(EventSslContext::SSLv3_SERVER_METHOD, array (
 EventSslContext::OPT_LOCAL_CERT  => $local_cert,
 EventSslContext::OPT_LOCAL_PK    => $local_pk,
 //EventSslContext::OPT_PASSPHRASE  => "test",
 EventSslContext::OPT_ALLOW_SELF_SIGNED => true,
    ));

    return $ctx;
}

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

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

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

$http->bind($ip, $port);
$base->dispatch();
?>
```

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

### Setting up gettext for PHP on Windows

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

This snippet details the steps to set up and use the gettext library for PHP on a Windows system. It covers downloading and installing necessary components, creating PHP files with translatable strings, generating .po and .mo files using command-line tools, and configuring PHP to use the generated locale files.

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

```bash
xgettext -n index.php
```

```text
- "Language: \n" BECOMES "Language fr\n"
- "Content-Type: text/plain; charset=CHARSET" BECOMES "Content-Type: text/plain; charset=UTF-8\n"
```

```text
#: index.php:2
msgid "Good Morning"
msgstr "Bonjour"
```

```bash
msgfmt messages.po
```

```php
<?php

$locale = "fr_FR";

   if (defined('LC_MESSAGES')) {
       setlocale(LC_MESSAGES, $locale); // Linux
       bindtextdomain("messages", "./locale");
   } else {
       putenv("LC_ALL={$locale}"); // windows
       bindtextdomain("messages", ".\locale");
   }

   
   textdomain("messages");

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

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

### Set Up Virtual Host with PHP Built-in Server

Source: https://www.php.net/manual/en/features.commandline.webserver.php

Demonstrates setting up a virtual host for local testing using the built-in web server and the hosts file. It involves modifying the hosts file, changing directory, and starting the server with a specific host.

```bash
# 1. /etc/hosts
127.0.0.1    www.example.com

# 2. cd [root folder]
php -S www.example.com:8000

# 3. Browser:
# http://www.example.com:8000/index.php
```

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

### Configure SolrClient Path for Different Request Handlers and Multicore

Source: https://www.php.net/manual/en/solr.examples.php

Demonstrates how to configure the SolrClient to access different request handlers or specific Solr cores. This involves setting the 'path' parameter in the options array, which is crucial for multicore setups or non-default Solr installations.

```php
<?php
  $options = array(...., 'path' => 'solr/core0', ...);
?>
```

```php
define('SOLR_SERVER_PATH', 'my-solr-url');
// ...
'path'     => SOLR_SERVER_PATH
```

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

### PHP Property Type Variance Example

Source: https://www.php.net/manual/en/language.oop5.variance.php

Demonstrates property type variance in PHP, illustrating covariant ('get' only) and invariant properties. This example highlights how a property with both 'get' and 'set' operations becomes invariant and cannot be further specialized in child classes.

```php
<?php
class Animal {}
class Dog extends Animal {}
class Poodle extends Dog {}

interface PetOwner
{
 // Only a get operation is required, so this may be covariant.
 public Animal $pet { get; }
}

class DogOwner implements PetOwner
{
 // This may be a more restrictive type since the "get" side
    // still returns an Animal.  However, as a native property
    // children of this class may not change the type anymore.
 public Dog $pet;
}

class PoodleOwner extends DogOwner
{
 // This is NOT ALLOWED, because DogOwner::$pet has both
    // get and set operations defined and required.
 public Poodle $pet;
}
?>

```

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

### GET swoole_version

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

Retrieves the current version of the installed Swoole extension.

```APIDOC
## GET swoole_version

### Description
Returns the version string of the Swoole extension currently loaded in the PHP environment.

### Method
GET

### Endpoint
swoole_version

### Response
#### Success Response (200)
- **version** (string) - The version number (e.g., "4.8.0").
```

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

### Initialize and Populate PHP Arrays

Source: https://www.php.net/manual/en/language.types.array.php

Demonstrates the flexibility of PHP array syntax, showing how to define arrays using the array() constructor or by assigning values to keys dynamically.

```php
$a = array( 'color' => 'red', 'taste' => 'sweet', 'shape' => 'round', 'name' => 'apple', 4 );
$b = array('a', 'b', 'c');
var_dump($a, $b);

$a = array();
$a['color'] = 'red';
$a['taste'] = 'sweet';
$a['shape'] = 'round';
$a['name'] = 'apple';
$a[] = 4;

$b = array();
$b[] = 'a';
$b[] = 'b';
$b[] = 'c';
var_dump($a, $b);
```

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

### Installing and Configuring SOAP Extension

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

Information on how to install and configure the PHP SOAP extension, including requirements.

```APIDOC
## Installing and Configuring SOAP Extension

### Description
This section covers the requirements, installation process, and runtime configuration options for the PHP SOAP extension.

### Method
N/A

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```

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

### Configure EventBase and Query Features

Source: https://www.php.net/manual/en/event.examples.php

Illustrates how to inspect supported event methods, configure specific backend preferences (like avoiding 'select'), and query available features of the EventBase.

```PHP
$cfg = new EventConfig();
$cfg->avoidMethod("select");
$base = new EventBase($cfg);
echo "Event method used: ", $base->getMethod(), PHP_EOL;
$features = $base->getFeatures();
```

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

### Get and Set Logger in PHP

Source: https://www.php.net/manual/en/seaslog.examples.php

Illustrates how to get the last used logger and set a new logger module and application name using SeasLog. It displays the default and the newly set logger.

```php
<?php
$lastLogger1 = SeasLog::getLastLogger();

SeasLog::setLogger('testModule/app1');
$lastLogger2 = SeasLog::getLastLogger();

var_dump($lastLogger1,$lastLogger2);

?>
```

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

### Installing PHP Interactive Mode Packages on Debian/Ubuntu/LinuxMint

Source: https://www.php.net/manual/en/features.commandline.interactive.php

This note provides instructions for installing the necessary packages ('php*-cli' and 'php*-readline') to enable PHP interactive mode on Debian-based Linux distributions. It includes example commands for installation and usage.

```bash
sudo aptitude install php5-cli php5-readline

~$ php -a
Interactive mode enabled

php >echo "hola mundo!\n";
hola mundo!
php >
```

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

### PHP include_path Configuration Examples

Source: https://www.php.net/manual/en/ini.core.php

Demonstrates how to configure the include_path directive in PHP, which specifies directories where PHP functions look for files. It shows examples for Unix-like systems and Windows, including the use of environment variables.

```php
include_path=".:/php/includes"
```

```php
include_path=".;c:\php\includes"
```

```php
include_path = ".:${USER}/pear/php"
```

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

### GET /solr/getById

Source: https://www.php.net/manual/en/solr.examples.php

Retrieves a single document from the Solr index by its unique document ID.

```APIDOC
## GET /solr/getById

### Description
Fetches a specific document from the Solr index using its unique identifier. This is a Real Time Get (RTG) operation.

### Method
GET

### Endpoint
/solr/getById

### Parameters
#### Query Parameters
- **id** (string) - Required - The unique identifier of the document to retrieve.

### Request Example
$client->getById('GB18030TEST');

### Response
#### Success Response (200)
- **doc** (object) - The document object containing fields such as id, name, features, price, and inStock.

#### Response Example
{
	"doc": {
		"id": "GB18030TEST",
		"name": ["Test with some GB18030 encoded characters"],
		"features": ["No accents here", "这是一个功能"],
		"price": [0],
		"inStock": [1],
		"_version_": 1510294336239042560
	}
}
```

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

### Installation and Configuration

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

Information on the requirements, installation process, and runtime configuration options for the Memcached PHP extension.

```APIDOC
## Installing/Configuring Memcached PHP Extension

### Requirements
Details the prerequisites for installing the Memcached extension.

### Installation
Provides step-by-step instructions for installing the extension.

### Runtime Configuration
Lists and explains the various configuration directives that can be set at runtime to control the behavior of the Memcached extension.
```

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

### PHP EventHttp SSL Client Connection Example

Source: https://www.php.net/manual/en/event.examples.php

This snippet shows how to create an SSL client connection using EventHttp in PHP. It includes a request handler to process responses, initialize an SSL context for the client, and make a POST request to a specified host and port. The client is designed to connect to a server started with the 'https.php' example.

```php
<?php
/*
 * Sample OpenSSL client.
 *
 * Usage:
 * 1) Launch a server, e.g.:
 * $ php examples/https.php 9999
 *
 * 2) Launch the client in another terminal:
 * $ php examples/ssl-connection.php 9999
 */

function _request_handler($req, $base) {
    echo __FUNCTION__, PHP_EOL;

    if (is_null($req)) {
        echo "Timed out\n";
    } else {
 $response_code = $req->getResponseCode();

        if ($response_code == 0) {
            echo "Connection refused\n";
        } elseif ($response_code != 200) {
            echo "Unexpected response: $response_code\n";
        } else {
            echo "Success: $response_code\n";
 $buf = $req->getInputBuffer();
            echo "Body:\n";
            while ($s = $buf->readLine(EventBuffer::EOL_ANY)) {
                echo $s, PHP_EOL;
            }
        }
    }

 $base->exit(NULL);
}

function _init_ssl() {
 $ctx = new EventSslContext(EventSslContext::SSLv3_CLIENT_METHOD, array ());

    return $ctx;
}


// Allow to override the port
$port = 9999;
if ($argc > 1) {
 $port = (int) $argv[1];
}
if ($port <= 0 || $port > 65535) {
    exit("Invalid port\n");
}
$host = '127.0.0.1';

$ctx = _init_ssl();
if (!$ctx) {
 trigger_error("Failed creating SSL context", E_USER_ERROR);
}

$base = new EventBase();
if (!$base) {
 trigger_error("Failed to initialize event base", E_USER_ERROR);
}

$conn = new EventHttpConnection($base, NULL, $host, $port, $ctx);
$conn->setTimeout(50);

$req = new EventHttpRequest("_request_handler", $base);
$req->addHeader("Host", $host, EventHttpRequest::OUTPUT_HEADER);
$buf = $req->getOutputBuffer();
$buf->add("<html>HTML TEST</html>");
//$req->addHeader("Content-Length", $buf->length, EventHttpRequest::OUTPUT_HEADER);
//$req->addHeader("Connection", "close", EventHttpRequest::OUTPUT_HEADER);
$conn->makeRequest($req, EventHttpRequest::CMD_POST, "/dump");

$base->dispatch();
echo "END\n";
?>

```

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

### Get Ticks Elapsed Since Value - PHP

Source: https://www.php.net/manual/en/class.hrtime-performancecounter.php

Calculates the number of ticks that have elapsed since a specified starting tick value. This static method requires an integer `$start` value and returns an integer representing the elapsed ticks.

```php
<?php

$startTicks = HRTime\PerformanceCounter::getTicks();
// Simulate some time passing
usleep(10000); // Sleep for 10 milliseconds

$elapsedTicks = HRTime\PerformanceCounter::getTicksSince($startTicks);
echo "Elapsed Ticks: " . $elapsedTicks . "\n";

?>
```

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

### Start PHP Development Server

Source: https://www.php.net/manual/en/tutorial.firstpage.php

This command-line instruction starts a local development server using PHP's built-in server functionality. It's used to serve PHP files from a specified directory on a given port, typically for testing purposes.

```bash
php -S localhost:8000

```

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

### PHP: Invalid Virtual Property Example

Source: https://www.php.net/manual/en/language.oop5.property-hooks.php

Demonstrates an invalid virtual property definition in PHP. A property is considered virtual if neither its 'get' nor 'set' hook directly references the property itself. This example shows a case where the hook does not correctly reference the property, leading to an error.

```php
<?php
class Example
{
    public string $foo {
 get {
 $temp = __PROPERTY__;
            return $this->$temp; // Doesn't refer to $this->foo, so it doesn't count.
 }
    }
}
?>
```

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

### Initialize VarnishAdmin Class

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

Demonstrates the instantiation of the VarnishAdmin class, which is used to manage and configure a running Varnish instance.

```php
$va = new VarnishAdmin($args);
```

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

### Get Single Character Input in PHP

Source: https://www.php.net/manual/ja/features.commandline.php

Provides a PHP function to get a single character response from the user without requiring the Enter key press. It uses the `read` command with specific options for interactive input.

```php
#!/usr/bin/php -q
<?php
function inKey($vals) {
    $inKey = "";
    While(!in_array($inKey,$vals)) {
        $inKey = trim(`read -s -n1 valu;echo $valu`);
    }
    return $inKey;
}
function echoAT($Row,$Col,$prompt="") {
    // Display prompt at specific screen coords
    echo "\033[".$Row.";"".$Col."H".$prompt;
}
    // Display prompt at position 10,10
    echoAT(10,10,"Opt : ");

    // Define acceptable responses
    $options = array("1","2","3","4","X");

    // Get user response
    $key = inKey($options);

    // Display user response & exit
    echoAT(12,10,"Pressed : $key\n");
?>

```

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

### PHP: Stream Context for HTTP GET Request

Source: https://www.php.net/manual/en/function.stream-context-create.php

Provides an example of creating a stream context for an HTTP GET request, including custom headers like 'Content-Type'. This context can then be used with functions like fopen to make the request.

```php
$opts = array('http'=>array('method'=>"GET",
'header'=>"Content-Type: text/xml; charset=utf-8");

$context = stream_context_create($opts);
$fp = fopen('http://www.example.com','r',false,$context);
fpassthru($fp);
fclose($fp);
```

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

### Create a Basic PHP Script (hello.php)

Source: https://www.php.net/manual/en/tutorial.firstpage.php

This snippet demonstrates the creation of a simple PHP script that outputs 'Hello World!'. It requires PHP to be installed and uses the echo statement. The file extension '.php' is crucial for server-side interpretation.

```php
<?php  
  
echo "Hello World!";  
  
?>

```

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

### Generate PHP configure script

Source: https://www.php.net/manual/en/faq.build.php

Commands to generate the configure script when building from Git source. Requires GNU autoconf to be installed.

```bash
./buildconf
```

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

### Launch GUI Processes on Windows

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

Shows how to launch a GUI application like Notepad from PHP on Windows. Requires the web server service to have 'Interactive with Desktop' permissions enabled.

```php
exec("start c:\\winnt\\notepad.exe");
```

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

### Instalar la extensión MongoDB con PIE

Source: https://www.php.net/manual/es/install.pie.intro.php

Este comando utiliza PIE para instalar la extensión MongoDB. PIE es un instalador para extensiones PHP de terceros que aprovecha el repositorio Packagist.

```bash
pie install mongodb/mongodb-extension
```

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

### PHP cURL for Remote File Size (HEAD Request)

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

This example demonstrates how to get the size of a remote file using cURL by making a HEAD request. This method is efficient as it only retrieves headers, not the entire file content. It parses the HTTP status and Content-Length from the response.

```php
<?php
$remoteFile = 'http://us.php.net/get/php-5.2.10.tar.bz2/from/this/mirror';
$ch = curl_init($remoteFile);
curl_setopt($ch, CURLOPT_NOBODY, true);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HEADER, true);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true); //not necessary unless the file redirects (like the PHP example we're using here)
$data = curl_exec($ch);
curl_close($ch);
if ($data === false) {
  echo 'cURL failed';
  exit;
}

$contentLength = 'unknown';
$status = 'unknown';
if (preg_match('/^HTTP\/1\.[01] (\d\d\d)/', $data, $matches)) {
  $status = (int)$matches[1];
}
if (preg_match('/Content-Length: (\d+)/', $data, $matches)) {
  $contentLength = (int)$matches[1];
}

echo 'HTTP Status: ' . $status . "\n";
echo 'Content-Length: ' . $contentLength;
?>
```

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

### Basic Autoloading Example with Namespaces (PHP)

Source: https://www.php.net/manual/en/language.namespaces.rules.php

Illustrates a fundamental autoloading setup where a custom __autoload function in the global namespace loads classes from a specific directory structure that matches namespace conventions. This example highlights how directory and file naming are crucial for autoloading to function correctly.

```php
<?php
//GLOBAL SPACE <--
function __autoload($c)
{
    require_once $c . ".php";
}

namespace ns;
class foo
{
    public $say;
    
    public function __construct()
    {
        $this->say = "bar";
    }
    
}
?>

<?php
// In loader.php

class foo extends ns\foo // ns\foo is loaded here
{
    public function __construct()
    {
        parent::__construct();
        echo "<br />foo" . $this->say;
    }
}
$a = new ns\foo(); // ns\foo also loads ns/foo.php just fine here.
echo $a->say;   // prints bar as expected.
$b = new foo;  // prints foobar just fine.
?>
```

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

### Yar Server and Client Example

Source: https://www.php.net/manual/en/class.yar-client.php

Demonstrates a basic implementation of a Yar server and client. The server defines API methods, and the client connects to the server to invoke these methods. This example illustrates how to set up and use the Yar extension for remote procedure calls.

```php
<?php
// server.php
class API {
   
    public function api($parameter = "", $option = "foo") {
          return $this->client_can_not_see($parameter);
    }
 
 
    public function doAdd($a = 0, $b = 0) {
          return $a+$b;
    }
   
    protected function client_can_not_see( $name ) {
      return "你好$name~";
    }
}

$service = new Yar_Server ( new API () );
$service->handle ();
?>
<?php
// client.php
  $client = new Yar_Client("http://host/server.php");
  $result = $client->api("parameter");
  echo $result.'<hr>';
  echo $client->doAdd(10, 20);
?>
```

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

### Troubleshooting COM with Apache Service on Windows

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

This note provides a detailed checklist for resolving issues when running COM applications, specifically 'word.application', under Apache as a Windows service. It emphasizes correct php.ini configuration, running Apache under a user account, and proper DCOM configuration for the COM component.

```text
- In php.ini make sure you have the following key under the [COM_DOT_NET]: extension=php_com_dotnet.dll 
- Apache shall run under a normal user account (not SYSTEM account). Run services.msc and fill-in the info of the user under the Apache service's Properties tab.
- Make sure you are able to start MS Word normally under that user account and dismiss all the dialogs that may appear (license, your info with initials, etc.). Start Word once again and make sure no dialogs appear.
- Launch dcomcnfg.exe->Console Root->Component Services->Computers->My Computer->DCOM Config->Microsoft Office Word 97 - 2003->Right Click(Properties)->Identity Tab and fill in the same user account information as for Apache service.
- If you cannot find the Microsoft Office Word 97 - 2003, make sure you are launching the correct DCOM Config (64 bit vs 32 bit) depending on what version of Office you have installed. To launch the 32 bit version run: mmc comexp.msc /32
```

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

### Check PHP Version

Source: https://www.php.net/manual/de/features.commandline.php

Displays the installed PHP version and build information when executed from the command line. This is useful for verifying the PHP environment.

```bash
#!/usr/local/bin/php
# php -v
PHP 4.3.1 (cli) (built: Mar 27 2003 14:41:51)
Copyright (c) 1997-2002 The PHP Group
Zend Engine v1.3.0, Copyright (c) 1998-2002 Zend Technologies
```

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

### System Configuration and Build Commands

Source: https://www.php.net/manual/phpfi2.php

Shell commands used to prepare the environment, compile the PHP source code, and set necessary file permissions for the web server.

```bash
./install
cd src
make
chown nobody directory
chmod u+s /path/php.cgi
```

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

### PHP EvPeriodic Manual Reschedule Mode Example

Source: https://www.php.net/manual/en/ev.periodic-modes.php

This example illustrates the manual reschedule mode for the EvPeriodic watcher. A custom reschedule callback function (`reschedule_cb`) is defined to determine the next trigger time, ensuring a 10.5-second interval between executions. The watcher is then started using Ev::run().

```php
<?php  
// Tick each 10.5 seconds  

function reschedule_cb ($watcher, $now) {  
   return $now + (10.5 - fmod($now, 10.5));  
}  

$w = new EvPeriodic(0., 0., "reschedule_cb", function ($w, $revents) {  
   echo time(), PHP_EOL;  
});  

Ev::run();  
?>
```

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

### Demonstrate PHP resource type with file handles

Source: https://www.php.net/manual/en/language.types.resource.php

This example demonstrates how the fopen function creates a resource type when interacting with external files. It highlights the difference between a failed operation and a successful resource creation using var_dump.

```PHP
<?php

// a normal variable
$file_resource = fopen("normal_file.txt", "r");

// after we assigned an external file to that variable using the function fopen,
// PHP starts dealing with the file, and since it is an external resource,
// PHP makes the type of the variable a resource that refers to that operation

var_dump($file_resource);

// the previous var_dump returned bool(false),
// because there was no file that PHP could open.
// and it gave me this warning:
// PHP Warning: fopen(normal_file.txt): Failed to open stream: No such file or directory

// now I am trying to open an existing file
$file_resource = fopen("existed_file.txt", "r");

// then check the type:
var_dump($file_resource);

// it gives this:
// resource(5) of type (stream)
// now the variable's type is resource

?>
```

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

### Iterate directories recursively using RecursiveDirectoryIterator

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

Demonstrates the initialization of a recursive directory iterator to traverse file systems starting from a specified root path.

```php
recurse(new RecursiveDirectoryIterator('D:/'));
```

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

### ReflectionClass Constructor Example

Source: https://www.php.net/manual/en/class.reflectionclass.php

Demonstrates how to instantiate the ReflectionClass object to get information about a class. It takes either an object or a string representing the class name as input.

```php
<?php

// Create a ReflectionClass object for the built-in 'DateTime' class
$reflectionClass = new ReflectionClass('DateTime');

// Get the class name
echo "Class Name: " . $reflectionClass->getName() . "\n";

// Get the parent class
$parentClass = $reflectionClass->getParentClass();
if ($parentClass) {
    echo "Parent Class: " . $parentClass->getName() . "\n";
} else {
    echo "No parent class.\n";
}

// Check if the class is instantiable
if ($reflectionClass->isInstantiable()) {
    echo "The class is instantiable.\n";
} else {
    echo "The class is not instantiable.\n";
}

?>
```

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

### Initialize VarnishLog Class

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

Demonstrates the instantiation of the VarnishLog class, which allows for reading and parsing logs from a Varnish instance.

```php
$vl = new VarnishLog();
```

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

### Start PHP Built-in Web Server via CLI

Source: https://www.php.net/manual/en/features.commandline.webserver.php

Commands to initiate the PHP development server on a specific host and port. Optionally, a document root directory can be specified using the -t flag.

```bash
php -S localhost:8000
php -S localhost:8000 -t foo/
```

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

### ReflectionMethod::getDeclaringClass Example

Source: https://www.php.net/manual/en/class.reflectionmethod.php

Shows how to get the ReflectionClass object representing the class that declared the method using getDeclaringClass(). This is useful for inspecting the class context of a method.

```php
$reflectionMethod = new ReflectionMethod('MyClass', 'myMethod');
$declaringClass = $reflectionMethod->getDeclaringClass();
echo "Method declared in class: " . $declaringClass->getName();
```

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

### Define Yaf Application Configuration

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

An example of an application.ini configuration file using INI syntax. It supports section inheritance to manage environment-specific settings.

```ini
[yaf]
;APPLICATION_PATH is the constant defined in index.php
application.directory=APPLICATION_PATH "/application/"

;product section inherit from yaf section
[product:yaf]
foo=bar
```

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

### Securely Get Client IP Behind a Reverse Proxy in PHP

Source: https://www.php.net/manual/ru/reserved.variables.php

This example addresses the scenario where a web server is behind a reverse proxy. It suggests using the HTTP_X_FORWARDED_FOR variable to get the client's IP address, emphasizing the need for security configurations on both the proxy and the web server to prevent spoofing.

```php
<?php
// Accessing the client IP address when behind a reverse proxy
// Ensure the reverse proxy is configured to set this header correctly
// and the web server is configured to only accept connections from the proxy.
$client_ip = $_SERVER['HTTP_X_FORWARDED_FOR'] ?? $_SERVER['REMOTE_ADDR'];
echo "Client IP: " . $client_ip;
?>
```
Tokens:
Raw