temporary directory

一時ディレクトリを素早く作成、使用、削除する

このパッケージを使用すると、システムの一時ディレクトリ内で一時ディレクトリを迅速に作成、使用、削除できます。

一時ディレクトリを作成して削除する方法の簡単な例を次に示します。

 use Spatie  TemporaryDirectory  TemporaryDirectory ;

$ temporaryDirectory = ( new TemporaryDirectory ())-> create ();

// Get a path inside the temporary directory
$ temporaryDirectory -> path ( ' temporaryfile.txt ' );

// Delete the temporary directory and all the files inside it
$ temporaryDirectory -> delete ();

サポートしてください

私たちはクラス最高のオープンソース パッケージの作成に多くのリソースを投資しています。有料製品のいずれかを購入することで、私たちをサポートできます。

当社のどのパッケージを使用しているかについて、故郷から葉書を送っていただき、誠にありがとうございます。当社の住所は、お問い合わせページに記載されています。受け取ったすべてのポストカードをバーチャル ポストカード ウォールに公開します。

インストール

パッケージは、composer 経由でインストールできます。

composer require spatie/temporary-directory

使用法

一時ディレクトリの作成

一時ディレクトリを作成するには、 TemporaryDirectoryオブジェクトのcreateメソッドを呼び出すだけです。

( new TemporaryDirectory ())-> create ();

あるいは、 TemporaryDirectoryオブジェクトで静的なmakeメソッドを使用します。

TemporaryDirectory:: make ();

デフォルトでは、一時ディレクトリはシステムの一時ディレクトリ (通常は/tmp ) 内のタイムスタンプ付きディレクトリに作成されます。

一時ディレクトリに名前を付ける

一時ディレクトリにタイムスタンプの代わりにカスタム名を使用する場合は、 createメソッドの前に文字列$name引数を指定してnameメソッドを呼び出します。

( new TemporaryDirectory ())
   -> name ( $ name )
   -> create ();

デフォルトでは、指定された引数を持つディレクトリがすでに存在する場合、例外がスローされます。この動作は、 nameメソッドと組み合わせてforceメソッドを呼び出すことでオーバーライドできます。

( new TemporaryDirectory ())
   -> name ( $ name )
   -> force ()
   -> create ();

一時ディレクトリのカスタムの場所を設定する

文字列$location引数をTemporaryDirectoryコンストラクターに渡すことで、一時ディレクトリが作成されるカスタムの場所を設定できます。

( new TemporaryDirectory ( $ location ))
   -> create ();

makeメソッドは$location引数も受け入れます。

TemporaryDirectory:: make ( $ location );

最後に、 $location引数を使用してlocationメソッドを呼び出すことができます。

( new TemporaryDirectory ())
   -> location ( $ location )
   -> create ();

一時ディレクトリ内のパスの決定

pathメソッドを使用して、一時ディレクトリ内のファイルまたはディレクトリへのフル パスを決定できます。

 $ temporaryDirectory = ( new TemporaryDirectory ())-> create ();
$ temporaryDirectory -> path ( ' dumps/datadump.dat ' ); // return  /tmp/1485941876276/dumps/datadump.dat

一時ディレクトリを空にする

一時ディレクトリ内のすべてのファイルを削除するには、 emptyメソッドを使用します。

 $ temporaryDirectory -> empty ();

一時ディレクトリの削除

一時データの処理が完了したら、 deleteメソッドを使用して一時ディレクトリ全体を削除できます。その中にあるすべてのファイルが削除されます。

 $ temporaryDirectory -> delete ();

オブジェクトが破棄された場合の一時ディレクトリの削除

オブジェクト インスタンスの定義されたスコープ内に参照がなくなったときにファイル システム ディレクトリを自動的に削除したい場合は、TemporaryDirectory オブジェクトでdeleteWhenDestroyed()有効にできます。

 function handleTemporaryFiles ()
{
    $ temporaryDirectory = ( new TemporaryDirectory ())
        -> deleteWhenDestroyed ()
        -> create ();

    // ... use the temporary directory

    return ; // no need to manually call $temporaryDirectory->delete()!
}

handleTemporaryFiles ();

オブジェクト インスタンスに対してunset()を呼び出すこともできます。

テスト

composer test 

変更履歴

最近の変更点の詳細については、CHANGELOG を参照してください。

貢献する

詳細については、「貢献」を参照してください。

セキュリティの脆弱性

セキュリティの脆弱性を報告する方法については、セキュリティ ポリシーをご覧ください。

ポストカードウェア

このパッケージを自由に使用できますが、実稼働環境に届いた場合は、どのパッケージを使用しているかを記載した葉書を故郷から送っていただければ幸いです。

私たちの住所は、Spatie, Kruikstraat 22, 2018 Antwerp, Belgiumです。

いただいたはがきはすべて当社ホームページに掲載しております。

クレジット

• アレックス・ヴァンダービスト
• すべての貢献者

ライセンス

MIT ライセンス (MIT)。詳細については、ライセンス ファイルを参照してください。