LexRating

LexRating (by goldsky) is a jQuery's star rating plugin, based on rateit.codeplex.com (by gidon).

For MODX implementation, this extra uses AJAX to store the rating.

All issues can be notified in its github's page.

You can get it by downloading it via Package Manager.

There are 2 snippets for this package:

1. LexRating,
2. LexRatingList, to list the rating results.

There is a Quip's hook: LexRatingQuipPostHook, to create a star rating on each comment. Think about a comment based star rating.

LexRating¶

This snippet offers web visitor to give a rating into an object/item, based on the given name. This snippet checks the visitor's IP address, and if visitor logged in, the visitor's ID

Properties¶

Placeholders¶

To get the complete placeholders, just use &toArray=1 to spit out the keys.

Example¶

[[LexRating?
&name=`[[*pagetitle]]`
&group=`articles`
&userGroups=`Members`
]]

If you just want to display a rating of an item, use this

[[LexRating?
&name=`[[*pagetitle]]`
&group=`articles`
&initialAjax=`0`
&readOnly=`1`
]]

LexRatingList¶

This snippet retrieves the items of the LexRating's results based on the given group name.

Properties¶

Placeholders¶

To get the complete placeholders, just use &toArray=1 to spit out the keys.

WRAPPER:

LIST:

Example¶

[[LexRatingList? &group=articles]]

LexRatingQuipPostHook¶

This hook requires quip's thread name. This only works once for each IP Address + userID. So any logged in user can not vote twice.

On the quip's call, try to use this as an example:

[[LexRatingList? &group=`articles`]]

LexRatingQuipPostHook¶

This hook requires quip's thread name. This only works once for each IP Address + userID. So any logged in user can not vote twice.

On the quip's call, try to use this as an example:

<p>Total Rating:</p>
[[!LexRatingList?
&name=`threadNameHere`
&group=`Overall Rating`
]]
<br />
[[!Quip?
&thread=`threadNameHere`
&tplComment=`lexrating.quipComment`
]]
<br />
[[!QuipReply?
&thread=`threadNameHere`
&postHooks=`LexRatingQuipPostHook`
&tplAddComment=`lexrating.quipAddComment`
&redirectTo=`[[*id]]`
]]

You can sync the connection between the thread's name (eg:threadNameHere) with the LexRating inside the other chunk, lexrating.quipComment Basically, it only adds up the LexRating call but with the proper properties to make this works:

[[!LexRating?
&group=`Overall Rating`
&name=`[[+thread]]`
&extended=`{"quipReplyId":"[[+idprefix]][[+id]]"}`
&readOnly=`1`
&tpl=`lexrating.quip`
&js=``
&loadjQuery=`0`
&initialAjax=`0`
&_toArray=`1`
]]

&group is for the title, &name must be as same as the quip's thread name

What &extended does is only to identify each of the vote. You can change it anything, as long as it's the same with what the lexrating.quip needs for its placeholder.

data-rateit-extended="[[+lexrating.extended]]"

You must specify different names for the quip's thread names, remember to change/duplicate part of the chunks:

the duplicate of lexrating.quipAddComment

<!-- replace lexrating_groupName's value with what you have as the &group -->
<input type="hidden" name="lexrating_groupName" value="Overall Rating" />

<!-- but leave this one untouched because the &name is using the same placeholder [[+thread]] anyway -->
<input type="hidden" name="lexrating_objectName" value="[[+thread]]" />

the duplicate of lexrating.quipComment

&group=`Overall Rating` // <== replace this

You need to empty out the database when testing, because LexRating fills up the data automatically, while the access is limited to once per IP/user ID