Skip to content

Commit a5db547

Browse files
steevenzsteevenz
committed
inline docs revisions
1 parent 3b05b91 commit a5db547

File tree

15 files changed

+210
-49
lines changed

15 files changed

+210
-49
lines changed

‎README.md‎

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,11 @@
1-
<div align="center" markdown="1">
2-
31
[![O2System Framework](http://o2system.id/assets/img/logo/logo-white-200px.png?logo)](http://o2system.id)
4-
</div>
5-
6-
<div align="center" markdown="1">
72

83
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/o2system/filesystem/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/o2system/filesystem/?branch=master)
94
[![Build Status](https://scrutinizer-ci.com/g/o2system/filesystem/badges/build.png?b=master)](https://scrutinizer-ci.com/g/o2system/filesystem/build-status/master)
105
[![Latest Stable Version](https://poser.pugx.org/o2system/filesystem/v/stable)](https://packagist.org/packages/o2system/filesystem)
116
[![Total Downloads](https://poser.pugx.org/o2system/filesystem/downloads)](https://packagist.org/packages/o2system/filesystem)
127
[![License](https://poser.pugx.org/o2system/filesystem/license)](https://packagist.org/packages/o2system/filesystem)
138

14-
</div>
15-
169
# O2System Filesystem
1710
O2System Filesystem is an Open Source PHP Convenience Library for reading, writing and appending data from and into files and directories, which is built for working more powerfully with O2System Framework, but it also can be used with other frameworks as a standalone version with limited features.
1811

@@ -60,19 +53,12 @@ $downloader->download();
6053
Documentation is available on this repository [wiki](https://github.com/o2system/filesystem/wiki) or visit this repository [github page](https://o2system.github.io/filesystem).
6154

6255
### Ideas and Suggestions
63-
Please kindly mail us at [o2system.[email protected]](mailto:o2system.[email protected]])
56+
Please kindly mail us at [contact@o2system.id](mailto:contact@o2system.id])
6457

6558
### Bugs and Issues
6659
Please kindly submit your [issues at Github](http://github.com/o2system/filesystem/issues) so we can track all the issues along development and send a [pull request](http://github.com/o2system/filesystem/pulls) to this repository.
6760

6861
### System Requirements
69-
- PHP 7.2+
62+
- PHP 7.2+ with FileInfo (finfo) extension
7063
- [Composer](https://getcomposer.org)
7164
- [O2System Kernel](https://github.com/o2system/kernel)
72-
73-
### Credits
74-
|Role|Name|
75-
|----|----|
76-
|Founder and Lead Projects|[Steeven Andrian Salim](http://steevenz.com)|
77-
|Documentation|[Steeven Andrian Salim](http://steevenz.com)
78-
|Github Pages Designer| [Teguh Rianto](http://teguhrianto.tk)

‎src/Config/Mimes.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?php
22
/**
3-
* This file is part of the O2System PHP Framework package.
3+
* This file is part of the O2System Framework package.
44
*
55
* For the full copyright and license information, please view the LICENSE
66
* file that was distributed with this source code.

‎src/Directory.php‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?php
22
/**
3-
* This file is part of the O2System PHP Framework package.
3+
* This file is part of the O2System Framework package.
44
*
55
* For the full copyright and license information, please view the LICENSE
66
* file that was distributed with this source code.
@@ -184,6 +184,15 @@ public function setOwner($user)
184184

185185
// ------------------------------------------------------------------------
186186

187+
/**
188+
* Directory::findFilesByExtension
189+
*
190+
* Find files by extension.
191+
*
192+
* @param string $extension
193+
*
194+
* @return array
195+
*/
187196
public function findFilesByExtension($extension)
188197
{
189198
$extension = trim($extension, '.');

‎src/File.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?php
22
/**
3-
* This file is part of the O2System PHP Framework package.
3+
* This file is part of the O2System Framework package.
44
*
55
* For the full copyright and license information, please view the LICENSE
66
* file that was distributed with this source code.

‎src/Files/Abstracts/AbstractFile.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?php
22
/**
3-
* This file is part of the O2System PHP Framework package.
3+
* This file is part of the O2System Framework package.
44
*
55
* For the full copyright and license information, please view the LICENSE
66
* file that was distributed with this source code.

‎src/Files/CsvFile.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?php
22
/**
3-
* This file is part of the O2System PHP Framework package.
3+
* This file is part of the O2System Framework package.
44
*
55
* For the full copyright and license information, please view the LICENSE
66
* file that was distributed with this source code.

‎src/Files/IniFile.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?php
22
/**
3-
* This file is part of the O2System PHP Framework package.
3+
* This file is part of the O2System Framework package.
44
*
55
* For the full copyright and license information, please view the LICENSE
66
* file that was distributed with this source code.
@@ -35,7 +35,7 @@ class IniFile extends AbstractFile
3535
*
3636
* @return mixed
3737
*/
38-
public function readFile($filePath, array $options = [])
38+
public function readFile($filePath = null, array $options = [])
3939
{
4040
$items = parse_ini_file(
4141
$filePath,

‎src/Files/JsonFile.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?php
22
/**
3-
* This file is part of the O2System PHP Framework package.
3+
* This file is part of the O2System Framework package.
44
*
55
* For the full copyright and license information, please view the LICENSE
66
* file that was distributed with this source code.
@@ -17,7 +17,7 @@
1717

1818
use O2System\Filesystem\File;
1919
use O2System\Filesystem\Files\Abstracts\AbstractFile;
20-
use O2System\Spl\Datastructures\SplArrayObject;
20+
use O2System\Spl\DataStructures\SplArrayObject;
2121
use O2System\Spl\Iterators\ArrayIterator;
2222

2323
/**

‎src/Files/XmlFile.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?php
22
/**
3-
* This file is part of the O2System PHP Framework package.
3+
* This file is part of the O2System Framework package.
44
*
55
* For the full copyright and license information, please view the LICENSE
66
* file that was distributed with this source code.
@@ -17,7 +17,7 @@
1717

1818
use O2System\Filesystem\File;
1919
use O2System\Filesystem\Files\Abstracts\AbstractFile;
20-
use O2System\Spl\Datastructures\SplArrayObject;
20+
use O2System\Spl\DataStructures\SplArrayObject;
2121
use O2System\Spl\Iterators\ArrayIterator;
2222

2323
/**

‎src/Files/ZipFile.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?php
22
/**
3-
* This file is part of the O2System PHP Framework package.
3+
* This file is part of the O2System Framework package.
44
*
55
* For the full copyright and license information, please view the LICENSE
66
* file that was distributed with this source code.
@@ -32,7 +32,7 @@ class ZipFile extends AbstractFile
3232
*
3333
* @return mixed
3434
*/
35-
public function readFile($filePath, array $options = [])
35+
public function readFile($filePath = null, array $options = [])
3636
{
3737
$filePath = empty($filePath)
3838
? $this->filePath

0 commit comments

Comments
 (0)