class FivestarForm in Fivestar 8

Fivestar form.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\fivestar\Form\FivestarForm

Expanded class hierarchy of FivestarForm

File

src/Form/FivestarForm.php, line 14

Namespace

Drupal\fivestar\Form

View source

class FivestarForm extends FormBase {

  /**
   * The fivestar.vote_result_manager service.
   *
   * @var \Drupal\fivestar\VoteResultManager
   */
  protected $resultManager;

  /**
   * Form counter.
   *
   * @var int
   */
  protected static $formCounter = 0;

  /**
   * Creates a new object of this class.
   */
  public function __construct(VoteResultManager $result_manager) {
    $this->resultManager = $result_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('fivestar.vote_result_manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    self::$formCounter += 1;

    // For correct submit work set unique name for every form in page.
    return 'fivestar_form_' . self::$formCounter;
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, array $context = []) {
    $entity = $context['entity'];
    $uniq_id = Html::getUniqueId('vote');
    $field_definition = $context['field_definition'];
    $field_settings = $field_definition
      ->getSettings();
    $field_name = $field_definition
      ->getName();
    $voting_is_allowed = (bool) ($field_settings['rated_while'] == 'viewing');
    $form['vote'] = [
      '#type' => 'fivestar',
      '#stars' => $field_settings['stars'],
      '#allow_clear' => $field_settings['allow_clear'],
      '#allow_revote' => $field_settings['allow_revote'],
      '#allow_ownvote' => $field_settings['allow_ownvote'],
      '#vote_type' => $field_settings['vote_type'],
      '#widget' => $context['display_settings'],
      '#default_value' => $entity
        ->get($field_name)->rating,
      '#values' => $this->resultManager
        ->getResultsByVoteType($entity, $field_settings['vote_type']),
      '#settings' => $context['display_settings'],
      '#show_static_result' => !$voting_is_allowed,
      '#attributes' => [
        'class' => [
          'vote',
        ],
      ],
    ];

    // Click on this element triggered from JS side.
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Rate'),
      '#ajax' => [
        'event' => 'click',
        'callback' => '::fivestarAjaxVote',
        'method' => 'replace',
        'wrapper' => $uniq_id,
        'effect' => 'fade',
      ],
      '#attributes' => [
        'style' => 'display:none',
      ],
    ];
    $form_state
      ->set('context', $context);
    $form_state
      ->set('uniq_id', $uniq_id);
    $form['#attributes']['id'] = $uniq_id;
    return $form;
  }

  /**
   * Ajax callback: update fivestar form after voting.
   */
  public function fivestarAjaxVote(array $form, FormStateInterface $form_state) {
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $context = $form_state
      ->get('context');
    if (isset($context['entity'])) {
      $entity = $context['entity'];
      $fivestar_field_name = $context['field_definition']
        ->getName();
      if ($entity
        ->hasField($fivestar_field_name)) {

        // For votingapi value will be save during save rating value to
        // field storage.
        $entity
          ->set($fivestar_field_name, $form_state
          ->getValue('vote'));
        $entity
          ->save();
      }
    }
    $form_state
      ->setRebuild(TRUE);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FivestarForm::$formCounter	protected static	property	Form counter.
FivestarForm::$resultManager	protected	property	The fivestar.vote_result_manager service.
FivestarForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
FivestarForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
FivestarForm::fivestarAjaxVote	public	function	Ajax callback: update fivestar form after voting.
FivestarForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
FivestarForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
FivestarForm::__construct	public	function	Creates a new object of this class.
FormBase::$configFactory	protected	property	The config factory.	1
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::config	protected	function	Retrieves a configuration object.
FormBase::configFactory	protected	function	Gets the config factory for this form.	1
FormBase::container	private	function	Returns the service container.
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.

You are here

class FivestarForm in Fivestar 8

Hierarchy

File

Namespace

Members

API Navigation