HeaderContainer.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Rest;
 
class HeaderContainer {
    private $headerLists = [];
    private $headerLines = [];
    private $headerNames = [];
 
    public function resetHeaders( $headers = [] ) {
        $this->headerLines = [];
        $this->headerLists = [];
        $this->headerNames = [];
        foreach ( $headers as $name => $value ) {
            $this->headerNames[ strtolower( $name ) ] = $name;
            list( $valueParts, $valueLine ) = $this->convertToListAndString( $value );
            $this->headerLines[$name] = $valueLine;
            $this->headerLists[$name] = $valueParts;
        }
    }
 
    private function convertToListAndString( $value ) {
        if ( is_array( $value ) ) {
            return [ array_values( $value ), implode( ', ', $value ) ];
        } else {
            return [ [ $value ], $value ];
        }
    }
 
    public function setHeader( $name, $value ) {
        list( $valueParts, $valueLine ) = $this->convertToListAndString( $value );
        $lowerName = strtolower( $name );
        $origName = $this->headerNames[$lowerName] ?? null;
        if ( $origName !== null ) {
            unset( $this->headerLines[$origName] );
            unset( $this->headerLists[$origName] );
        }
        $this->headerNames[$lowerName] = $name;
        $this->headerLines[$name] = $valueLine;
        $this->headerLists[$name] = $valueParts;
    }
 
    public function addHeader( $name, $value ) {
        list( $valueParts, $valueLine ) = $this->convertToListAndString( $value );
        $lowerName = strtolower( $name );
        $origName = $this->headerNames[$lowerName] ?? null;
        if ( $origName === null ) {
            $origName = $name;
            $this->headerNames[$lowerName] = $origName;
            $this->headerLines[$origName] = $valueLine;
            $this->headerLists[$origName] = $valueParts;
        } else {
            $this->headerLines[$origName] .= ', ' . $valueLine;
            $this->headerLists[$origName] = array_merge( $this->headerLists[$origName],
                $valueParts );
        }
    }
 
    public function removeHeader( $name ) {
        $lowerName = strtolower( $name );
        $origName = $this->headerNames[$lowerName] ?? null;
        if ( $origName !== null ) {
            unset( $this->headerNames[$lowerName] );
            unset( $this->headerLines[$origName] );
            unset( $this->headerLists[$origName] );
        }
    }
 
    public function getHeaders() {
        return $this->headerLists;
    }
 
    public function getHeader( $name ) {
        $headerName = $this->headerNames[ strtolower( $name ) ] ?? null;
        if ( $headerName === null ) {
            return [];
        }
        return $this->headerLists[$headerName];
    }
 
    public function hasHeader( $name ) {
        return isset( $this->headerNames[ strtolower( $name ) ] );
    }
 
    public function getHeaderLine( $name ) {
        $headerName = $this->headerNames[ strtolower( $name ) ] ?? null;
        if ( $headerName === null ) {
            return '';
        }
        return $this->headerLines[$headerName];
    }
 
    public function getHeaderLines() {
        return $this->headerLines;
    }
 
    public function getRawHeaderLines() {
        $lines = [];
        foreach ( $this->headerNames as $lowerName => $name ) {
            if ( $lowerName === 'set-cookie' ) {
                // As noted by RFC 7230 section 3.2.2, Set-Cookie is the only
                // header for which multiple values cannot be concatenated into
                // a single comma-separated line.
                foreach ( $this->headerLists[$name] as $value ) {
                    $lines[] = "$name: $value";
                }
            } else {
                $lines[] = "$name: " . $this->headerLines[$name];
            }
        }
        return $lines;
    }
}