WorkflowInternalInterface::getWorkflowNames() - Code Metrics - old-town/old-town-workflow - Measure and Improve Code Quality continuously with Scrutinizer

WorkflowInternalInterface::getWorkflowNames()
last analyzed 2016-03-11 07:02 UTC

↳ Parent: WorkflowInternalInterface

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	1

<?php
/**
 * @link https://github.com/old-town/old-town-workflow
 * @author  Malofeykin Andrey  <[email protected]>
 */
namespace OldTown\Workflow;

use OldTown\Workflow\Config\ConfigurationInterface;
use OldTown\Workflow\Exception\FactoryException;
use OldTown\Workflow\Exception\InvalidArgumentException;
use OldTown\Workflow\Loader\WorkflowDescriptor;

/**
 * Interface WorkflowInternalInterface
 *
 * @package OldTown\Workflow
 */
interface WorkflowInternalInterface extends WorkflowInterface
{
    /**
     * Get the available actions for the specified workflow instance.
     * @param integer $id The workflow instance id.
     * @param array $inputs The inputs map to pass on to conditions
     * @return []

     * @throws InvalidArgumentException if the specified id does not exist, or if its workflow
     * descriptor is no longer available or has become invalid.
     */
    public function getAvailableActions($id, array $inputs = []);

    /**
     * Set the configuration for this workflow.
     * If not set, then the workflow will use the default configuration static instance.
     * @param ConfigurationInterface $configuration a workflow configuration
     * @return $this
     */
    public function setConfiguration(ConfigurationInterface $configuration);

    /**
     * Get all available workflow names.
     *
     * @return String[]
     */
    public function getWorkflowNames();

    /**
     * Determine if a particular workflow can be initialized.
     * @param string $workflowName The workflow name to check.
     * @param integer $initialAction The potential initial action.
     * @param array $inputs The inputs to check.
     * @return boolean true if the workflow can be initialized, false otherwise.
     */
    //public function canInitialize($workflowName, $initialAction, array $inputs = []);


    /**
     * Remove the specified workflow descriptor.
     * @param string $workflowName The workflow name of the workflow to remove.
     * @return boolean true if the workflow was removed, false otherwise.
     * @throws FactoryException If the underlying workflow factory has an error removing the workflow,
     * or if it does not support the removal of workflows.
     */
    public function removeWorkflowDescriptor($workflowName);

    /**
     * Add a new workflow descriptor
     * @param string $workflowName The workflow name of the workflow to add
     * @param WorkflowDescriptor $descriptor The workflow descriptor to add
     * @param boolean $replace true, if an existing descriptor should be overwritten
     * @return boolean true if the workflow was added, fales otherwise
     * @throws FactoryException If the underlying workflow factory has an error adding the workflow,
     * or if it does not support adding workflows.
     */
    public function saveWorkflowDescriptor($workflowName, WorkflowDescriptor $descriptor, $replace);
}


1			<?php
2			/**
3			* @link https://github.com/old-town/old-town-workflow
4			* @author Malofeykin Andrey <[email protected]>
5			*/
6			namespace OldTown\Workflow;
7
8			use OldTown\Workflow\Config\ConfigurationInterface;
9			use OldTown\Workflow\Exception\FactoryException;
10			use OldTown\Workflow\Exception\InvalidArgumentException;
11			use OldTown\Workflow\Loader\WorkflowDescriptor;
12
13			/**
14			* Interface WorkflowInternalInterface
15			*
16			* @package OldTown\Workflow
17			*/
18			interface WorkflowInternalInterface extends WorkflowInterface
19			{
20			/**
21			* Get the available actions for the specified workflow instance.
22			* @param integer $id The workflow instance id.
23			* @param array $inputs The inputs map to pass on to conditions
24			* @return []
			0 ignored issues – show Documentation introduced 2016-02-12 06:27 UTC by Report Bug Copy Issue Report The doc-type `[]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
25			* @throws InvalidArgumentException if the specified id does not exist, or if its workflow
26			* descriptor is no longer available or has become invalid.
27			*/
28			public function getAvailableActions($id, array $inputs = []);
29
30			/**
31			* Set the configuration for this workflow.
32			* If not set, then the workflow will use the default configuration static instance.
33			* @param ConfigurationInterface $configuration a workflow configuration
34			* @return $this
35			*/
36			public function setConfiguration(ConfigurationInterface $configuration);
37
38			/**
39			* Get all available workflow names.
40			*
41			* @return String[]
42			*/
43			public function getWorkflowNames();
44
45			/**
46			* Determine if a particular workflow can be initialized.
47			* @param string $workflowName The workflow name to check.
48			* @param integer $initialAction The potential initial action.
49			* @param array $inputs The inputs to check.
50			* @return boolean true if the workflow can be initialized, false otherwise.
51			*/
52			//public function canInitialize($workflowName, $initialAction, array $inputs = []);
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-12 06:27 UTC by Report Bug Copy Issue Report `60%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
53
54			/**
55			* Remove the specified workflow descriptor.
56			* @param string $workflowName The workflow name of the workflow to remove.
57			* @return boolean true if the workflow was removed, false otherwise.
58			* @throws FactoryException If the underlying workflow factory has an error removing the workflow,
59			* or if it does not support the removal of workflows.
60			*/
61			public function removeWorkflowDescriptor($workflowName);
62
63			/**
64			* Add a new workflow descriptor
65			* @param string $workflowName The workflow name of the workflow to add
66			* @param WorkflowDescriptor $descriptor The workflow descriptor to add
67			* @param boolean $replace true, if an existing descriptor should be overwritten
68			* @return boolean true if the workflow was added, fales otherwise
69			* @throws FactoryException If the underlying workflow factory has an error adding the workflow,
70			* or if it does not support adding workflows.
71			*/
72			public function saveWorkflowDescriptor($workflowName, WorkflowDescriptor $descriptor, $replace);
73			}
74

old-town / old-town-workflow

GitHub Access Token became invalid

WorkflowInternalInterface::getWorkflowNames() last analyzed 2016-03-11 07:02 UTC

Size

Duplication

Duplication Side-by-Side

Filter issues like

WorkflowInternalInterface::getWorkflowNames()
last analyzed 2016-03-11 07:02 UTC