General

  eZ Systems Website
  Editor documentation


  Developer documentation

  Back to the top

The documentation is moving!

We're moving our developer docs to Github and a new site.
The migration is still in progress, so please contact us in #documentation-contrib on eZ Community Slack if you have any questions or feedback.

This space will not be updated from now on except for critical fixes.

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This Field Type is used to provide rating functionality.

Info

Rating Field Type does not provide the APIs for actual rating, this part is provided by Legacy Stack extension that can be found at https://github.com/ezsystems/ezstarrating.

NameInternal nameExpected input
Rating

ezsrrating

boolean

PHP API Field Type 

Input expectations

TypeDescriptionExample
booleanDenotes if the rating is enabled or disabledtrue

Value Object

API

Properties

eZ\Publish\Core\FieldType\Rating\Value offers the following properties.

PropertyTypeDescriptionExample
isDisabledbooleanDenotes if the rating is enabled or disabledtrue

Hash format

Hash matches the Value Object, having only one property:

  • isDisabled

Settings

The Field Type does not support settings.

Validation

The Field Type does not support validation.