stream_context_set_option - PHP code example

The PHP Function Stream_Context_Set_Option

PHP is a language that allows you to create your own functions. Functions work like variables within your program and are called with the name of the function, along with any parameters that you want to pass with the function call. Parameters are the values that you pass to the function, and you can use them to set or get different context options.

The php function stream_context_set_option lets you set or reset different context options for any PHP stream. For example, you can set or reset the notification code and severity options. These options are used to notify the user of any errors that might be encountered. The php function also lets you set or get the bytes_transferred option which is used to track how many bytes of data are transferred between a server and the client.

Streams are an integral part of PHP since version 4.3.0 and no steps are required to enable them. The built-in wrappers support a variety of protocols and encodings, but additional custom wrappers can be added either in a script using the stream_wrapper_register() function or from an extension.

A wrapper is additional code that tells the stream how to handle specific protocol/encoding combinations. It may also perform some operations on the data as it is read from or written to a stream, such as compression or parsing. There are several wrappers built-in to PHP by default, but other wrappers can be added by the use of the stream_wrapper_register() or stream_wrapper_set_params() functions.

stream_context_set_option example

            if (\in_array($info['http_code'], [301, 302, 303], true)) {
                $options = stream_context_get_options($context)['http'];

                if ('POST' === $options['method'] || 303 === $info['http_code']) {
                    $info['http_method'] = $options['method'] = 'HEAD' === $options['method'] ? 'HEAD' : 'GET';
                    $options['content'] = '';
                    $filterContentHeaders = static fn ($h) => 0 !== stripos($h, 'Content-Length:') && 0 !== stripos($h, 'Content-Type:') && 0 !== stripos($h, 'Transfer-Encoding:');
                    $options['header'] = array_filter($options['header'], $filterContentHeaders);
                    $redirectHeaders['no_auth'] = array_filter($redirectHeaders['no_auth'], $filterContentHeaders);
                    $redirectHeaders['with_auth'] = array_filter($redirectHeaders['with_auth'], $filterContentHeaders);

                    stream_context_set_option($context, ['http' => $options]);
                }
            }

            [$host, $port] = self::parseHostPort($url, $info);

            if (false !== (parse_url($location, \PHP_URL_HOST) ?? false)) {
                // Authorization and Cookie headers MUST NOT follow except for the initial host name                 $requestHeaders = $redirectHeaders['host'] === $host && $redirectHeaders['port'] === $port ? $redirectHeaders['with_auth'] : $redirectHeaders['no_auth'];
                $requestHeaders[] = 'Host: '.$host.$port;
                $dnsResolve = !self::configureHeadersAndProxy($context, $host, $requestHeaders, $proxy, 'https:' === $url['scheme']);
            } else {

'headers' => [
                'Content-Type' => 'application/x-www-form-urlencoded; charset=utf-8',
            ],
        ], $defaults);

        $this->assertContains('Content-Type: application/x-www-form-urlencoded; charset=utf-8', $options['headers']);
    }

    public function testNormalizeBodyMultipart()
    {
        $file = fopen('php://memory', 'r+');
        stream_context_set_option($file, ['http' => [
            'filename' => 'test.txt',
            'content_type' => 'text/plain',
        ]]);
        fwrite($file, 'foobarbaz');
        rewind($file);

        $headers = [
            'content-type' => ['Content-Type: multipart/form-data; boundary=ABCDEF'],
        ];
        $body = [
            'foo[]' => 'bar',

$verifyname                          = false;
                } elseif (is_string($options['verify'])) {
                    $context_options['cafile'] = $options['verify'];
                }
            }

            if (isset($options['verifyname']) && $options['verifyname'] === false) {
                $context_options['verify_peer_name'] = false;
                $verifyname                          = false;
            }

            stream_context_set_option($context, ['ssl' => $context_options]);
        } else {
            $remote_socket = 'tcp://' . $host;
        }

        $this->max_bytes = $options['max_bytes'];

        if (!isset($url_parts['port'])) {
            $url_parts['port'] = Port::HTTP;
        }

        $remote_socket .= ':' . $url_parts['port'];

// If we are connected to the wrong host, disconnect first         if (($this->connected_to[0] != $host || $this->connected_to[1] != $port)) {
            if (is_resource($this->socket)) $this->close();
        }

        // Now, if we are not connected, connect         if (! is_resource($this->socket) || ! $this->config['keepalive']) {
            $context = $this->getStreamContext();
            if ($secure || $this->config['sslusecontext']) {
                if ($this->config['sslcert'] !== null) {
                    if (! stream_context_set_option($context, 'ssl', 'local_cert',
                                                    $this->config['sslcert'])) {
                        throw new Zend_Http_Client_Adapter_Exception('Unable to set sslcert option');
                    }
                }
                if ($this->config['sslpassphrase'] !== null) {
                    if (! stream_context_set_option($context, 'ssl', 'passphrase',
                                                    $this->config['sslpassphrase'])) {
                        throw new Zend_Http_Client_Adapter_Exception('Unable to set sslpassphrase option');
                    }
                }
            }