Skip to content
docsv0.1.0

StateDefinition

StateDefinition entity - Define los estados posibles para una maquina de estados. Configuracion data-driven de los estados del pipeline. Cada dominio (opportunity, project) tiene su propio conjunto de estados ordenados, con marcadores de estado inicial y terminal.

StateDefinition::__construct()

public function __construct():

StateDefinition::onPreUpdate()

public function onPreUpdate(): void

StateDefinition::getId()

public function getId(): int

StateDefinition::getDomain()

public function getDomain(): string

StateDefinition::getCode()

public function getCode(): string

StateDefinition::getLabel()

public function getLabel(): string

StateDefinition::getDescription()

public function getDescription(): ?string

StateDefinition::getSortOrder()

public function getSortOrder(): int

StateDefinition::isInitial()

public function isInitial(): bool

StateDefinition::isTerminal()

public function isTerminal(): bool

StateDefinition::getColor()

public function getColor(): string

StateDefinition::getMetadata()

public function getMetadata(): ?array

StateDefinition::getCreatedAt()

public function getCreatedAt(): DateTime

StateDefinition::getUpdatedAt()

public function getUpdatedAt(): DateTime

StateDefinition::getTransitionsFrom()

public function getTransitionsFrom(): Doctrine\Common\Collections\Collection

StateDefinition::getTransitionsTo()

public function getTransitionsTo(): Doctrine\Common\Collections\Collection

StateDefinition::setDomain()

public function setDomain(string $domain): self

Sets the domain this state belongs to (e.g. "opportunity", "project").

Parameters

Parameters of setDomain()
NameTypeDescription
$domainstring

StateDefinition::setCode()

public function setCode(string $code): self

Sets the state's unique code within its domain.

Parameters

Parameters of setCode()
NameTypeDescription
$codestring

StateDefinition::setLabel()

public function setLabel(string $label): self

Sets the state's human-readable label.

Parameters

Parameters of setLabel()
NameTypeDescription
$labelstring

StateDefinition::setDescription()

public function setDescription(?string $description): self

Sets the state's optional description.

Parameters

Parameters of setDescription()
NameTypeDescription
$description?string

StateDefinition::setSortOrder()

public function setSortOrder(int $sortOrder): self

Sets the state's display sort order within the pipeline.

Parameters

Parameters of setSortOrder()
NameTypeDescription
$sortOrderint

StateDefinition::setIsInitial()

public function setIsInitial(bool $isInitial): self

Sets whether this is the domain's initial state.

Parameters

Parameters of setIsInitial()
NameTypeDescription
$isInitialbool

StateDefinition::setIsTerminal()

public function setIsTerminal(bool $isTerminal): self

Sets whether this is a terminal state (end of the pipeline).

Parameters

Parameters of setIsTerminal()
NameTypeDescription
$isTerminalbool

StateDefinition::setColor()

public function setColor(string $color): self

Sets the state's display color.

Parameters

Parameters of setColor()
NameTypeDescription
$colorstring

StateDefinition::setMetadata()

public function setMetadata(?array $metadata): self

Sets additional metadata for the state.

Parameters

Parameters of setMetadata()
NameTypeDescription
$metadata(array<string, mixed> | null)

StateDefinition::addTransitionFrom()

public function addTransitionFrom(Milpa\Workflow\Entities\TransitionDefinition $transition): self

Adds a transition originating from this state, wiring the inverse side back.

Parameters

Parameters of addTransitionFrom()
NameTypeDescription
$transitionMilpa\Workflow\Entities\TransitionDefinition

StateDefinition::removeTransitionFrom()

public function removeTransitionFrom(Milpa\Workflow\Entities\TransitionDefinition $transition): self

Removes a transition originating from this state, clearing the inverse side.

Parameters

Parameters of removeTransitionFrom()
NameTypeDescription
$transitionMilpa\Workflow\Entities\TransitionDefinition

StateDefinition::addTransitionTo()

public function addTransitionTo(Milpa\Workflow\Entities\TransitionDefinition $transition): self

Adds a transition arriving at this state, wiring the inverse side back.

Parameters

Parameters of addTransitionTo()
NameTypeDescription
$transitionMilpa\Workflow\Entities\TransitionDefinition

StateDefinition::removeTransitionTo()

public function removeTransitionTo(Milpa\Workflow\Entities\TransitionDefinition $transition): self

Removes a transition arriving at this state, clearing the inverse side.

Parameters

Parameters of removeTransitionTo()
NameTypeDescription
$transitionMilpa\Workflow\Entities\TransitionDefinition

StateDefinition::toArray()

public function toArray(): array

Converts the entity to an array for API responses.