public function FormsSteps::deleteProgressStep in Forms Steps 8

Deletes a progress step from the forms_steps.

Parameters

string $progress_step_id: The progress step ID to delete.

Return value

\Drupal\forms_steps\ProgressStepInterface The forms_steps entity.

Throws

\InvalidArgumentException Thrown if $progress_step_id does not exist.

Overrides FormsStepsInterface::deleteProgressStep

File

src/Entity/FormsSteps.php, line 765

Class

FormsSteps

FormsSteps configuration entity to persistently store configuration.

Namespace

Drupal\forms_steps\Entity

Code

public function deleteProgressStep($progress_step_id) {
  if (!isset($this->progress_steps[$progress_step_id])) {
    throw new \InvalidArgumentException("The progress step '{$progress_step_id}' does not exist in forms steps '{$this->id()}'");
  }
  unset($this->progress_steps[$progress_step_id]);
  return $this;
}