SetPropertyWorkflowAction::getCMSFields() - Code Metrics - Inspection of "Added unpublish action and moved set property from..." - silverstripe-australia/advancedworkflow - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#238)

unknown

created 2015-12-23 04:54 UTC

SetPropertyWorkflowAction::getCMSFields() A

↳ Parent: SetPropertyWorkflowAction

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	11
rs	9.4286
cc	1
eloc	7
nc	1
nop	0

<?php

/**
 * 
 *
 * @author Marcus Nyeholt <[email protected]>
 */
class SetPropertyWorkflowAction extends WorkflowAction {
namespace YourVendor;

class YourClass { }
	private static $db = array(

		'Property'	=> 'Varchar',
		'Value'		=> 'Text',
	);
	
	public function execute(WorkflowInstance $workflow) {
		if (!$target = $workflow->getTarget()) {
			return true;
		}

		if ($target->hasField($this->Property)) {
<?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.");
        }
    }

}
			$target->setField($this->Property, $this->Value);
<?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.");
        }
    }

}
		}

		$target->write();

		return true;
	}

	public function getCMSFields() {
		$fields = parent::getCMSFields();

		$fields->addFieldsToTab('Root.Main', array(
			TextField::create('Property', _t('SetPropertyWorkflowAction.PROPERTY', 'Property'))
				->setRightTitle(_t('SetPropertyWorkflowAction.PROPERTYTITLE', 'Property to set; if this exists as a setter method, will be called passing the value')),
			TextField::create('Value', 'Value')
		));

		return $fields;
	}

}


1			<?php
2
3			/**
4			*
5			*
6			* @author Marcus Nyeholt <[email protected]>
7			*/
8			class SetPropertyWorkflowAction extends WorkflowAction {
			0 ignored issues – show Coding Style Compatibility introduced 2015-12-23 08:25 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...
9			private static $db = array(
			0 ignored issues – show Comprehensibility introduced 2015-12-23 08:25 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2015-12-23 08:25 UTC by Report Bug Copy Issue Report The property `$db` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
10			'Property' => 'Varchar',
11			'Value' => 'Text',
12			);
13
14			public function execute(WorkflowInstance $workflow) {
15			if (!$target = $workflow->getTarget()) {
16			return true;
17			}
18
19			if ($target->hasField($this->Property)) {
			0 ignored issues – show Documentation introduced 2015-12-23 08:25 UTC by Report Bug Copy Issue Report The property `Property` does not exist on `object<SetPropertyWorkflowAction>`. 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...
20			$target->setField($this->Property, $this->Value);
			0 ignored issues – show Documentation introduced 2015-12-23 08:25 UTC by Report Bug Copy Issue Report The property `Property` does not exist on `object<SetPropertyWorkflowAction>`. 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... Documentation introduced 2015-12-23 08:25 UTC by Report Bug Copy Issue Report The property `Value` does not exist on `object<SetPropertyWorkflowAction>`. 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...
21			}
22
23			$target->write();
24
25			return true;
26			}
27
28			public function getCMSFields() {
29			$fields = parent::getCMSFields();
30
31			$fields->addFieldsToTab('Root.Main', array(
32			TextField::create('Property', _t('SetPropertyWorkflowAction.PROPERTY', 'Property'))
33			->setRightTitle(_t('SetPropertyWorkflowAction.PROPERTYTITLE', 'Property to set; if this exists as a setter method, will be called passing the value')),
34			TextField::create('Value', 'Value')
35			));
36
37			return $fields;
38			}
39
40			}
41

silverstripe-australia / advancedworkflow

Pull Request — master (#238)

SetPropertyWorkflowAction::getCMSFields() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like