interface StepInterface in Forms Steps 8

An interface for step value objects.

Hierarchy

• interface \Drupal\forms_steps\StepInterface

File

src/StepInterface.php, line 8

Namespace

Drupal\forms_steps

interface StepInterface {

  /**
   * Gets the step's ID.
   *
   * @return string
   *   The step's ID.
   */
  public function id();

  /**
   * Gets the step's label.
   *
   * @return string
   *   The step's label.
   */
  public function label();

  /**
   * Gets the step's weight.
   *
   * @return int
   *   The step's weight.
   */
  public function weight();

  /**
   * Gets the step's bundle.
   *
   * @return string
   *   The step's entity bundle.
   */
  public function entityBundle();

  /**
   * Gets the step's entity type.
   *
   * @return string
   *   The step's entity type.
   */
  public function entityType();

  /**
   * Gets the step's form mode.
   *
   * @return string
   *   The step's form mode.
   */
  public function formMode();

  /**
   * Gets the step's url.
   *
   * @return string
   *   The step's url.
   */
  public function url();

  /**
   * Gets the submit label.
   *
   * @return string
   *   The submit label.
   */
  public function submitLabel();

  /**
   * Set the submit label.
   *
   * @param string $label
   *   The label to set.
   */
  public function setSubmitLabel($label);

  /**
   * Gets the cancel label.
   *
   * @return string
   *   The cancel label.
   */
  public function cancelLabel();

  /**
   * Set the cancel label.
   *
   * @param string $label
   *   The label to set.
   */
  public function setCancelLabel($label);

  /**
   * Gets the cancel route.
   *
   * @return string
   *   The cancel route.
   */
  public function cancelRoute();

  /**
   * Set the cancel route.
   *
   * @param string $route
   *   The cancel route to set.
   */
  public function setCancelRoute($route);

  /**
   * Gets the cancel step.
   *
   * @return \Drupal\forms_steps\Step
   *   The cancel step.
   */
  public function cancelStep();

  /**
   * Set the cancel step.
   *
   * @param \Drupal\forms_steps\Step $step
   *   The step to go when the user click the cancel button.
   */
  public function setCancelStep(Step $step);

  /**
   * Gets the cancel step mode.
   *
   * @return string
   *   The cancel step mode.
   */
  public function cancelStepMode();

  /**
   * Set the cancel step mode.
   *
   * @param mixed $mode
   *   Mode.
   */
  public function setCancelStepMode($mode);

  /**
   * Get the hidden status of the delete button.
   *
   * @return bool
   *   TRUE if hidden | FALSE otherwise.
   */
  public function hideDelete();

  /**
   * Set the hidden state of the delete button.
   *
   * @param bool $value
   *   TRUE if hidden | FALSE otherwise.
   */
  public function setHideDelete($value);

  /**
   * Set the delete label.
   *
   * @param mixed $label
   *   The label to set.
   */
  public function setDeleteLabel($label);

  /**
   * Get the forms steps object parent to this step.
   *
   * @return \Drupal\forms_steps\Step
   *   The forms steps object.
   */
  public function formsSteps();

  /**
   * Get the display status of the previous button.
   *
   * @return bool
   *   TRUE if displayed | FALSE otherwise.
   */
  public function displayPrevious();

  /**
   * Set the previous label.
   *
   * @param mixed $label
   *   The label to set.
   */
  public function setPreviousLabel($label);

  /**
   * Gets the previous label.
   *
   * @return string
   *   The previous label.
   */
  public function previousLabel();

  /**
   * Set the display state of the previous button.
   *
   * @param bool $value
   *   TRUE if displayed | FALSE otherwise.
   */
  public function setDisplayPrevious($value);

  /**
   * Determines if the step is the last one on its forms steps entity.
   */
  public function isLast();

}

Members

Name	Modifiers	Type	Description	Overrides
StepInterface::cancelLabel	public	function	Gets the cancel label.	1
StepInterface::cancelRoute	public	function	Gets the cancel route.	1
StepInterface::cancelStep	public	function	Gets the cancel step.	1
StepInterface::cancelStepMode	public	function	Gets the cancel step mode.	1
StepInterface::displayPrevious	public	function	Get the display status of the previous button.	1
StepInterface::entityBundle	public	function	Gets the step's bundle.	1
StepInterface::entityType	public	function	Gets the step's entity type.	1
StepInterface::formMode	public	function	Gets the step's form mode.	1
StepInterface::formsSteps	public	function	Get the forms steps object parent to this step.	1
StepInterface::hideDelete	public	function	Get the hidden status of the delete button.	1
StepInterface::id	public	function	Gets the step's ID.	1
StepInterface::isLast	public	function	Determines if the step is the last one on its forms steps entity.	1
StepInterface::label	public	function	Gets the step's label.	1
StepInterface::previousLabel	public	function	Gets the previous label.	1
StepInterface::setCancelLabel	public	function	Set the cancel label.	1
StepInterface::setCancelRoute	public	function	Set the cancel route.	1
StepInterface::setCancelStep	public	function	Set the cancel step.	1
StepInterface::setCancelStepMode	public	function	Set the cancel step mode.	1
StepInterface::setDeleteLabel	public	function	Set the delete label.	1
StepInterface::setDisplayPrevious	public	function	Set the display state of the previous button.	1
StepInterface::setHideDelete	public	function	Set the hidden state of the delete button.	1
StepInterface::setPreviousLabel	public	function	Set the previous label.	1
StepInterface::setSubmitLabel	public	function	Set the submit label.	1
StepInterface::submitLabel	public	function	Gets the submit label.	1
StepInterface::url	public	function	Gets the step's url.	1
StepInterface::weight	public	function	Gets the step's weight.	1