The attached add-on files may be out of date.  Please visit Devot-ee for the latest versions.

Hi,

I have rewritten Eric Snyder’s Cookies plugin. The result is Cookie Plus plugin.

I was dissatisfied with two aspects of Cookies plugin:

1) using it you should place the code for setting cookie on top of the page and cookie must be set before any output started;

2) it is not possible to use retrieved cookie as parameter of other tags.

Cookie Plus plugin has no such constrictions and retains all functionality of Cookies plugin.

Usage:

Sets a cookie named mycookie with the value “hellow!”. The cookie
will last for 1 hour (3600 seconds).
Set the seconds to zero to set a session cookie.

By default cookie is set using PHP function. This means that {exp:cookie_plus:set}
tag must be on top of the page and do its job before any other output. If you need
to set a cookie after output started, you may use parameter “method”.
In case parameter “method” has a value “script” as here

the cookie will be set using client-side javascript.

Using client-side javascript cookie by default will be set during page load event.
Also cookie will be set during page load event if “event” parameter is set to “load”.
To set cookie during page unload event, parameter “event”  should have the value “unload”:

To retrieve a cookie:

If the cookie “mycookie” exists then it will return the value.
If the cookie does not exist then it will return nothing.

Alternatively for retrieving a cookie you may use {cookie} variable
placed between {exp:cookie_plus:get} and {/exp:cookie_plus:get}
tag pair.

Variable {cookie} within {exp:cookie_plus:get} and {/exp:cookie_plus:get} tag pair is
more powerful because you can use its output as parameter of other tag. For such use
you must add parse=“inward” parameter to {exp:cookie_plus:get} tag.

For example, code as this will work

Also you can use retrieved cookie value in conditionals:

Changelog:

-1.2 // Added possibility to use retrieved cookie value in conditionals.
-1.1 // Parameter “event” added.
-1.0 // First release.

Hiya,

Sounds like a great little plugin. Will download this and have a play. I actually made one like this myself some time back but never released it as I didn’t have the time to neaten it all up as other things took precedence as they always tend to do!!

Thanks for this one. I’m sure it will be very helpful to a lot of people.

Best wishes,

Mark

P.S. Just noticed that your signature has the same “Full list of plugins here” as mine does (minus the exclamation marks of course) Wonder who did that first?

Hi Mark,

Nice that you like the idea of this plugin and hope that you will find it useful.

In writing the signature “Full list of plugins here” you were first, of course. I hope you will not charge any copyright fee, or will you? 

Laisvunas - 23 June 2008 08:36 PM

In writing the signature “Full list of plugins here” you were first, of course. I hope you will not charge any copyright fee, or will you? 

You can have it at a reduced rate of £10,000,000

Just kidding Totally free of course

Thanks again for releasing this one. Surely will be of great use to a lot of people.

Speak to you soon.

Best wishes,

Mark

Hi,

I have updated the plugin Cookie Plus. You can download version 1.1 using the link in previous post.

In this release a new parameter - “event” was added. This parameter is used together with “method” parameter. If “method” parameter is set to “script”, then, using “event” parameter you can define when cookie will be set. If “event” parameter is not set or has a value “load”, then javascript will set cookie during page load event. If event parameter has a value “unload”, then javascript will set cookie during page unload event.

An example:

Hi Laisvunas

Your plugin looks really interesting - thanks. Would it be possible for you to give the community some example uses for the script? For example, I’m currently looking at ways to implement a very simple shopping cart for a site. Could Cookie Plus do this and if so how?

Many thanks

Jim

Hi Jim,

Having no experience in implementing shopping carts I cannot say if Cookie Plus plugin could somehow be useful for such purpose.

I use Cookie Plus plugin only when it is really complicated to pass some custom data from one page to another. One such case would be if you need to pass some custom date from a page containing search form to search results_page or no_results_page. In this case you cannot pass custom data using URL segments or PHP $_POST array (see here). So cookies is right solution for such case.

The weblog code example you provide (repeated below) works for me no problem but I wanted to use a simple conditional like the second code example I provide below.

This below doesn’t work but something like that?

And one other question - if you have time and inclination - would you mind showing an example of how someone might set a cookie using some javascript and a text link or some other mechanism to trigger setting the cookie in the page while using your plugin?

That may be a little bit much to flush out for an example but if one is handy that would be great.

Hi Rob,

I just released version 1.2 of Cookie Plus plugin. Now you can use retrieved cookie value in conditionals. That is, the code as this will work:

Concerning your question

would you mind showing an example of how someone might set a cookie using some javascript and a text link or some other mechanism to trigger setting the cookie in the page while using your plugin?

I would say that using Cookie Plus plugin the cookie can be set either during page load or unload. If there is no parameter “event”, then the cookie will be set during page load event, as here:

If there is parameter “event” and it has the value “unload”, then the cookie will be set during page unload event, as here:

There is no need to enter any additional javascript or text link.

This is just awesome! Thanks for revising I’m really looking forward to using this.

Sorry you may have just stated this, and I’m a little dense on this subject, but if I was looking to only set a cookie if a text link was clicked after the page loaded, can I set that cookie somehow using your plugin?

Or does your plugin just set it when the page initially loads or alternately when the page finishes? Sorry, I think I’m having difficulty understanding the concept and terminology of values of “unload” and “event.” That’s why if it was possible, I was hoping to see a basic visual example of code potentially used to set for an on click event or something similar.

My apology and thank you for your patience!

Or does your plugin just set cookie when the page initially loads or alternately when the page finishes?

Correct.

if I was looking to only set a cookie if a text link was clicked after the page loaded, can I set that cookie somehow using your plugin?

To achieve this you should use not plugin but a simple javascript function. Try do as follows. First insert this into <head> part of your page:

Then insert this into appropriate place inside <body> part of your page:

Hope this helps.

Thanks! I was confused but I’ve got it down now. This plugin is really going to be handy for me.

Hi, your plugin is excellent!

I just have one question: How can I retrieve the value of the cookie directly from PHP?

I’m using the cookie_plus plugin to store a value that I later need to retrieve for a query I’m making to a database. So I need the value stored in a php variable.

Something like

Thanks so much!

G.

Hi arteylogica,

To retrieve cookie value using PHP you can use the code as this:

Using PHP in templates is not secure, so I would advice to you to wrap your database query into a plugin and use that plugin together with Cookie Plus plugin. Suppose your plugin would be named “Arteylogica DB query” and had parameter “cookie” (or some other parameter which should get its value from cookie). Then you could write the code as this:

Hope that helps.

Hi Laisvunas, thanks for your help.

I’ve created a simple template to test if I can retrieve the cookie by just using PHP. (I haven’t created an EE plugin in my life, so I don’t have the SQL query wrapped in one. I should try!)

But the test is meant to simply output the value of the cookie:

Using your plugin it works perfectly, but this is what I get from PHP in my browser:

What could this be?

Thanks man!