DEPRECATION WARNING
This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.
~.settings¶
Whithin this section you may set some general configurations regarding your rating.
Reference¶
Property | Title | Type |
---|---|---|
display | Name of the rating configuration to use. | string |
ratetable | Tablename of the ratingobject | string |
ratefield | Fieldname of the ratingobject | string |
ratingContext | CSS class addition | string |
ratingobject | UID of the ratingobject | int |
ratedobjectuid | UID of the rated row in the table | int |
mapAnonymous | UID of the anonymous FE user | int |
cookieLifetime | Cookie protection lifetime | int |
showNoFEUser | Switch to activate info | boolean |
showNotRated | Switch to deactivate info | boolean |
displayOnly | Switch to deactivate ratings | boolean |
enableReVote | Switch to enable re-votings | boolean |
foreignFieldArrayUpdate | Switch to enable foreign updates | boolean |
storagePid | General storage page | int |
[tsref:plugin.tx_thrating.settings]
display¶
Property
display
Data type
Description
Name of the rating configuration to use as set per default. Value depends on choosen action.
Default
different depending on action
ratingContext¶
Property
ratingContext
Data type
Description
CSS class addition to defer between different formattings in different contexts
Default
defaultContext
ratedobjectuid¶
Default
mapAnonymous¶
Property
mapAnonymous
Data type
Description
UID of the FE user that holds all anonymous votings
Default
see constant mapAnonymous
cookieLifetime¶
Property
cookieLifetime
Data type
Description
Lifetime of cookie protection for anonymous votes
Default
0
showNoFEUser¶
Property
showNoFEUser
Data type
Description
Switch to activate info if no user is logged on.
Default
see constants: showNoFEUser
showNotRated¶
Property
showNotRated
Data type
Description
Switch to deactivate info if no no rating has been done yet.
Default
0
displayOnly¶
Property
displayOnly
Data type
Description
Switch to deactivate ratings and only display current rating.
Default
0
enableReVote¶
Property
enableReVote
Data type
Description
Switch to enable users to change their given votings.
Default
0
foreignFieldArrayUpdate¶
Property
foreignFieldArrayUpdate
Data type
Description
Update foreign ratetable in ratefield using the whole getCurrentRates array or double value (default)
Default
0
storagePid¶
Property
storagePid
Data type
Description
General storage page where all records are stored.
Default
value of constant pluginStoragePid
Example
Here an example which is also included in one of the default configurations:
1 2 3 4 5 6 7 | plugin.tx_thrating.settings {
ratetable = tt_content
ratefield = uid
#ratingobject = 1
ratedobjectuid = 1
#display = stars - not needed if default is used
}
|