Skip to content

Latest commit

 

History

History

UniformResourceLocator

Uniform Resource Locator

The Uniform Resource Locator module handles resource aggregation and stream wrapper related tasks for UserFrosting.

Problem to Solve

It's easy to find files when they are located in a single place. It's another task when looking for files scattered across multiple directory. Step into the world of package and dependencies and the nightmare begins.

It's like trying to find someone in a one story house vs. a 25 stories office building when you don't know on which floor the person is. This package goal is to help you locate things in that office building without having to search floor by floor each time. In other words, it is a way of aggregating many search paths together.

Documentation

Building doc

First, you need to install phpDocumentor. There are multiple options how to install it, one of them is using the PHAR:

$ wget https://phpdoc.org/phpDocumentor.phar

Read more about installation of phpDocumentor

Once installed, run phpDocumentator, using UniformResourceLocator config file.

php phpDocumentor.phar -c src/UniformResourceLocator/phpdoc.xml 

References