Download the PHP package devlop/utm-parameters without Composer
On this page you can find all versions of the php package devlop/utm-parameters. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download devlop/utm-parameters
More information about devlop/utm-parameters
Files in devlop/utm-parameters
Package utm-parameters
Short Description Framework agnostic UTM parameters helper
License MIT
Informations about the package utm-parameters
UTM Parameters
Framework agnostic (PSR-7 compatible) UTM parameters helper, this tool will simplify working with UTM parameters.
Installation
Usage
Capturing incoming UTM parameters
The basic idea is to capture incoming UTM parameters from the query and store them in cookies for later use until needed.
Create a middleware (or similar) following this logic:
Retrieving stored UTM parameters
Later when you need the stored UTM parameters (example, after a registration or a placed order) you can easiliy retrieve them.
Available methods
The Devlop\UtmParameters\UtmParameters
have the following methods available:
public function getSource() : string
Get the utm_source parameter.
public function getMedium() : ?string
Get the utm_medium parameter.
public function getCampaign() : ?string
Get the utm_campaign parameter.
public function getTerm() : ?string
Get the utm_term parameter.
public function getContent() : ?string
Get the utm_content parameter.
public function toArray() : array
Get all parameters as an array:
Iterating
UtmParameters
is iterable:
Constants
All parameter keys are available as constants on UtmParameters to avoid the need to hardcode any parameter keys in your code.
Supported requests / responses
When capturing
/ retrieving
UTM parameters these requests are supported.
- \Psr\Http\Message\ServerRequestInterface
- \Symfony\Component\HttpFoundation\Request
- \Laravel\Http\Request
When remembering
/ forgetting
UTM parameters these responses are supported.
- \Psr\Http\Message\MessageInterface
- \Symfony\Component\HttpFoundation\Response
- \Laravel\Http\Response
- \Illuminate\Contracts\Cookie\QueueingFactory
Laravel
Cookies Facade
The easiest way to remember
or forget
stored UTM parameters in Laravel is to use the global cookie()
helper method to get an instance of QueueingFactory
to attach the cookies to the response.
Middleware
utm-parameters
ships with a middleware for Laravel for you to use.
Add the middleware in app/Http/Kernel.php
, the middleware will automatically capture any incoming UTM parameters and store them in cookies for 30 days.