Download the PHP package schenke-io/laravel-url-cleaner without Composer
On this page you can find all versions of the php package schenke-io/laravel-url-cleaner. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download schenke-io/laravel-url-cleaner
More information about schenke-io/laravel-url-cleaner
Files in schenke-io/laravel-url-cleaner
Package laravel-url-cleaner
Short Description check and cleans url from seo or tracking data
License MIT
Homepage https://github.com/schenke-io/laravel-url-cleaner
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package laravel-url-cleaner
Laravel URL cleaner - clean and concise
The Laravel URL Cleaner package sanitizes URLs by removing unnecessary SEO parameters, tracking information, and other clutter, ensuring clean and efficient URL handling in your Laravel applications.
To install just run:
composer require schenke-io/laravel-url-cleanerHere a code example:
Operation principle
The core UrlCleaner class iteratively applies a series of specialized
cleaner classes to a given URL. Each cleaner class performs a specific modification
to check and clean the URL for the following reasons:
- Reducing URL clutter: Removes unnecessary SEO parameters and tracking information.
- Improving data storage efficiency: Stores cleaner, more concise URLs.
- Enhancing performance: Optimizes URL processing and caching.
- Securing sensitive information: Prevents exposure of tracking parameters.
- Enhancing data analysis: Simplifies data analysis by removing noise from URLs.
This cleaner classes are highly extensible, allowing for customization and the creation of new modification types.
Config
A default configuration file can be installed and later modified, you can install it with:
A typical result could be:
| key | type | description | cleaner |
|---|---|---|---|
| cleaners | array | list of cleaner classes applied to the given URL | any |
| max_length_value | int | values longer than this are removed by | RemoveLongValues |
| masks | array | additional masks to be used | RemoveConfigMasks |
| protected_keys | array | key names which are guard against removal | any |
List of cleaner classes
| class name | # masks | description |
|---|---|---|
| Marketing00 | 68 | Manual collected list of parameters for cleaning |
| Marketing01 | 94 | tracking-query-params-registry from https://github.com/mpchadwick |
| Marketing02 | 43 | url-parameter-tracker-list from https://github.com/spekulatius |
| Marketing03 | 170 | Neat-URL from https://github.com/Smile4ever |
| Marketing04 | 91 | platform-url-click-id-parameters from https://github.com/henkisdabro |
| MarketingBroad | 226 | prioritize generic masks from all sources |
| MarketingNarrow | 309 | prioritize specific masks from all sources |
| MarketingUnique | 348 | all masks from all sources |
| PreventInvalidHost | - | do not allow urls with invalid host names |
| PreventLocalhost | - | do not allow urls from localhost |
| PreventNonHttps | - | do not allow urls different from the scheme https |
| PreventUserPassword | - | do not allow urls using user and passwords |
| RemoveConfigMasks | - | remove keys defined in the config |
| RemoveLongValues | - | remove overly long parameters. |
| RemoveSearch | - | remove typical search parameters |
| ShortAmazonProductUrl | - | Amazon product url cleaner |
| SortParameters | - | the query parameters get alphabetical sorted |
The use of masks
The core process of URL parameter removal utilizes specific masks.
| Description | Example mask |
|---|---|
| exact match of one query key on any domain | utm_campaign |
| match of some keys on any domain | utm* *tm* |
| exact match of one query key on one domain | [email protected] |
| exact match of one query key on some domains | utm_campaign@test.* utm_campaign@*test.* |
| match of some keys on one domain | utm_*@test.net *x*@test.net |
| match of some keys on some domains | utm_*@test.* *x*@*test.* |
Soem examples are outlined in the table below.
| Mask | URL 1 test.com/?a=1&b=2 |
URL 2 test.net/?a=1&abb=2 |
URL 3 test2.com/?a=1&b=2 |
|
|---|---|---|---|---|
| a | test.com/?b=2 | test.net/?abb=2 | test2.com/?b=2 | |
| a* | test.com/?b=2 | test.net/ | test2.com/?b=2 | |
| test.com@a | test.com/?b=2 | test.net/?a=1&abb=2 | test2.com/?a=1&b=2 | |
| test.*@a | test.com/?b=2 | test.net/?abb=2 | test2.com/?a=1&b=2 |
Build your own cleaner by extending special classes
To extend the list of cleaners you can build your own
cleaners and put them in the config
file config/url-cleaner.php
The following cleaners are prepared to be extended for custom applications:
Prevent domain names
Extend PreventLocalhost and overwrite the $hostRegExes array with regular
expressions matching unwanted hostnames.
Prevent schemes
Extend PreventNonHttps and overwrite the $allowedSchemes array with scheme
you allow to pass.
Use your own masks
Extend RemoveSearch and overwrite the $masks array with masks you want to exclude.
Rewrite urls
Extend ShortAmazonProductUrl and overwrite the clean() method using
the class as an example.
Data sources
Currently, the following sources are used:
- https://docs.flyingpress.com/en/article/ignore-query-parameters-yfejfj/
- https://support.cloudways.com/en/articles/8437462-how-to-enable-ignore-query-string-for-varnish-cache
- https://github.com/mpchadwick/tracking-query-params-registry
- https://github.com/spekulatius/url-parameter-tracker-list
- https://github.com/Smile4ever/Neat-URL
- https://github.com/henkisdabro/platform-url-click-id-parameters
- https://data.iana.org/TLD/tlds-alpha-by-domain.txt
All versions of laravel-url-cleaner with dependencies
ext-curl Version *
ext-json Version *
ext-simplexml Version *
archtechx/enums Version ^1.1
guzzlehttp/guzzle Version ^7.0
spatie/laravel-package-tools Version ^1.0
badges/poser Version ^2.0|^3.0