Download the PHP package infrajs/path without Composer
On this page you can find all versions of the php package infrajs/path. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package path
Short Description Resolve paths on the file system. Provide point of view on form of paths to files and folders..
License
Homepage https://github.com/infrajs/path
Informations about the package path
Path - общая система файловой адресации для сервера и клиента
Принципы и порядок работы с адресом
- Корнем проекта является папка с и
- Адрес записывается относительно корня проекта и в данных для браузера, и в данных для сервера. Например, index.html, images/1.jpg
- Слэш в конце означает только папку. Отстутствие слэша в конце означает только файл.
- Используется только прямой слэш - "/"
- Есть предопределённая папка c данными проекта, которая не попадает в репозиторий системы контроля версий, может содержать логин и пароль (credentials) и использоваться для хранения данных формируемых во время работы проекта. Доступна для записи php. По умолчанию адрес папки с данными . Короткое обозначение - символ "~"
- Есть предопределённая папка с кэшем. Папка не загружается в репозиторий. Доступна для записи php. По умолчанию адрес папки с кэшем . Короткое обозначение - символ "!"
- Есть предопределённые папки библиотек, в которых будет осуществляться поиск файла при наличии в начале адреса символа "-". По умолчанию это одна папка но список папок расширяется автоматически или в ручную в каждом отдельном случае.
- Адрес записывается в наиболее короткой форме и содержит принятые сокращения "-", "~", "!", если это возможно.
Для разработчиков
- Строку-адрес можно использовать как уникальный идентификатор файла.
- Недопустимо хранение и обработка абсолютных путей и путей содержающих последовательности "../", "./", "//", "\"
- Адрес может содержать параметры после "?" в этом случае нужно отдельно выполнять при использовании в стандартных php функциях для работы с файловой системой. Если бы в коносли было это можно данная команда не приводила бы к ошибке и открылась бы папка cache
- Функции не меняют форму адреса, используемые в нём символы или его части и если необходимо генерируют только свою часть адреса и следят только за её правильностью.
- Функции исходят из того, что форма получаемого адреса соответствует указанным принципам и не проверяют это.
- Анализ формы строки адреса и её изменение может быть в момент получения адреса от пользователя или от системы незнакомой с указанными принципами.
- Работа с файловой системой на запись не должна выполняться при наличии ключа . Зависимости работающие с системой учитывают этот ключ. Если зависимая библиотека не может работать без файловой системы, то, например, генерируется обычное исключение... throw new \Exception('Я не могу работать без файловой системы');
- Рабочей дирректорией в файлах php, где бы они не находились, является корень проекта. Рабочая директория устанавливается с помощью . Скрипт не полагается на своё фактическое расположение и содержит проверку своего расположения по файлу для случае подключения этого скрипта, вместо прямого вызова.
- Перед использование адреса в стандартных php-функциях работающих с файловой системой необходимо пропускать адрес через . Функция проверяет наличие указанного файла или папки и возвращает адрес без специальных сокращений. Использовать в стандартных функция можно путь, который эта функция вернула. Path::theme выполняет роль стандартных is_file is_dir file_exists. Папка или файл определяется наличием слэша в конце адреса.
- Для удаление специальных символов "-", "~", "!" из адреса без обращения к файловой системе предназначена функция для спецсимвола "-" выполнить эту операцию невозможно, будет сгенерировано исключение.
Проверка и установка рабочей директории
Требуется настройка modrewrite в .htaccess
Все запросы для которых нет файла перенаправляются на обработчик vendor/infrajs/path/router.php
Если сайт использует сторонний контроллер и перенаправлять все запросы нельзя нужно настроить более точное условие и перенаправлять на обработчик только запросы начинающиеся со специальных символов [-~!] TODO: добавить код точной переадресации
Path конфиг
В указывается куда ведут принятые сокращения "-", "~", "!":
- где искать скрипты - search (-),
- где папка данных - data (~),
- где папка кэша - cache (!).
По умолчанию Path::$conf:
Параметр space
Нужен для совместимости, когда функция Path::encode не должна заменять пробелы на дифисы.
Расширяемость расширений - clutch
Одно расширение, может содержать файлы для подмены другого расширения
Конфиг расширения cart может содержать такой конфиг и вложенные папки pixeden-stroke-7-icon и cart.
Файл "-catalog/some.php" возьмётся из папки vendor/infrajs/cards/catalog/some.php если такой файл там будет иначе будет использоваться файл vendor/infrajs/catalog/some.php При разрешении адреса начинающегося с символа "-" корень проекта имеет наивысший приоритет, за которым следует папка с данными "~" и затем идут папки начиная с последней. Первый путь в имеет наименьший приоритет.
С помощью clutch можно "подмешать" к стороннему расширению новые файлы или подменить существующие, например добавить конфигурационый файл .infra.json с настройками авторматической интеграции расширения в систему infrajs/collect.
Так как расширение pixeden-stroke-7-icon стороннего производителя и не содержит конфигурационного файла .infra.json нужно ещё и на него явно указать чтобы оно участвовало в поиске файлов (-)
Примеры
-
- указывает на файл
-
- указывает на файл
Синоним корня index/
-
- указывает на файл
DirectoryIndex
Если адресная строка содержит путь к -папке/, ищутся файлы index.php или index.html. Если файлов нет, то путь до папки будет считаться 404 ошибкой.
API
Path выполняет узкий набор функций по нахождению файлов и декларации правил работы с адресом. Для обработки запросов вида используется отедльное расширение infrajs/controller.