cms.contrib.ratings package

Submodules

cms.contrib.ratings.admin module

class cms.contrib.ratings.admin.RateableAdmin

Bases: object

Admin class for models that subclass the abstract Rateable model.

fieldsets_append = {<django.utils.functional.__proxy__ object at 0x59a11d0>: (('ratings_allow',),)}
list_filter_append = (<class 'cms.contrib.ratings.filters.RateableFilter'>,)
class cms.contrib.ratings.admin.RatingsItemModelstatsDashboardModule(request)

Bases: cms.contrib.modelstats.modules.ModelstatsDashboardModule

date_field = 'created_date'
get_objects(request)
model

alias of RatingsRating

cms.contrib.ratings.autofixtures module

class cms.contrib.ratings.autofixtures.RatingsRatingFixture(*args, **kwargs)

Bases: cms.core.dev.autofixtures.base.CMSAutoFixture

AUTO = False
AUTO_SECOND_RUN = True
COUNT_DEFAULT = 400
field_values = {'imageteaser': <autofixture.generators.NoneGenerator object at 0x8331350>, 'title': <autofixture.generators.LoremSentenceGenerator object at 0x8331c90>, 'image': <cms.core.dev.autofixtures.generators.ImageGenerator object at 0x8331290>, 'author': <autofixture.generators.NoneGenerator object at 0xc270350>, 'value': <autofixture.generators.IntegerGenerator object at 0xc270ad0>, 'order': <autofixture.generators.PositiveSmallIntegerGenerator object at 0x8331d90>, 'imageteaserdescription': <autofixture.generators.NoneGenerator object at 0x8331cd0>, 'expired_date': <autofixture.generators.NoneGenerator object at 0x8560590>, 'published_date': <cms.core.dev.autofixtures.generators.DateTimeMaxNowGenerator object at 0x8331d50>, 'created_date': <cms.core.dev.autofixtures.generators.DateTimeMaxNowGenerator object at 0xc270250>, 'slug': <autofixture.generators.NoneGenerator object at 0x8331ad0>, 'pretitle': <autofixture.generators.LoremSentenceGenerator object at 0x8331d10>}
get_generator(field)

cms.contrib.ratings.cms_defaults module

cms.contrib.ratings.cms_plugin module

class cms.contrib.ratings.cms_plugin.CMSPlugin

Bases: cms.core.plugins.CMSPluginBase

admin_icon_class = 'icon-star'
description = <django.utils.functional.__proxy__ object at 0x3203310>
status = 'stable'
verbose_name = <django.utils.functional.__proxy__ object at 0x3203390>
version = '0.3'

cms.contrib.ratings.fields module

class cms.contrib.ratings.fields.RatingField(*args, **kwargs)

Bases: cms.core.fields.BaseGenericRelation

Stores the rating count and average against the RATING_FIELD_NAME_count and RATING_FIELD_NAME_average fields when a rating is saved or deleted.

fields = {'%s_count': <django.db.models.fields.IntegerField>, '%s_sum': <django.db.models.fields.IntegerField>, '%s_average': <django.db.models.fields.FloatField>}
related_items_changed(instance, related_manager)

Calculates and saves the average rating.

cms.contrib.ratings.filters module

class cms.contrib.ratings.filters.RateableFilter(request, params, model, model_admin)

Bases: django.contrib.admin.filters.SimpleListFilter

lookups(request, model_admin)
parameter_name = 'ratings'
queryset(request, queryset)
title = <django.utils.functional.__proxy__ object at 0x59a1190>

cms.contrib.ratings.forms module

class cms.contrib.ratings.forms.RadioChoiceInput(*args, **kwargs)

Bases: django.forms.widgets.RadioChoiceInput

class cms.contrib.ratings.forms.RatingForm(request, *args, **kwargs)

Bases: django.contrib.comments.forms.CommentSecurityForm

Form for a rating. Subclasses CommentSecurityForm to make use of its easy setup for generic relations.

RATING_RANGE = [5, 4, 3, 2, 1]
base_fields = OrderedDict([('content_type', <django.forms.fields.CharField object at 0x31fce10>), ('object_pk', <django.forms.fields.CharField object at 0x31fce90>), ('timestamp', <django.forms.fields.IntegerField object at 0x31fcf10>), ('security_hash', <django.forms.fields.CharField object at 0x31fcf90>), ('value', <django.forms.fields.ChoiceField object at 0x7a21c50>)])
clean()

Check unauthenticated user’s cookie as a light check to prevent duplicate votes.

declared_fields = OrderedDict([('content_type', <django.forms.fields.CharField object at 0x31fce10>), ('object_pk', <django.forms.fields.CharField object at 0x31fce90>), ('timestamp', <django.forms.fields.IntegerField object at 0x31fcf10>), ('security_hash', <django.forms.fields.CharField object at 0x31fcf90>), ('value', <django.forms.fields.ChoiceField object at 0x7a21c50>)])
media
save()

Saves a new rating - authenticated users can update the value if they’ve previously rated.

class cms.contrib.ratings.forms.RatingRadioRenderer(name, value, attrs, choices)

Bases: django.forms.widgets.RadioFieldRenderer

render()

cms.contrib.ratings.managers module

class cms.contrib.ratings.managers.RatingsRatingManager

Bases: django.db.models.manager.Manager

for_content_type(app_label, model_name)

QuerySet for all ratings for a particular content_type (either an instance or a class).

for_model(model)

QuerySet for all ratings for a particular model (either an instance or a class).

cms.contrib.ratings.models module

class cms.contrib.ratings.models.RatingsRating(*args, **kwargs)

Bases: cms.core.models.BaseData, cms.core.models.Ownable

A rating that can be given to a piece of content.

class ApiPrivate
fields = ('value', 'content_type', 'object_pk')
exception RatingsRating.DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception RatingsRating.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

class RatingsRating.Settings
RatingsRating.author
RatingsRating.content_object

Provides a generic relation to any object through content-type/object-id fields.

RatingsRating.content_type
RatingsRating.created_by
RatingsRating.get_next_by_created_date(*moreargs, **morekwargs)
RatingsRating.get_next_by_modified_date(*moreargs, **morekwargs)
RatingsRating.get_previous_by_created_date(*moreargs, **morekwargs)
RatingsRating.get_previous_by_modified_date(*moreargs, **morekwargs)
RatingsRating.modified_by
RatingsRating.objects = <cms.contrib.ratings.managers.RatingsRatingManager object at 0x4116e50>
RatingsRating.save(*args, **kwargs)

Validate that the rating falls between the min and max values.

cms.contrib.ratings.urls module

cms.contrib.ratings.views module

class cms.contrib.ratings.views.RatingsView(**kwargs)

Bases: django.views.generic.base.RedirectView

post(request)

Handle a RatingForm submission and redirect back to its related object.

Module contents