Skip to content
docsv0.1.0

TransitionDefinition

TransitionDefinition entity - Define transiciones validas entre estados. Configuracion data-driven de la maquina de estados. Cada transicion conecta un fromState con un toState y puede requerir uno o mas gates.

TransitionDefinition::__construct()

public function __construct():

TransitionDefinition::onPreUpdate()

public function onPreUpdate(): void

TransitionDefinition::getId()

public function getId(): int

TransitionDefinition::getDomain()

public function getDomain(): string

TransitionDefinition::getCode()

public function getCode(): string

TransitionDefinition::getLabel()

public function getLabel(): ?string

TransitionDefinition::getRequiredRole()

public function getRequiredRole(): ?string

TransitionDefinition::isEnabled()

public function isEnabled(): bool

TransitionDefinition::getMetadata()

public function getMetadata(): ?array

TransitionDefinition::getCreatedAt()

public function getCreatedAt(): DateTime

TransitionDefinition::getUpdatedAt()

public function getUpdatedAt(): DateTime

TransitionDefinition::getFromState()

public function getFromState(): Milpa\Workflow\Entities\StateDefinition

TransitionDefinition::getToState()

public function getToState(): Milpa\Workflow\Entities\StateDefinition

TransitionDefinition::getGateDefinitions()

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

TransitionDefinition::setDomain()

public function setDomain(string $domain): self

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

Parameters

Parameters of setDomain()
NameTypeDescription
$domainstring

TransitionDefinition::setCode()

public function setCode(string $code): self

Sets the transition's unique code within its domain.

Parameters

Parameters of setCode()
NameTypeDescription
$codestring

TransitionDefinition::setLabel()

public function setLabel(?string $label): self

Sets the transition's human-readable label.

Parameters

Parameters of setLabel()
NameTypeDescription
$label?string

TransitionDefinition::setRequiredRole()

public function setRequiredRole(?string $requiredRole): self

Sets the minimum role required to execute this transition.

Parameters

Parameters of setRequiredRole()
NameTypeDescription
$requiredRole?string

TransitionDefinition::setEnabled()

public function setEnabled(bool $enabled): self

Sets whether this transition is enabled.

Parameters

Parameters of setEnabled()
NameTypeDescription
$enabledbool

TransitionDefinition::setMetadata()

public function setMetadata(?array $metadata): self

Sets additional metadata for the transition.

Parameters

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

TransitionDefinition::setFromState()

public function setFromState(Milpa\Workflow\Entities\StateDefinition $fromState): self

Sets the state this transition originates from.

Parameters

Parameters of setFromState()
NameTypeDescription
$fromStateMilpa\Workflow\Entities\StateDefinition

TransitionDefinition::setToState()

public function setToState(Milpa\Workflow\Entities\StateDefinition $toState): self

Sets the state this transition arrives at.

Parameters

Parameters of setToState()
NameTypeDescription
$toStateMilpa\Workflow\Entities\StateDefinition

TransitionDefinition::addGateDefinition()

public function addGateDefinition(Milpa\Workflow\Entities\GateDefinition $gateDefinition): self

Adds a gate that must pass before this transition is allowed.

Parameters

Parameters of addGateDefinition()
NameTypeDescription
$gateDefinitionMilpa\Workflow\Entities\GateDefinition

TransitionDefinition::removeGateDefinition()

public function removeGateDefinition(Milpa\Workflow\Entities\GateDefinition $gateDefinition): self

Removes a gate from this transition's requirements.

Parameters

Parameters of removeGateDefinition()
NameTypeDescription
$gateDefinitionMilpa\Workflow\Entities\GateDefinition

TransitionDefinition::hasGates()

public function hasGates(): bool

Checks if this transition has any gates configured.

TransitionDefinition::toArray()

public function toArray(): array

Converts the entity to an array for API responses.