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 require spatie/temporary-directory

Использование

Создание временного каталога

Чтобы создать временный каталог, просто вызовите метод create объекта TemporaryDirectory .

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

Альтернативно можно использовать статический метод make для объекта TemporaryDirectory .

TemporaryDirectory:: make ();

По умолчанию временный каталог будет создан в каталоге с отметкой времени во временном каталоге вашей системы (обычно /tmp ).

Именование вашего временного каталога

Если вы хотите использовать собственное имя для временного каталога вместо метки времени, вызовите метод name со строковым аргументом $name перед методом create .

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

По умолчанию исключение будет выдано, если каталог с данным аргументом уже существует. Вы можете переопределить это поведение, вызвав метод force в сочетании с методом name .

( 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 ();

Удаление временного каталога при уничтожении объекта

Если вы хотите автоматически удалять каталог файловой системы, когда у экземпляра объекта больше нет ссылок в определенной области, вы можете включить функцию deleteWhenDestroyed() для объекта TemporaryDirectory.

 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, Антверпен, Бельгия.

Все полученные открытки мы публикуем на сайте нашей компании.

Кредиты

• Алекс Вандербист
• Все участники

Лицензия

Лицензия MIT (MIT). Дополнительную информацию см. в файле лицензии.