WorkflowDefinitionExporter::export() - Code Metrics - silverstripe-australia/advancedworkflow - Measure and Improve Code Quality continuously with Scrutinizer

WorkflowDefinitionExporter::export() A
last analyzed 2016-05-03 01:01 UTC

↳ Parent: WorkflowDefinitionExporter

Complexity

Conditions	2
Paths	2

Size

Total Lines	14
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	14
rs	9.4285
cc	2
eloc	10
nc	2
nop	0

<?php
/**
 * Allows workflow definitions to be exported from one SilverStripe install, ready for import into another.
 * 
 * YAML is used for export as it's native to SilverStripe's config system and we're using {@link WorkflowTemplate}
 * for some of the import-specific heavy lifting, which is already heavily predicated on YAML.
 * 
 * @todo
 *	- If workflow-def is created badly, the "update template definition" logic, sometimes doesn't work
 * 
 * @author  [email protected]
 * @license BSD License (http://silverstripe.org/bsd-license/)
 * @package advancedworkflow
 */
class WorkflowDefinitionExporter {
namespace YourVendor;

class YourClass { }
	
	/**
	 * The base filename of the file to the exported
	 * 
	 * @var string
	 */
	public static $export_filename_prefix = 'workflow-definition-export';
	/**
	 *
	 * @var \Member
	 */
	protected $member;
	/**
	 * 
	 * @var \WorkflowDefinition
	 */
	protected $workflowDefinition;
	
	/**
	 * 
	 * @param number $definitionID
	 * @return void

	 */
	public function __construct($definitionID) {
		$this->setMember(Member::currentUser());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		$this->workflowDefinition = DataObject::get_by_id('WorkflowDefinition', $definitionID);		
	}
	
	/**
	 * 
	 * @param \Member $member
	 */
	public function setMember($member) {
		$this->member = $member;
	}
	
	/**
	 * @return \WorkflowDefinition
	 */
	public function getDefinition() {
		return $this->workflowDefinition;
	}
	
	/**
	 * Runs the export 
	 * 
	 * @return string $template
	 */
	public function export() {
		// Disable any access to use of WorkflowExport if user has no SecurityAdmin access
		if(!Permission::check('CMS_ACCESS_SecurityAdmin')) {
			throw Exception(_t('ErrorPage.403'), 403);
		}		
		$def = $this->getDefinition();
		$templateData = new ArrayData(array(
			'ExportMetaData' => $this->ExportMetaData(),
			'ExportActions' => $def->Actions(),

			'ExportUsers' => $def->Users(),
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
			'ExportGroups' => $def->Groups() 
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
		));
		return $this->format($templateData);
	}
	
	/**
	 * Format the exported data as YAML.
	 * 
	 * @param \ArrayData $templateData
	 * @return void
	 */
	public function format($templateData) {
		$viewer = SSViewer::execute_template('WorkflowDefinitionExport', $templateData);
		// Temporary until we find the source of the replacement in SSViewer
		$processed = str_replace('&amp;', '&', $viewer);
		// Clean-up newline "gaps" that SSViewer leaves behind from the placement of template control structures
		return preg_replace("#^\R+|^[\t\s]*\R+#m", '', $processed);
	}
	
	/**
	 * Returns the size of the current export in bytes.
	 * Used for pushing data to the browser to prompt for download
	 * 
	 * @param string $str
	 * @return number $bytes
	 */
	public function getExportSize($str) {
		return mb_strlen($str, 'UTF-8');
	}

	/**
	 * Generate template vars for metadata
	 * 
	 * @return ArrayData
	 */
	public function ExportMetaData() {
		$def = $this->getDefinition();
		return new ArrayData(array(
			'ExportHost' => preg_replace("#http(s)?://#", '', Director::protocolAndHost()),
			'ExportDate' => date('d/m/Y H-i-s'),
			'ExportUser' => $this->member->FirstName.' '.$this->member->Surname,
			'ExportVersionFramework' => $this->ssVersion(),
			'ExportWorkflowDefName' => $this->processTitle($def->Title),
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
			'ExportRemindDays' => $def->RemindDays,
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
			'ExportSort' => $def->Sort
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
		));
	}
	
	/*
	 * Try different ways of obtaining the current SilverStripe version for YAML output.
	 * 
	 * @return string
	 */
	private function ssVersion() {
		// Remove colons so they don't screw with YAML parsing
		$versionSapphire = str_replace(':', '', singleton('SapphireInfo')->Version());
		$versionLeftMain = str_replace(':', '', singleton('LeftAndMain')->CMSVersion());
		if($versionSapphire != _t('LeftAndMain.VersionUnknown')) {
			return $versionSapphire;
		}
		return $versionLeftMain;
	}
	
	private function processTitle($title) {
		// If an import is exported and re-imported, the new export date is appended to Title, making for a very long title
		return preg_replace("#\s[\d]+\/[\d]+\/[\d]+\s[\d]+-[\d]+-[\d]+(\s[\d]+)?#", '', $title);	
	}
	
	/**
	 * Prompt the client for file download.
	 * We're "overriding" SS_HTTPRequest::send_file() for more robust cross-browser support
	 * 
	 * @param array $filedata
	 * @return \SS_HTTPResponse $response
	 */
	public function sendFile($filedata) {
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
		$response = new SS_HTTPResponse($filedata['body']);
		if(preg_match("#MSIE\s(6|7|8)?\.0#",$_SERVER['HTTP_USER_AGENT'])) {
			// IE headers
			$response->addHeader("Cache-Control","public");
			$response->addHeader("Content-Disposition","attachment; filename=\"".basename($filedata['name'])."\"");
			$response->addHeader("Content-Type","application/force-download");
			$response->addHeader("Content-Type","application/octet-stream");
			$response->addHeader("Content-Type","application/download");
			$response->addHeader("Content-Type",$filedata['mime']);
			$response->addHeader("Content-Description","File Transfer");
			$response->addHeader("Content-Length",$filedata['size']);	
		}
		else {
			// Everyone else
			$response->addHeader("Content-Type", $filedata['mime']."; name=\"".addslashes($filedata['name'])."\"");
			$response->addHeader("Content-disposition", "attachment; filename=".addslashes($filedata['name']));
			$response->addHeader("Content-Length",$filedata['size']);
		}
		return $response;
	}
	
}


1			<?php
2			/**
3			* Allows workflow definitions to be exported from one SilverStripe install, ready for import into another.
4			*
5			* YAML is used for export as it's native to SilverStripe's config system and we're using {@link WorkflowTemplate}
6			* for some of the import-specific heavy lifting, which is already heavily predicated on YAML.
7			*
8			* @todo
9			* - If workflow-def is created badly, the "update template definition" logic, sometimes doesn't work
10			*
11			* @author [email protected]
12			* @license BSD License (http://silverstripe.org/bsd-license/)
13			* @package advancedworkflow
14			*/
15			class WorkflowDefinitionExporter {
			0 ignored issues – show Coding Style Compatibility introduced 2015-11-21 06:31 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
16
17			/**
18			* The base filename of the file to the exported
19			*
20			* @var string
21			*/
22			public static $export_filename_prefix = 'workflow-definition-export';
23			/**
24			*
25			* @var \Member
26			*/
27			protected $member;
28			/**
29			*
30			* @var \WorkflowDefinition
31			*/
32			protected $workflowDefinition;
33
34			/**
35			*
36			* @param number $definitionID
37			* @return void
			0 ignored issues – show Comprehensibility Best Practice introduced 2015-11-20 23:47 UTC by Report Bug Copy Issue Report Adding a `@return` annotation to constructors is generally not recommended as a constructor does not have a meaningful return value. Adding a `@return` annotation to a constructor is not recommended, since a constructor does not have a meaningful return value. Please refer to the PHP core documentation on constructors. Loading history...
38			*/
39			public function __construct($definitionID) {
40			$this->setMember(Member::currentUser());
			0 ignored issues – show Documentation introduced 2015-11-20 23:47 UTC by Report Bug Copy Issue Report `\Member::currentUser()` is of type `object<DataObject>\|null`, but the function expects a `object<Member>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
41			$this->workflowDefinition = DataObject::get_by_id('WorkflowDefinition', $definitionID);
42			}
43
44			/**
45			*
46			* @param \Member $member
47			*/
48			public function setMember($member) {
49			$this->member = $member;
50			}
51
52			/**
53			* @return \WorkflowDefinition
54			*/
55			public function getDefinition() {
56			return $this->workflowDefinition;
57			}
58
59			/**
60			* Runs the export
61			*
62			* @return string $template
63			*/
64			public function export() {
65			// Disable any access to use of WorkflowExport if user has no SecurityAdmin access
66			if(!Permission::check('CMS_ACCESS_SecurityAdmin')) {
67			throw Exception(_t('ErrorPage.403'), 403);
68			}
69			$def = $this->getDefinition();
70			$templateData = new ArrayData(array(
71			'ExportMetaData' => $this->ExportMetaData(),
72			'ExportActions' => $def->Actions(),
			0 ignored issues – show Bug introduced 2015-11-20 23:47 UTC by Report Bug Copy Issue Report The method `Actions()` does not exist on `WorkflowDefinition`. Did you maybe mean `updateAdminActions()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
73			'ExportUsers' => $def->Users(),
			0 ignored issues – show Documentation Bug introduced 2015-11-20 23:47 UTC by Report Bug Copy Issue Report The method `Users` does not exist on `object<WorkflowDefinition>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
74			'ExportGroups' => $def->Groups()
			0 ignored issues – show Documentation Bug introduced 2015-11-20 23:47 UTC by Report Bug Copy Issue Report The method `Groups` does not exist on `object<WorkflowDefinition>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
75			));
76			return $this->format($templateData);
77			}
78
79			/**
80			* Format the exported data as YAML.
81			*
82			* @param \ArrayData $templateData
83			* @return void
84			*/
85			public function format($templateData) {
86			$viewer = SSViewer::execute_template('WorkflowDefinitionExport', $templateData);
87			// Temporary until we find the source of the replacement in SSViewer
88			$processed = str_replace('&', '&', $viewer);
89			// Clean-up newline "gaps" that SSViewer leaves behind from the placement of template control structures
90			return preg_replace("#^\R+\|^[\t\s]*\R+#m", '', $processed);
91			}
92
93			/**
94			* Returns the size of the current export in bytes.
95			* Used for pushing data to the browser to prompt for download
96			*
97			* @param string $str
98			* @return number $bytes
99			*/
100			public function getExportSize($str) {
101			return mb_strlen($str, 'UTF-8');
102			}
103
104			/**
105			* Generate template vars for metadata
106			*
107			* @return ArrayData
108			*/
109			public function ExportMetaData() {
110			$def = $this->getDefinition();
111			return new ArrayData(array(
112			'ExportHost' => preg_replace("#http(s)?://#", '', Director::protocolAndHost()),
113			'ExportDate' => date('d/m/Y H-i-s'),
114			'ExportUser' => $this->member->FirstName.' '.$this->member->Surname,
115			'ExportVersionFramework' => $this->ssVersion(),
116			'ExportWorkflowDefName' => $this->processTitle($def->Title),
			0 ignored issues – show Documentation introduced 2015-11-20 23:47 UTC by Report Bug Copy Issue Report The property `Title` does not exist on `object<WorkflowDefinition>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
117			'ExportRemindDays' => $def->RemindDays,
			0 ignored issues – show Documentation introduced 2015-11-20 23:47 UTC by Report Bug Copy Issue Report The property `RemindDays` does not exist on `object<WorkflowDefinition>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
118			'ExportSort' => $def->Sort
			0 ignored issues – show Documentation introduced 2015-11-20 23:47 UTC by Report Bug Copy Issue Report The property `Sort` does not exist on `object<WorkflowDefinition>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
119			));
120			}
121
122			/*
123			* Try different ways of obtaining the current SilverStripe version for YAML output.
124			*
125			* @return string
126			*/
127			private function ssVersion() {
128			// Remove colons so they don't screw with YAML parsing
129			$versionSapphire = str_replace(':', '', singleton('SapphireInfo')->Version());
130			$versionLeftMain = str_replace(':', '', singleton('LeftAndMain')->CMSVersion());
131			if($versionSapphire != _t('LeftAndMain.VersionUnknown')) {
132			return $versionSapphire;
133			}
134			return $versionLeftMain;
135			}
136
137			private function processTitle($title) {
138			// If an import is exported and re-imported, the new export date is appended to Title, making for a very long title
139			return preg_replace("#\s[\d]+\/[\d]+\/[\d]+\s[\d]+-[\d]+-[\d]+(\s[\d]+)?#", '', $title);
140			}
141
142			/**
143			* Prompt the client for file download.
144			* We're "overriding" SS_HTTPRequest::send_file() for more robust cross-browser support
145			*
146			* @param array $filedata
147			* @return \SS_HTTPResponse $response
148			*/
149			public function sendFile($filedata) {
			0 ignored issues – show Coding Style introduced 2015-11-21 06:31 UTC by Report Bug Copy Issue Report `sendFile` uses the super-global variable `$_SERVER` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
150			$response = new SS_HTTPResponse($filedata['body']);
151			if(preg_match("#MSIE\s(6\|7\|8)?\.0#",$_SERVER['HTTP_USER_AGENT'])) {
152			// IE headers
153			$response->addHeader("Cache-Control","public");
154			$response->addHeader("Content-Disposition","attachment; filename=\"".basename($filedata['name'])."\"");
155			$response->addHeader("Content-Type","application/force-download");
156			$response->addHeader("Content-Type","application/octet-stream");
157			$response->addHeader("Content-Type","application/download");
158			$response->addHeader("Content-Type",$filedata['mime']);
159			$response->addHeader("Content-Description","File Transfer");
160			$response->addHeader("Content-Length",$filedata['size']);
161			}
162			else {
163			// Everyone else
164			$response->addHeader("Content-Type", $filedata['mime']."; name=\"".addslashes($filedata['name'])."\"");
165			$response->addHeader("Content-disposition", "attachment; filename=".addslashes($filedata['name']));
166			$response->addHeader("Content-Length",$filedata['size']);
167			}
168			return $response;
169			}
170
171			}
172

silverstripe-australia / advancedworkflow

WorkflowDefinitionExporter::export() A last analyzed 2016-05-03 01:01 UTC

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like

WorkflowDefinitionExporter::export() A
last analyzed 2016-05-03 01:01 UTC