class Type extends ConcreteObject (View source)

Properties

$error from ConcreteObject

Methods

loadError($error)

No description

isError()

No description

getError()

No description

setPropertiesFromArray($arr)

No description

static 
camelcase($file)

No description

static 
uncamelcase($string)

No description

int
getWorkflowTypeID()

Get the ID of this workflow type.

string
getWorkflowTypeHandle()

Get the handle of this workflow type.

string
getWorkflowTypeName()

Get the name of this workflow type.

int
getPackageID()

Get the ID of the package that created this workflow type.

string|bool
getPackageHandle()

Get the handle of the package that created this workflow type.

getWorkflows()

Gets all workflows belonging to this type, sorted by their display name.

delete()

Delete this workflow type and all workflows belonging to this type.

static Type
add(string $wftHandle, string $wftName, Package|Package|null|bool $pkg = false)

Add a new workflow type.

static Type|null
getByID(int $wftID)

Get a workflow type given its ID.

static Type|null
getByHandle($wftHandle)

Gets a Workflow Type by handle.

static Type[]
getList()

Get the list of the currently installed workflow types, sorted by their name.

static Type[]
getListByPackage(Package|Package $pkg)

Get the list of the currently installed workflow types that were created by a package, sorted by their name.

static 
exportList(SimpleXMLElement $xml)

Export the currently installed workflow types to XML.

Details

loadError($error)

Parameters

$error

isError()

getError()

setPropertiesFromArray($arr)

Parameters

$arr

static camelcase($file)

Parameters

$file

static uncamelcase($string)

Parameters

$string

int getWorkflowTypeID()

Get the ID of this workflow type.

Return Value

int

string getWorkflowTypeHandle()

Get the handle of this workflow type.

Return Value

string

string getWorkflowTypeName()

Get the name of this workflow type.

Return Value

string

int getPackageID()

Get the ID of the package that created this workflow type.

Return Value

int zero if no package defined this workflow type, the package ID otherwise

string|bool getPackageHandle()

Get the handle of the package that created this workflow type.

Return Value

string|bool false if no package defined this workflow type, the package handle otherwise

Workflow[] getWorkflows()

Gets all workflows belonging to this type, sorted by their display name.

Return Value

Workflow[]

delete()

Delete this workflow type and all workflows belonging to this type.

Exceptions

InvalidArgumentException

static Type add(string $wftHandle, string $wftName, Package|Package|null|bool $pkg = false)

Add a new workflow type.

Parameters

string $wftHandle The handle of the new workflow type
string $wftName The name of the new workflow type
Package|Package|null|bool $pkg the package that's creating the new workflow type

Return Value

Type

static Type|null getByID(int $wftID)

Get a workflow type given its ID.

Parameters

int $wftID

Return Value

Type|null

static Type|null getByHandle($wftHandle)

Gets a Workflow Type by handle.

Parameters

$wftHandle

Return Value

Type|null

static Type[] getList()

Get the list of the currently installed workflow types, sorted by their name.

Return Value

Type[]

static Type[] getListByPackage(Package|Package $pkg)

Get the list of the currently installed workflow types that were created by a package, sorted by their name.

Parameters

Package|Package $pkg

Return Value

Type[]

static exportList(SimpleXMLElement $xml)

Export the currently installed workflow types to XML.

Parameters

SimpleXMLElement $xml