https://github.com/elusivecodes/fyrestream
FyreStream is a free, open-source stream library for PHP.
https://github.com/elusivecodes/fyrestream
Last synced: 6 months ago
JSON representation
FyreStream is a free, open-source stream library for PHP.
- Host: GitHub
- URL: https://github.com/elusivecodes/fyrestream
- Owner: elusivecodes
- License: mit
- Created: 2022-06-16T09:02:41.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-29T06:31:58.000Z (11 months ago)
- Last Synced: 2024-06-30T10:24:04.240Z (11 months ago)
- Language: PHP
- Size: 49.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FyreStream
**FyreStream** is a free, open-source stream library for *PHP*.
## Table Of Contents
- [Installation](#installation)
- [Basic Usage](#basic-usage)
- [Methods](#methods)
## Installation
**Using Composer**
```
composer require fyre/stream
```
In PHP:
```php
use Fyre\Stream\Stream;
```
## Basic Usage
- `$resource` is a resource.
```php
$stream = new Stream($resource);
```
**From File**
- `$filePath` is a string representing the file path.
- `$mode` is a string representing the file access mode, and will default to "*r*".
```php
$stream = Stream::fromFile($filePath, $mode);
```
## Methods
**Close**
Close the resource.
```php
$stream->close();
```
**Contents**
Get the contents of the stream.
```php
$contents = $stream->contents();
```
**Ended**
Determine whether the stream has ended.
```php
$ended = $stream->ended();
```
**Is Readable**
Determine whether the stream is readable.
```php
$isReadable = $stream->isReadable();
```
**Is Seekable**
Determine whether the stream is seekable.
```php
$isSeekable = $stream->isSeekable();
```
**Is Writable**
Determine whether the stream is writable.
```php
$isWritable = $stream->isWritable();
```
**Read**
Read data from the stream.
- `$length` is a number representing the number of bytes to read.
```php
$data = $stream->read($length);
```
**Rewind**
Rewind the stream.
```php
$stream->rewind();
```
**Seek**
Move the pointer in the stream.
- `$offset` is a number representing the offset.
- `$whence` is a number representing the offset origin, and will default to *SEEK_SET*.
```php
$stream->seek($offset, $whence);
```
**Size**
Get the size of the stream.
```php
$size = $stream->size();
```
**Tell**
Get the offset of the pointer.
```php
$offset = $stream->tell();
```
**Write**
Write data to the stream.
- `$data` is a string representing the data to write.
```php
$written = $stream->write($data);
```