flow-1.0.0-beta8/src/Entity/FlowInterface.php

<?php

namespace Drupal\flow\Entity;

use Drupal\Core\Config\Entity\ConfigEntityInterface;
use Drupal\Core\Entity\EntityWithPluginCollectionInterface;
use Drupal\flow\Plugin\FlowQualifierCollection;
use Drupal\flow\Plugin\FlowSubjectCollection;
use Drupal\flow\Plugin\FlowTaskCollection;

/**
 * Interface for Flow config entities.
 */
interface FlowInterface extends ConfigEntityInterface, EntityWithPluginCollectionInterface {

  /**
   * Get the status value, i.e. whether this configuration is enabled.
   *
   * @return bool
   *   The status.
   */
  public function getStatus(): bool;

  /**
   * Set the default status value.
   *
   * @param bool $status
   *   The default status value.
   *
   * @return $this
   */
  public function setStatus($status): FlowInterface;

  /**
   * Gets the entity type for which this flow is used.
   *
   * @return string
   *   The entity type id.
   */
  public function getTargetEntityTypeId(): string;

  /**
   * Gets the bundle for which this flow is used.
   *
   * @return string
   *   The bundle.
   */
  public function getTargetBundle(): string;

  /**
   * Get the task mode, usually one of "create", "save" or "delete".
   *
   * @return string
   *   The task mode.
   */
  public function getTaskMode(): string;

  /**
   * Get the Flow tasks.
   *
   * @param array|null $filter
   *   (optional) Filter by certain tasks, for example when loading only active
   *   tasks, set ['active' => TRUE]. Default is NULL, which is no filter.
   *
   * @return \Drupal\flow\Plugin\FlowTaskCollection
   *   The Flow tasks, sorted by weight.
   */
  public function getTasks(?array $filter = NULL): FlowTaskCollection;

  /**
   * Get the Flow subjects.
   *
   * @param array|null $filter
   *   (optional) Filter subjects by certain tasks, for example when loading
   *   only for active tasks, set ['active' => TRUE]. Default is NULL, which is
   *   no filter.
   *
   * @return \Drupal\flow\Plugin\FlowSubjectCollection
   *   The Flow subjects, sorted in the according order of tasks.
   */
  public function getSubjects(?array $filter = NULL): FlowSubjectCollection;

  /**
   * Set the flow task settings.
   *
   * @param array $tasks
   *   The flow task settings. This list will be re-sorted by weight.
   *
   * @return $this
   */
  public function setTasks(array $tasks): FlowInterface;

  /**
   * Whether this configuration is custom flow.
   *
   * When this configuration is custom flow, then custom settings are available
   * within the config property "custom".
   *
   * @code
   * if ($flow->isCustom()) {
   *   $custom = $flow->get('custom');
   *   $custom_label = $custom['label'];
   * }
   * @endcode
   *
   * @return bool
   *   Returns TRUE if custom, FALSE otherwise.
   */
  public function isCustom(): bool;

  /**
   * Get custom flow according to this configuration.
   *
   * Custom flow is any Flow configuration entity that is referring to the same
   * entity type and bundle, plus using the same task mode as base task mode.
   *
   * @return \Drupal\flow\Entity\FlowInterface[]
   *   A list of according custom flow.
   */
  public function getCustomFlow(): array;

  /**
   * Get custom Flow qualifiers.
   *
   * @param array|null $filter
   *   (optional) Filter by certain qualifiers, for example when
   *   loading only for active qualifiers, set ['active' => TRUE].
   *   Default is NULL, which is no filter.
   *
   * @return \Drupal\flow\Plugin\FlowQualifierCollection
   *   The Flow qualifiers.
   */
  public function getQualifiers(?array $filter = NULL): FlowQualifierCollection;

  /**
   * Get custom qualifying Flow subjects.
   *
   * @param array|null $filter
   *   (optional) Filter subjects by certain qualifiers, for example when
   *   loading only for active qualifiers, set ['active' => TRUE].
   *   Default is NULL, which is no filter.
   *
   * @return \Drupal\flow\Plugin\FlowSubjectCollection
   *   The qualifying Flow subjects, sorted in the same order of qualifiers.
   */
  public function getQualifyingSubjects(?array $filter = NULL): FlowSubjectCollection;

}