You are here

KanbanLogInterface.php in Content Planner 8

File

modules/content_kanban/src/Entity/KanbanLogInterface.php
View source
<?php

namespace Drupal\content_kanban\Entity;

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

/**
 * Provides an interface for defining Kanban Log entities.
 *
 * @ingroup content_kanban
 */
interface KanbanLogInterface extends ContentEntityInterface, EntityChangedInterface, EntityOwnerInterface {

  /**
   * Gets the Kanban Log name.
   *
   * @return string
   *   Name of the Kanban Log.
   */
  public function getName();

  /**
   * Sets the Kanban Log name.
   *
   * @param string $name
   *   The Kanban Log name.
   *
   * @return \Drupal\content_kanban\Entity\KanbanLogInterface
   *   The called Kanban Log entity.
   */
  public function setName($name);

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

  /**
   * Sets the Kanban Log creation timestamp.
   *
   * @param int $timestamp
   *   The Kanban Log creation timestamp.
   *
   * @return \Drupal\content_kanban\Entity\KanbanLogInterface
   *   The called Kanban Log entity.
   */
  public function setCreatedTime($timestamp);

  /**
   * Returns the Kanban Log published status indicator.
   *
   * Unpublished Kanban Log are only visible to restricted users.
   *
   * @return bool
   *   TRUE if the Kanban Log is published.
   */
  public function isPublished();

  /**
   * Sets the published status of a Kanban Log.
   *
   * @param bool $published
   *   TRUE to set this Kanban Log to published, FALSE to set it to unpublished.
   *
   * @return \Drupal\content_kanban\Entity\KanbanLogInterface
   *   The called Kanban Log entity.
   */
  public function setPublished($published);

  /**
   * Gets the type of the entity.
   *
   * @return string
   *   The content entity type.
   */
  public function getType();

  /**
   * Gets the entity loaded based on id and type.
   *
   * @return \Drupal\Core\Entity\ContentEntityInterface|bool
   *   The content entity if exists, FALSE otherwise.
   */
  public function getEntityObject();

  /**
   * Gets the entity ID.
   *
   * @return int
   *   The content entity ID.
   */
  public function getEntityId();

}

Interfaces

Namesort descending Description
KanbanLogInterface Provides an interface for defining Kanban Log entities.