php file

PHPファイルライブラリ

ヴェルシオン・エスパニョール

ファイル管理のためのPHPライブラリ。

---

• 要件
• インストール
• 利用可能な方法
• クイックスタート
• 使用法
• テスト
• ライセンス

---

要件

このライブラリは、 PHPバージョン5.6以上でサポートされており、 HHVMバージョン3.0以降と互換性があります。

インストール

この拡張機能をインストールするための好ましい方法は、Composerを通じてです。

PHPファイルライブラリをインストールするには、単純に：

 composer require Josantonius/File

前のコマンドは、必要なファイルのみをインストールします。使用できるソースコード全体をダウンロードする場合は、次のことです。

 composer require Josantonius/File --prefer-source

Gitで完全なリポジトリをクローンすることもできます。

$ git clone https://github.com/josantonius/php-file.git

または、手動でインストールします。

file.phpをダウンロード：

 wget https://raw.githubusercontent.com/Josantonius/PHP-File/master/src/File.php

利用可能な方法

このライブラリで利用可能な方法：

- パスまたはURLにファイルが存在するかどうかを確認します

File:: exists ( $ file );

属性	説明	タイプ	必須	デフォルト
$ファイル	パスまたはファイルURL。	弦	はい

＃return （boolean）

- 存在する場合はファイルを削除します

File:: delete ( $ file );

属性	説明	タイプ	必須	デフォルト
$ファイル	ファイルパス。	弦	はい

＃return （boolean）

- 存在しない場合はディレクトリを作成します

File:: createDir ( $ path );

属性	説明	タイプ	必須	デフォルト
$パス	ディレクトリを作成するパス。	弦	はい

＃return （boolean）

- 再帰的にディレクトリをコピーします

File:: copyDirRecursively ( $ from , $ to );

属性	説明	タイプ	必須	デフォルト
$ from	コピーからのパス。	弦	はい
$ to	コピーへのパス。	弦	はい

＃return （boolean）

- 空のディレクトリを削除します

File:: deleteEmptyDir ( $ path );

属性	説明	タイプ	必須	デフォルト
$パス	削除するパス。	弦	はい

＃return （boolean）

- 再帰的にディレクトリを削除します

File:: deleteDirRecursively ( $ path );

属性	説明	タイプ	必須	デフォルト
$パス	削除するパス。	弦	はい

＃return （boolean）

- ディレクトリからファイルを取得します

File:: getFilesFromDir ( $ path );

属性	説明	タイプ	必須	デフォルト
$パス	ファイルパスを取得するパス。	弦	はい

＃return （boolean）

クイックスタート

このライブラリを作曲家と一緒に使用するには：

 require __DIR__ . ' /vendor/autoload.php ' ;

use Josantonius  File  File ;

または、手動でインストールした場合は、使用してください。

 require_once __DIR__ . ' /File.php ' ;

use Josantonius  File  File ;

使用法

このライブラリの使用例：

- ローカルファイルが存在するかどうかを確認します

File:: exists ( ' path/to/file.php ' );

- 外部ファイルが存在するかどうかを確認します

File:: exists ( ' https://raw.githubusercontent.com/Josantonius/PHP-File/master/composer.json ' );

- ローカルファイルを削除します

File:: delete ( __DIR__ . ' /test.txt ' );

- ディレクトリを作成します

File:: createDir ( __DIR__ . ' /test/ ' );

- 空のディレクトリを削除します

File:: deleteEmptyDir ( __DIR__ . ' /test/ ' );

- 再帰的にディレクトリを削除します

File:: deleteDirRecursively ( __DIR__ . ' /test/ ' );

- 再帰的にディレクトリをコピーします

File:: copyDirRecursively ( __DIR__ . ' /test/ ' , __DIR__ . ' /copy/ ' );

- ディレクトリからファイルパスを取得します

 get_class (File:: getFilesFromDir ( __DIR__ ));

テスト

テストを実行するには、作曲家が必要なだけで、以下を実行します。

 git clone https://github.com/Josantonius/PHP-File.git

cd PHP-File

composer install

phpunitでユニットテストを実行します：

 composer phpunit

PHPCを使用してPSR2コード標準テストを実行します。

 composer phpcs

PHP MESS検出器テストを実行して、コードスタイルの矛盾を検出します。

 composer phpmd

以前のすべてのテストを実行します：

 composer tests

ライセンス

このリポジトリは、MITライセンスの下でライセンスされています。

Copyright©2017-2022、Josantonius