LFT
  • Namespace
  • Class
  • Tree

Namespaces

  • Docoflow
    • Contracts
    • Entity
    • Facades
    • Models
    • Traits
  • Docolight
    • Agno
      • Traits
    • Container
    • Http
      • Contracts
    • Rest
      • Handler
      • Http
    • Support
      • Debug
      • Traits
  • Docotory
    • Traits
  • None

Classes

  • Docoflow
  • Flo

Class Docoflow

Workflow model. Use this class to save your workflow.

Namespace: Docoflow
Author: Krisan Alfa Timur krisanalfa@docotel.co.id
Located at Docoflow/Docoflow.php

Methods summary

public
# __construct( string $name, Docoflow\Entity\Step $step = null, Docoflow\Entity\Group $group = null, Docoflow\Entity\Verificator $verificator = null )

Docoflow class constructor.

Docoflow class constructor.

Parameters

$name
Your workflow name
$step
Your workflow step entities
$group
Your workflow group entities
$verificator
Your workflow verificator entities
public static
# make( string $name, Docoflow\Entity\Step $step = null, Docoflow\Entity\Group $group = null, Docoflow\Entity\Verificator $verificator = null )

Statically create Docoflow instance.

Statically create Docoflow instance.

Parameters

$name
Your workflow name
$step
Your workflow step entities
$group
Your workflow group entities
$verificator
Your workflow verificator entities
public Docoflow\Docoflow
# withStep( Docoflow\Entity\Step $step )

Inject step entities to a record.

Inject step entities to a record.

Parameters

$step

Returns

Docoflow\Docoflow
public Docoflow\Docoflow
# withGroup( Docoflow\Entity\Group $group )

Inject step group entities to a record.

Inject step group entities to a record.

Parameters

$group

Returns

Docoflow\Docoflow
public Docoflow\Docoflow
# withVerificator( Docoflow\Entity\Verificator $verificator )

Inject verificator entities to a record.

Inject verificator entities to a record.

Parameters

$verificator

Returns

Docoflow\Docoflow
public Docoflow\Docoflow
# validUntil( Datetime $expiredDate )

Make a workflow valid until certain time.

Make a workflow valid until certain time.

Parameters

$expiredDate

Returns

Docoflow\Docoflow
public Docoflow\Models\Workflow
# save( )

Save a workflow.

Save a workflow.

Returns

Docoflow\Models\Workflow
public Docoflow\Docoflow
# prepare( )

Prepare data before saving

Prepare data before saving

Returns

Docoflow\Docoflow
public Docoflow\Entity\Step
# getPreparedData( )

Get prepared data.

Get prepared data.

Returns

Docoflow\Entity\Step
protected
# createNewWorkFlow( )

Make a new workflow.

Make a new workflow.

protected id
# createWorkflowDefinition( id $newWorkFlowId )

Create steps, groups, and verificators definition.

Create steps, groups, and verificators definition.

Parameters

$newWorkFlowId

Returns

id
Newly saved workflow id.
protected
# createWorkflowGroup( Docoflow\Entity\Group $groups, id $newStepId )

Create workflow group.

Create workflow group.

Parameters

$groups
$newStepId
protected
# createWorkflowVerificator( Docoflow\Entity\Verificator $verificators, id $newGroupId )

Create workflow verificators.

Create workflow verificators.

Parameters

$verificators
$newGroupId

Properties summary

protected Docoflow\Entity\Step $prepared

Prepare a data to be stored in database.

Prepare a data to be stored in database.

#
protected Docoflow\Models\Workflow $workflow

Workflow active record.

Workflow active record.

#
protected Docoflow\Entity\Step $step

Workflow step entities.

Workflow step entities.

#
protected Docoflow\Entity\Group $group

Workflow group entities.

Workflow group entities.

#
protected Docoflow\Entity\Verificator $verificator

Verificator entities.

Verificator entities.

#
protected Datetime $expiredDate

Expiracy date of this workflow.

Expiracy date of this workflow.

#
LFT API documentation generated by ApiGen