You are here

public function FormsSteps::setProgressStepLabel in Forms Steps 8

Sets a progress step's label.

Parameters

string $progress_step_id: The progress step ID to set the label for.

string $label: The progress step's label.

Return value

\Drupal\forms_steps\ProgressStepInterface The forms_steps entity.

Overrides FormsStepsInterface::setProgressStepLabel

File

src/Entity/FormsSteps.php, line 511

Class

FormsSteps
FormsSteps configuration entity to persistently store configuration.

Namespace

Drupal\forms_steps\Entity

Code

public function setProgressStepLabel($progress_step_id, $label) {
  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()}'");
  }
  $this->progress_steps[$progress_step_id]['label'] = $label;
  return $this;
}