Download the PHP package gmazzap/gm-cookie-policy without Composer
On this page you can find all versions of the php package gmazzap/gm-cookie-policy. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download gmazzap/gm-cookie-policy
More information about gmazzap/gm-cookie-policy
Files in gmazzap/gm-cookie-policy
Package gm-cookie-policy
Short Description A simple plugin to show a message for compliance with EU cookie law.
License MIT
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 gm-cookie-policy
EU Cookie Policy
A simple plugin to show a message for compliance with EU cookie law.
Support Composer, but does not require it. Requires PHP 5.4+.
Mainly developer-oriented, for basic needs can also be used by non-devs: basic configuration are available via UI, but advanced customization only via hooks.
Why yet another "cookie policy" plugin?
There're a few plugins that aim to do same thing, but I needed a plugin that:
- supports Composer natively
- works with javascript disabled
- provides a PHP API to be informed if current user accepted the policy
- provides a javascript API to be informed if current user accepted the policy, and also capable to notify other scripts in the moment the user accepts the policy
- doesn't do too much
- doesn't have dozen of options
- is not too "promotional"
And I could not found one that meets all the above requirements. So I wrote it.
Usage
After activation, a sub-menu will be added under the "Tools" main menu.
In the setting page accessible from there is possible to set the cookie policy notice message and few other basic options.
Many other customizations can be done via hooks.
PHP API
When the plugin is active you can be informed if user accepted the policy via a filter:
This way, anything that make use of "profiling cookies" can be disabled / not loaded when $accepted
is false, fully applying EU law.
Since it is a filter, it does not lock-in to the plugin. Even if the plugin is disabled any code that relies on the filter above will not crash if plugin is not there.
However, PHP can reload page components (e.g. ads) when the user clicks the link to accept the policy (at least not without making another request), this is why there's also a javascript API.
javascript API
Making it short, the variable window.cookiePolicy.accepted is a boolean that is set to true when
the user accepted the policy.
There are two custom events that scripts can listen to check that variable and acting accordingly.
The first event is cookie-policy-loaded, it happens right after the document is fully loaded.
The other event is cookie-policy-accepted, that is triggered after the user accepted the policy:
Just like PHP API, neither javascript API lock-in to the plugin. It is possible to disable the plugin without breaking anything and also replace the plugin with some other script that may trigger same events and set same variable for 100% backward compatibility.
Translations
The plugin comes with some translation:
- Italian
- Romanian (by @rmdiaconu)
PRs with more translations are welcome.
License
MIT.
