<?php /** * Hoa * * * @license * * New BSD License * * Copyright © 2007-2017, Hoa community. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * Neither the name of the Hoa nor the names of its contributors may be * used to endorse or promote products derived from this software without * specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. */ namespace Psy\Readline\Hoa; /** * Class \Hoa\File\Link\Read. * * File handler. * * @license New BSD License */ class FileLinkRead extends FileLink implements StreamIn { /** * Open a file. * * @param string $streamName stream name * @param string $mode open mode, see the parent::MODE_* constants * @param string $context context ID (please, see the * \Hoa\Stream\Context class) * @param bool $wait differ opening or not */ public function __construct( string $streamName, string $mode = parent::MODE_READ, string $context = null, bool $wait = false ) { parent::__construct($streamName, $mode, $context, $wait); return; } /** * Open the stream and return the associated resource. * * @param string $streamName Stream name (e.g. path or URL). * @param \Hoa\Stream\Context $context context * * @return resource * * @throws \Hoa\File\Exception\FileDoesNotExist * @throws \Hoa\File\Exception */ protected function &_open(string $streamName, StreamContext $context = null) { static $createModes = [ parent::MODE_READ, ]; if (!\in_array($this->getMode(), $createModes)) { throw new FileException('Open mode are not supported; given %d. Only %s are supported.', 0, [$this->getMode(), \implode(', ', $createModes)]); } \preg_match('#^(\w+)://#', $streamName, $match); if (((isset($match[1]) && $match[1] === 'file') || !isset($match[1])) && !\file_exists($streamName)) { throw new FileDoesNotExistException('File %s does not exist.', 1, $streamName); } $out = parent::_open($streamName, $context); return $out; } /** * Test for end-of-file. * * @return bool */ public function eof(): bool { return \feof($this->getStream()); } /** * Read n characters. * * @param int $length length * * @return string * * @throws \Hoa\File\Exception */ public function read(int $length) { if (0 > $length) { throw new FileException('Length must be greater than 0, given %d.', 2, $length); } return \fread($this->getStream(), $length); } /** * Alias of $this->read(). * * @param int $length length * * @return string */ public function readString(int $length) { return $this->read($length); } /** * Read a character. * * @return string */ public function readCharacter() { return \fgetc($this->getStream()); } /** * Read a boolean. * * @return bool */ public function readBoolean() { return (bool) $this->read(1); } /** * Read an integer. * * @param int $length length * * @return int */ public function readInteger(int $length = 1) { return (int) $this->read($length); } /** * Read a float. * * @param int $length length * * @return float */ public function readFloat(int $length = 1) { return (float) $this->read($length); } /** * Read an array. * Alias of the $this->scanf() method. * * @param string $format format (see printf's formats) * * @return array */ public function readArray(string $format = null) { return $this->scanf($format); } /** * Read a line. * * @return string */ public function readLine() { return \fgets($this->getStream()); } /** * Read all, i.e. read as much as possible. * * @param int $offset offset * * @return string */ public function readAll(int $offset = 0) { return \stream_get_contents($this->getStream(), -1, $offset); } /** * Parse input from a stream according to a format. * * @param string $format format (see printf's formats) * * @return array */ public function scanf(string $format): array { return \fscanf($this->getStream(), $format); } }
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
Terminfo | Folder | 0755 |
|
|
Autocompleter.php | File | 2.08 KB | 0644 |
|
AutocompleterAggregate.php | File | 3.26 KB | 0644 |
|
AutocompleterPath.php | File | 4.92 KB | 0644 |
|
AutocompleterWord.php | File | 3.1 KB | 0644 |
|
Console.php | File | 7.8 KB | 0644 |
|
ConsoleCursor.php | File | 20.35 KB | 0644 |
|
ConsoleException.php | File | 1.77 KB | 0644 |
|
ConsoleInput.php | File | 4.15 KB | 0644 |
|
ConsoleOutput.php | File | 5.23 KB | 0644 |
|
ConsoleProcessus.php | File | 20.43 KB | 0644 |
|
ConsoleTput.php | File | 20.9 KB | 0644 |
|
ConsoleWindow.php | File | 12.15 KB | 0644 |
|
Event.php | File | 5.94 KB | 0644 |
|
EventBucket.php | File | 2.88 KB | 0644 |
|
EventException.php | File | 1.74 KB | 0644 |
|
EventListenable.php | File | 1.89 KB | 0644 |
|
EventListener.php | File | 3.99 KB | 0644 |
|
EventListens.php | File | 2.59 KB | 0644 |
|
EventSource.php | File | 1.74 KB | 0644 |
|
Exception.php | File | 2.66 KB | 0644 |
|
ExceptionIdle.php | File | 7.07 KB | 0644 |
|
File.php | File | 7.67 KB | 0644 |
|
FileDirectory.php | File | 6.33 KB | 0644 |
|
FileDoesNotExistException.php | File | 1.83 KB | 0644 |
|
FileException.php | File | 1.8 KB | 0644 |
|
FileFinder.php | File | 15.77 KB | 0644 |
|
FileGeneric.php | File | 11.17 KB | 0644 |
|
FileLink.php | File | 4.19 KB | 0644 |
|
FileLinkRead.php | File | 5.84 KB | 0644 |
|
FileLinkReadWrite.php | File | 6.81 KB | 0644 |
|
FileRead.php | File | 4.58 KB | 0644 |
|
FileReadWrite.php | File | 6.8 KB | 0644 |
|
IStream.php | File | 1.82 KB | 0644 |
|
IteratorFileSystem.php | File | 2.74 KB | 0644 |
|
IteratorRecursiveDirectory.php | File | 3.71 KB | 0644 |
|
IteratorSplFileInfo.php | File | 3.22 KB | 0644 |
|
Protocol.php | File | 6.43 KB | 0644 |
|
ProtocolException.php | File | 1.74 KB | 0644 |
|
ProtocolNode.php | File | 7.92 KB | 0644 |
|
ProtocolNodeLibrary.php | File | 3.14 KB | 0644 |
|
ProtocolWrapper.php | File | 13.38 KB | 0644 |
|
Readline.php | File | 26.37 KB | 0644 |
|
Stream.php | File | 14.51 KB | 0644 |
|
StreamBufferable.php | File | 2.43 KB | 0644 |
|
StreamContext.php | File | 3.54 KB | 0644 |
|
StreamException.php | File | 1.77 KB | 0644 |
|
StreamIn.php | File | 2.81 KB | 0644 |
|
StreamLockable.php | File | 2.55 KB | 0644 |
|
StreamOut.php | File | 2.66 KB | 0644 |
|
StreamPathable.php | File | 1.97 KB | 0644 |
|
StreamPointable.php | File | 2.39 KB | 0644 |
|
StreamStatable.php | File | 2.99 KB | 0644 |
|
StreamTouchable.php | File | 3.09 KB | 0644 |
|
Ustring.php | File | 5.01 KB | 0644 |
|
Xcallable.php | File | 7.18 KB | 0644 |
|