Read.php

Go to the documentation of this file.

<?php
namespace Magento\Framework\Filesystem\File;

use Magento\Framework\Filesystem\DriverInterface;
use Magento\Framework\Exception\FileSystemException;

class Read implements ReadInterface
{
    protected $path;

    protected $mode = 'r';

    protected $resource;

    protected $driver;

    public function __construct($path, DriverInterface $driver)
    {
        $this->path = $path;

        $this->driver = $driver;

        $this->open();
    }

    protected function open()
    {
        $this->assertValid();
        $this->resource = $this->driver->fileOpen($this->path, $this->mode);
        return $this;
    }

    protected function assertValid()
    {
        if (!$this->driver->isExists($this->path)) {
            throw new FileSystemException(
                new \Magento\Framework\Phrase('The "%1" file doesn\'t exist.', [$this->path])
            );
        }
        return true;
    }

    public function read($length)
    {
        return $this->driver->fileRead($this->resource, $length);
    }

    public function readAll($flag = null, $context = null)
    {
        return $this->driver->fileGetContents($this->path, $flag, $context);
    }

    public function readLine($length, $ending = null)
    {
        return $this->driver->fileReadLine($this->resource, $length, $ending);
    }

    public function readCsv($length = 0, $delimiter = ',', $enclosure = '"', $escape = '\\')
    {
        return $this->driver->fileGetCsv($this->resource, $length, $delimiter, $enclosure, $escape);
    }

    public function tell()
    {
        return $this->driver->fileTell($this->resource);
    }

    public function seek($offset, $whence = SEEK_SET)
    {
        return $this->driver->fileSeek($this->resource, $offset, $whence);
    }

    public function eof()
    {
        return $this->driver->endOfFile($this->resource);
    }

    public function close()
    {
        return $this->driver->fileClose($this->resource);
    }

    public function stat()
    {
        return $this->driver->stat($this->path);
    }
}