xdrm-framework/notice/filedriver/1.0.md

module: filedriver
version: 1.0
requires: null

Overview

1. Introduction

The filedriver package allows you to create, read and write files easily and with optimization (cf. SplFileObject).

To make it easier and generic, all methods are static.

Setup

1. Include the autoloader

<?php

	require_once '../autoloader.php';

	...

2. Load the FileDriver class

<?php

	...

	use \filedriver\core\FileDriver;

Usage

FileDriver

create - creates or empty a file

<?php
	public static function create(String $filename) : bool

read - reads a whole file

<?php
	public static function read(String $filename) : String

readline - reads a specific line

<?php
	public static function readline(String $filename, Integer $line) : String

write - writes content (erase if not empty)

<?php
	public static function write(String $filename, String $content) : bool

append - append content at the end of a file

<?php
	public static function append(String $filename, String $content) : bool