php file

Библиотека файлов PHP

Versión en Español

Библиотека PHP для управления файлами.

---

• Требования
• Установка
• Доступные методы
• Быстрый старт
• Использование
• Тесты
• Лицензия

---

Требования

Эта библиотека поддерживается версиями PHP 5.6 или выше и совместима с версиями HHVM 3,0 или выше.

Установка

Предпочтительным способом установки этого расширения является композитор.

Чтобы установить библиотеку файлов 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 );

Атрибут	Описание	Тип	Необходимый	По умолчанию
$ file	Путь или файл URL.	нить	Да

# Return (boolean)

- Удалить файл, если существует

File:: delete ( $ file );

Атрибут	Описание	Тип	Необходимый	По умолчанию
$ file	Файл Путь.	нить	Да

# Return (boolean)

- Создать каталог, если не существует

File:: createDir ( $ path );

Атрибут	Описание	Тип	Необходимый	По умолчанию
$ path	Путь, где создавать каталог.	нить	Да

# Return (boolean)

- Скопировать каталог рекурсивно

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

Атрибут	Описание	Тип	Необходимый	По умолчанию
$ от	Путь от копии.	нить	Да
$ to	Путь к копии.	нить	Да

# Return (boolean)

- Удалить пустой каталог

File:: deleteEmptyDir ( $ path );

Атрибут	Описание	Тип	Необходимый	По умолчанию
$ path	Путь к удалению.	нить	Да

# Return (boolean)

- Удалить каталог рекурсивно

File:: deleteDirRecursively ( $ path );

Атрибут	Описание	Тип	Необходимый	По умолчанию
$ path	Путь к удалению.	нить	Да

# Return (boolean)

- Получить файлы из каталога

File:: getFilesFromDir ( $ path );

Атрибут	Описание	Тип	Необходимый	По умолчанию
$ 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

Запустите стандартные тесты кода PSR2 с PHPCS:

 composer phpcs

Запустите тесты детектора MESS PHP, чтобы обнаружить несоответствия в стиле кода:

 composer phpmd

Запустите все предыдущие тесты:

 composer tests

Лицензия

Этот репозиторий лицензирован по лицензии MIT.

Copyright © 2017 - 2022, Josantonius