inline docs revisions

o2system · Feb 9, 2019 · a5db547 · a5db547
1 parent 3b05b91
commit a5db547
Show file tree

Hide file tree

Showing 15 changed files with 210 additions and 49 deletions.
diff --git a/README.md b/README.md
@@ -1,18 +1,11 @@
-<div align="center" markdown="1">
-
 [![O2System Framework](http://o2system.id/assets/img/logo/logo-white-200px.png?logo)](http://o2system.id)
-</div>
-
-<div align="center" markdown="1">
 
 [![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)
 [![Build Status](https://scrutinizer-ci.com/g/o2system/filesystem/badges/build.png?b=master)](https://scrutinizer-ci.com/g/o2system/filesystem/build-status/master)
 [![Latest Stable Version](https://poser.pugx.org/o2system/filesystem/v/stable)](https://packagist.org/packages/o2system/filesystem)
 [![Total Downloads](https://poser.pugx.org/o2system/filesystem/downloads)](https://packagist.org/packages/o2system/filesystem)
 [![License](https://poser.pugx.org/o2system/filesystem/license)](https://packagist.org/packages/o2system/filesystem)
 
-</div>
-
 # O2System Filesystem
 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.
 
@@ -60,19 +53,12 @@ $downloader->download();
 Documentation is available on this repository [wiki](https://github.com/o2system/filesystem/wiki) or visit this repository [github page](https://o2system.github.io/filesystem).
 
 ### Ideas and Suggestions
-Please kindly mail us at [o2system.framework@gmail.com](mailto:o2system.framework@gmail.com])
+Please kindly mail us at [contact@o2system.id](mailto:contact@o2system.id])
 
 ### Bugs and Issues
 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.
 
 ### System Requirements
-- PHP 7.2+
+- PHP 7.2+ with FileInfo (finfo) extension
 - [Composer](https://getcomposer.org)
 - [O2System Kernel](https://github.com/o2system/kernel)
-
-### Credits
-|Role|Name|
-|----|----|
-|Founder and Lead Projects|[Steeven Andrian Salim](http://steevenz.com)|
-|Documentation|[Steeven Andrian Salim](http://steevenz.com)
-|Github Pages Designer| [Teguh Rianto](http://teguhrianto.tk)
diff --git a/src/Config/Mimes.php b/src/Config/Mimes.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * This file is part of the O2System PHP Framework package.
+ * This file is part of the O2System Framework package.
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.

diff --git a/src/Directory.php b/src/Directory.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * This file is part of the O2System PHP Framework package.
+ * This file is part of the O2System Framework package.
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
@@ -184,6 +184,15 @@ public function setOwner($user)
 
     // ------------------------------------------------------------------------
 
+    /**
+     * Directory::findFilesByExtension
+     *
+     * Find files by extension.
+     *
+     * @param string $extension
+     *
+     * @return array
+     */
     public function findFilesByExtension($extension)
     {
         $extension = trim($extension, '.');

diff --git a/src/File.php b/src/File.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * This file is part of the O2System PHP Framework package.
+ * This file is part of the O2System Framework package.
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.

diff --git a/src/Files/Abstracts/AbstractFile.php b/src/Files/Abstracts/AbstractFile.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * This file is part of the O2System PHP Framework package.
+ * This file is part of the O2System Framework package.
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.

diff --git a/src/Files/CsvFile.php b/src/Files/CsvFile.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * This file is part of the O2System PHP Framework package.
+ * This file is part of the O2System Framework package.
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.

diff --git a/src/Files/IniFile.php b/src/Files/IniFile.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * This file is part of the O2System PHP Framework package.
+ * This file is part of the O2System Framework package.
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
@@ -35,7 +35,7 @@ class IniFile extends AbstractFile
      *
      * @return mixed
      */
-    public function readFile($filePath, array $options = [])
+    public function readFile($filePath = null, array $options = [])
     {
         $items = parse_ini_file(
             $filePath,

diff --git a/src/Files/JsonFile.php b/src/Files/JsonFile.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * This file is part of the O2System PHP Framework package.
+ * This file is part of the O2System Framework package.
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
@@ -17,7 +17,7 @@
 
 use O2System\Filesystem\File;
 use O2System\Filesystem\Files\Abstracts\AbstractFile;
-use O2System\Spl\Datastructures\SplArrayObject;
+use O2System\Spl\DataStructures\SplArrayObject;
 use O2System\Spl\Iterators\ArrayIterator;
 
 /**

diff --git a/src/Files/XmlFile.php b/src/Files/XmlFile.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * This file is part of the O2System PHP Framework package.
+ * This file is part of the O2System Framework package.
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
@@ -17,7 +17,7 @@
 
 use O2System\Filesystem\File;
 use O2System\Filesystem\Files\Abstracts\AbstractFile;
-use O2System\Spl\Datastructures\SplArrayObject;
+use O2System\Spl\DataStructures\SplArrayObject;
 use O2System\Spl\Iterators\ArrayIterator;
 
 /**

diff --git a/src/Files/ZipFile.php b/src/Files/ZipFile.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * This file is part of the O2System PHP Framework package.
+ * This file is part of the O2System Framework package.
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
@@ -32,7 +32,7 @@ class ZipFile extends AbstractFile
      *
      * @return mixed
      */
-    public function readFile($filePath, array $options = [])
+    public function readFile($filePath = null, array $options = [])
     {
         $filePath = empty($filePath)
             ? $this->filePath