Update filedriver:1.0 notice

This commit is contained in:
xdrm-brackets 2017-09-09 18:00:52 +02:00
parent 6b39bf9ba0
commit 612e3ed9fe
1 changed files with 13 additions and 13 deletions

View File

@ -8,13 +8,13 @@ Overview
----
##### 1. Introduction
The `filedriver` package allows you to **create**, **read** and **write** files easily and with optimization (cf. SplFileObject).
The `filedriver` package allows you to **create**, **read** and **write** files easily and with optimization (cf. [SplFileObject](http://php.net/manual/en/class.splfileobject.php)).
To make it easier and generic, all methods are static.
Setup
----
> 1. Include the autoloader
> ### 1. Include the autoloader
```php
<?php
@ -24,7 +24,7 @@ Setup
...
```
> 2. Load the `FileDriver` class
> ### 2. Load the `FileDriver` class
```php
<?php
@ -42,35 +42,35 @@ Usage
##### `create` - creates or empty a file
> ```php
```php
<?php
create(String $filename) : bool
public static function create(String $filename) : bool
```
##### `read` - reads a whole file
> ```php
```php
<?php
read(String $filename) : String
public static function read(String $filename) : String
```
##### `readline` - reads a specific line
> ```php
```php
<?php
readline(String $filename, Integer $line) : String
public static function readline(String $filename, Integer $line) : String
```
##### `write` - writes content (erase if not empty)
> ```php
```php
<?php
write(String $filename, String $content) : bool
public static function write(String $filename, String $content) : bool
```
##### `append` - append content at the end of a file
> ```php
```php
<?php
append(String $filename, String $content) : bool
public static function append(String $filename, String $content) : bool
```