Download the PHP package suarez/statamic-utm-parameter without Composer
On this page you can find all versions of the php package suarez/statamic-utm-parameter. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download suarez/statamic-utm-parameter
More information about suarez/statamic-utm-parameter
Files in suarez/statamic-utm-parameter
Package statamic-utm-parameter
Short Description A helper to store and handle UTM parameters on Statamic websites
License
Homepage https://github.com/toni-suarez/statamic-utm-parameter
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 statamic-utm-parameter
Statamic UTM-Parameters
&label=Statamic&link=https%3A%2F%2Fstatamic.com%2Faddons%2Ftoni-suarez%2Futm-parameter){kind=icon}
A helper to store and handle UTM parameters session-based on statamic websites.
Installation
You can search for this addon in the Tools > Addons section of the Statamic control panel and click install, or run the following command from your project root:
Optionally, you can publish the config file of this package with this command:
Note: The UTM parameters are stored session-based, meaning they are only available during the user's current browsing session and will be cleared when the user closes their browser or navigates away from your website. This addon leverages the built-in Laravel session management system for storage.
Configuration
The configuration file config/statamic-utm-parameter.php allows you to control the behavior of the UTM parameters handling.
Usage
This addon provides convenient methods to retrieve, check, and use UTM parameters within your Statamic templates.
Antlers Templating
Retrieve All UTM Parameters
Use {{ utm:all }} to get an array of all UTM parameters.
Retrieve a Specific UTM Parameter
Use {{ utm:get }} to get the value of a specific UTM parameter.
Check if a Specific UTM Parameter Exists
Use {{ utm:has }} or {{ utm:is }} to check if a specific UTM parameter exists.
Check if a Specific UTM Parameter contains a value
Use {{ utm:contains }} to check if a specific UTM parameter contains a specific value.
Clear UTM Parameters
Use the clear method to remove and reset the UTM parameters from the session.
Parameter Types
The following UTM parameter types are supported:
source: The source of the traffic (e.g., google, newsletter).medium: The medium of the traffic (e.g., cpc, email).campaign: The campaign name (e.g., spring_sale).term: The search term used (e.g., running+shoes).content: The specific content (e.g., ad_variation_1).
Examples
Displaying All UTM Parameters
Displaying a Specific UTM Parameter
To display the UTM term parameter:
Conditional Display Based on UTM Parameters
To display the UTM medium parameter if the source is google:
Full Example
Here's a full example combining all the functionalities:
Extending the Middleware
You can extend the middleware to customize the behavior of accepting UTM parameters. For example, you can override the shouldAcceptUtmParameter method.
First, create a new middleware using Artisan:
Then, update the new middleware to extend UtmParameters and override the shouldAcceptUtmParameter method:
Finally, update your bootstrap/app.php to use the CustomMiddleware:
License
The Statamic UTM-Parameters addon is open-sourced software licensed under the MIT license.
