Http Class Reference

Inheritance diagram for Http:

Public Member Functions
	isExists ($path)
	stat ($path)
	fileGetContents ($path, $flags=null, $context=null)
	filePutContents ($path, $content, $mode=null, $context=null)
	fileOpen ($path, $mode)
	fileReadLine ($resource, $length, $ending=null)
	getAbsolutePath ($basePath, $path, $scheme=null)
Public Member Functions inherited from File
	isExists ($path)
	stat ($path)
	isReadable ($path)
	isFile ($path)
	isDirectory ($path)
	fileGetContents ($path, $flag=null, $context=null)
	isWritable ($path)
	getParentDirectory ($path)
	createDirectory ($path, $permissions=0777)
	search ($pattern, $path)
	rename ($oldPath, $newPath, DriverInterface $targetDriver=null)
	copy ($source, $destination, DriverInterface $targetDriver=null)
	symlink ($source, $destination, DriverInterface $targetDriver=null)
	deleteFile ($path)
	changePermissions ($path, $permissions)
	touch ($path, $modificationTime=null)
	filePutContents ($path, $content, $mode=null)
	fileOpen ($path, $mode)
	fileReadLine ($resource, $length, $ending=null)
	fileRead ($resource, $length)
	fileGetCsv ($resource, $length=0, $delimiter=',', $enclosure='"', $escape = '\\')
	fileTell ($resource)
	fileSeek ($resource, $offset, $whence=SEEK_SET)
	endOfFile ($resource)
	fileClose ($resource)
	fileWrite ($resource, $data)
	fileFlush ($resource)
	fileLock ($resource, $lockMode=LOCK_EX)
	fileUnlock ($resource)
	getAbsolutePath ($basePath, $path, $scheme=null)
	getRelativePath ($basePath, $path=null)
	getRealPath ($path)
	getRealPathSafety ($path)
Public Member Functions inherited from DriverInterface
	readDirectory ($path)
	readDirectoryRecursively ($path=null)
	deleteDirectory ($path)
	changePermissionsRecursively ($path, $dirPermissions, $filePermissions)
	filePutCsv ($resource, array $data, $delimiter=',', $enclosure='"')

Protected Member Functions
	getScheme ($scheme=null)
	open ($hostname, $port)
	parseUrl ($path)
Protected Member Functions inherited from File
	getWarningMessage ()
	fixSeparator ($path)
	getScheme ($scheme=null)

Protected Attributes
	$scheme = 'http'
Protected Attributes inherited from File
	$scheme = ''

Additional Inherited Members
Data Fields inherited from DriverInterface
const	WRITEABLE_DIRECTORY_MODE = 0770
const	WRITEABLE_FILE_MODE = 0660

Detailed Description

Class Http

Definition at line 17 of file Http.php.

Member Function Documentation

fileGetContents()

fileGetContents	(		$path,
			$flags = null,
			$context = null
	)

Retrieve file contents from given path

Parameters

string	$path
string | null	$flags
resource | null	$context

Returns

string

Exceptions

FileSystemException

Implements DriverInterface.

Definition at line 88 of file Http.php.

    {
        clearstatcache();
        $result = @file_get_contents($this->getScheme() . $path, $flags, $context);
        if (false === $result) {
            throw new FileSystemException(
                new \Magento\Framework\Phrase(
                    'The contents from the "%1" file can\'t be read. %2',
                    [$path, $this->getWarningMessage()]
                )
            );
        }
        return $result;
    }

fileOpen()

fileOpen	(		$path,
			$mode
	)

Open file

Parameters

string	$path
string	$mode

Returns

resource file

Exceptions

FileSystemException

@SuppressWarnings(PHPMD.UnusedFormalParameter)

Implements DriverInterface.

Definition at line 136 of file Http.php.

    {
        $urlProp = $this->parseUrl($this->getScheme() . $path);

        if (false === $urlProp) {
            throw new FileSystemException(
                new \Magento\Framework\Phrase('The download URL is incorrect. Verify and try again.')
            );
        }

        $hostname = $urlProp['host'];
        $port = 80;

        if (isset($urlProp['port'])) {
            $port = (int)$urlProp['port'];
        }

        $path = '/';
        if (isset($urlProp['path'])) {
            $path = $urlProp['path'];
        }

        $query = '';
        if (isset($urlProp['query'])) {
            $query = '?' . $urlProp['query'];
        }

        $result = $this->open($hostname, $port);

        $headers = 'GET ' .
            $path .
            $query .
            ' HTTP/1.0' .
            "\r\n" .
            'Host: ' .
            $hostname .
            "\r\n" .
            'User-Agent: Magento' .
            "\r\n" .
            'Connection: close' .
            "\r\n" .
            "\r\n";

        fwrite($result, $headers);

        // trim headers
        while (!feof($result)) {
            $str = fgets($result, 1024);
            if ($str == "\r\n") {
                break;
            }
        }

        return $result;
    }

filePutContents()

filePutContents	(		$path,
			$content,
			$mode = null,
			$context = null
	)

Open file in given path

Parameters

string	$path
string	$content
string | null	$mode
resource | null	$context

Returns

int The number of bytes that were written

Exceptions

FileSystemException

Definition at line 113 of file Http.php.

    {
        $result = @file_put_contents($this->getScheme() . $path, $content, $mode, $context);
        if (!$result) {
            throw new FileSystemException(
                new \Magento\Framework\Phrase(
                    'The specified "%1" file couldn\'t be written. %2',
                    [$path, $this->getWarningMessage()]
                )
            );
        }
        return $result;
    }

fileReadLine()

fileReadLine	(		$resource,
			$length,
			$ending = null
	)

Reads the line content from file pointer (with specified number of bytes from the current position).

Parameters

resource	$resource
int	$length
string	$ending	[optional]

Returns

string

Exceptions

FileSystemException

Implements DriverInterface.

Definition at line 201 of file Http.php.

    {
        $result = @stream_get_line($resource, $length, $ending);

        return $result;
    }

getAbsolutePath()

getAbsolutePath	(		$basePath,
			$path,
			$scheme = null
	)

Get absolute path

Parameters

string	$basePath
string	$path
string | null	$scheme

Returns

string @SuppressWarnings(PHPMD.UnusedFormalParameter)

Implements DriverInterface.

Definition at line 217 of file Http.php.

    {
        // check if the path given is already an absolute path containing the
        // basepath. so if the basepath starts at position 0 in the path, we
        // must not concatinate them again because path is already absolute.
        if (0 === strpos($path, $basePath)) {
            return $this->getScheme() . $path;
        }

        return $this->getScheme() . $basePath . $path;
    }

getScheme()

getScheme (   $scheme = null )

protected

Return path with scheme

Parameters

null | string

$scheme

Returns

string

Definition at line 235 of file Http.php.

    {
        $scheme = $scheme ?: $this->scheme;
        return $scheme ? $scheme . '://' : '';
    }

isExists()

isExists

(

$path

)

Checks if path exists

Parameters

string

$path

Returns

bool

Exceptions

FileSystemException

Implements DriverInterface.

Definition at line 33 of file Http.php.

    {
        $headers = array_change_key_case(get_headers($this->getScheme() . $path, 1), CASE_LOWER);

        $status = $headers[0];

        if (strpos($status, '200 OK') === false) {
            $result = false;
        } else {
            $result = true;
        }

        return $result;
    }

open()

open (   $hostname,   $port  )

protected

Open a url

Parameters

string	$hostname
int	$port

Exceptions

Definition at line 249 of file Http.php.

    {
        $result = @fsockopen($hostname, $port, $errorNumber, $errorMessage);
        if ($result === false) {
            throw new FileSystemException(
                new \Magento\Framework\Phrase(
                    'Something went wrong while connecting to the host. Error#%1 - %2.',
                    [$errorNumber, $errorMessage]
                )
            );
        }
        return $result;
    }

parseUrl()

parseUrl (   $path )

protected

Parse a http url

Parameters

string

$path

Returns

array

Definition at line 269 of file Http.php.

    {
        return parse_url($path);
    }

stat()

stat

(

$path

)

Gathers the statistics of the given path

Parameters

string

$path

Returns

array @SuppressWarnings(PHPMD.NPathComplexity)

Implements DriverInterface.

Definition at line 55 of file Http.php.

    {
        $headers = array_change_key_case(get_headers($this->getScheme() . $path, 1), CASE_LOWER);

        $result = [
            'dev' => 0,
            'ino' => 0,
            'mode' => 0,
            'nlink' => 0,
            'uid' => 0,
            'gid' => 0,
            'rdev' => 0,
            'atime' => 0,
            'ctime' => 0,
            'blksize' => 0,
            'blocks' => 0,
            'size' => isset($headers['content-length']) ? $headers['content-length'] : 0,
            'type' => isset($headers['content-type']) ? $headers['content-type'] : '',
            'mtime' => isset($headers['last-modified']) ? $headers['last-modified'] : 0,
            'disposition' => isset($headers['content-disposition']) ? $headers['content-disposition'] : null,
        ];
        return $result;
    }

Field Documentation

$scheme

$scheme = 'http'

protected

Definition at line 24 of file Http.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/framework/Filesystem/Driver/Http.php