VoteResultInterface.php in Voting API 8.3

Namespace

Drupal\votingapi

File

src/VoteResultInterface.php

<?php

namespace Drupal\votingapi;

use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\user\EntityOwnerInterface;

/**
 * Provides an interface defining a vote entity.
 */
interface VoteResultInterface extends ContentEntityInterface, EntityOwnerInterface {

  /**
   * Returns the type of entity that the vote was cast on.
   *
   * @return string
   *   The entity type.
   */
  public function getVotedEntityType();

  /**
   * Sets the type of entity that the vote was cast on.
   *
   * @param string $name
   *   The entity type.
   *
   * @return $this
   */
  public function setVotedEntityType($name);

  /**
   * Returns the ID of the entity that the vote was cast on.
   *
   * @return int
   *   The entity ID.
   */
  public function getVotedEntityId();

  /**
   * Sets the ID of the entity that the vote was cast on.
   *
   * @param int $id
   *   The entity ID.
   *
   * @return $this
   */
  public function setVotedEntityId($id);

  /**
   * Returns the vote value.
   *
   * @return float
   *   The numeric value of the vote.
   */
  public function getValue();

  /**
   * Sets the vote value.
   *
   * @param float $value
   *   The vote value.
   *
   * @return $this
   */
  public function setValue($value);

  /**
   * Returns the vote value type.
   *
   * @return string
   *   The value type of the vote.
   */
  public function getValueType();

  /**
   * Sets the vote value type.
   *
   * @param string $value_type
   *   The vote value type.
   *
   * @return $this
   */
  public function setValueType($value_type);

  /**
   * Gets the vote creation timestamp.
   *
   * @return int
   *   Creation timestamp of the vote.
   */
  public function getCreatedTime();

  /**
   * Sets the vote creation timestamp.
   *
   * @param int $timestamp
   *   The vote creation timestamp.
   *
   * @return $this
   */
  public function setCreatedTime($timestamp);

  /**
   * Returns the name of the function to apply to the numbers.
   *
   * @return string
   *   Name of the function to apply.
   */
  public function getFunction();

  /**
   * Sets the function to apply to the numbers.
   *
   * @param string $function
   *   The function name.
   *
   * @return $this
   */
  public function setFunction($function);

}

Interfaces

Name	Description
VoteResultInterface	Provides an interface defining a vote entity.