SiteTreeLinkTracking_Parser::process() - Code Metrics - Inspection of "FIX: preg_quote() anchors in SiteTreeLinkTracking..." - silverstripe/silverstripe-cms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 3.2 (#1360)

by Loz

created 2016-01-11 16:45 UTC

SiteTreeLinkTracking_Parser::process() D

↳ Parent: SiteTreeLinkTracking_Parser

Complexity

Conditions	13
Paths	15

Size

Total Lines	85
Code Lines	51

Duplication

Lines	22
Ratio	25.88 %

Metric	Value
dl	22
loc	85
rs	4.9923
cc	13
eloc	51
nc	15
nop	1

How to fix Long Method Complexity

<?php

/**
 * @package cms
 * @subpackage model
 */

/**
 * Adds tracking of links in any HTMLText fields which reference SiteTree or File items.
 *
 * Attaching this to any DataObject will add four fields which contain all links to SiteTree and File items
 * referenced in any HTMLText fields, and two booleans to indicate if there are any broken links. Call
 * augmentSyncLinkTracking to update those fields with any changes to those fields.
 *
 * @property SiteTree owner
 *
 * @property bool HasBrokenFile
 * @property bool HasBrokenLink
 *
 * @method ManyManyList LinkTracking List of site pages linked on this page.
 * @method ManyManyList ImageTracking List of Images linked on this page.
 */
class SiteTreeLinkTracking extends DataExtension {

	public $parser;

	private static $dependencies = array(
		'parser' => '%$SiteTreeLinkTracking_Parser'
	);

	private static $db = array(
		"HasBrokenFile" => "Boolean",
		"HasBrokenLink" => "Boolean"
	);

	private static $many_many = array(
		"LinkTracking" => "SiteTree",
		"ImageTracking" => "File"
	);

	private static $many_many_extraFields = array(
		"LinkTracking" => array("FieldName" => "Varchar"),
		"ImageTracking" => array("FieldName" => "Varchar")
	);

	/**
	 * Scrape the content of a field to detect anly links to local SiteTree pages or files
	 *
	 * @param string $fieldName The name of the field on {@link @owner} to scrape
	 */
	public function trackLinksInField($fieldName) {
		$record = $this->owner;

		$linkedPages = array();
		$linkedFiles = array();

		$htmlValue = Injector::inst()->create('HTMLValue', $record->$fieldName);
		$links = $this->parser->process($htmlValue);

		// Highlight broken links in the content.
		foreach ($links as $link) {
			$classStr = trim($link['DOMReference']->getAttribute('class'));
			if (!$classStr) {
				$classes = array();
			} else {
				$classes = explode(' ', $classStr);
			}

			// Add or remove the broken class from the link, depending on the link status.
			if ($link['Broken']) {
				$classes = array_unique(array_merge($classes, array('ss-broken')));
			} else {
				$classes = array_diff($classes, array('ss-broken'));
			}

			if (!empty($classes)) {
				$link['DOMReference']->setAttribute('class', implode(' ', $classes));
			} else {
				$link['DOMReference']->removeAttribute('class');
			}
		}
		$record->$fieldName = $htmlValue->getContent();

		// Populate link tracking for internal links & links to asset files.
		foreach ($links as $link) {
			switch ($link['Type']) {
				case 'sitetree':
					if ($link['Broken']) {
						$record->HasBrokenLink = true;
<?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.");
        }
    }

}
					} else {
						$linkedPages[] = $link['Target'];
					}
					break;

				case 'file':
					if ($link['Broken']) {
						$record->HasBrokenFile = true;
<?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.");
        }
    }

}
					} else {
						$linkedFiles[] = $link['Target'];
					}
					break;

				default:
					if ($link['Broken']) {
						$record->HasBrokenLink = true;
<?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.");
        }
    }

}
					}
					break;
			}
		}

		// Add file tracking for image references
		if($images = $htmlValue->getElementsByTagName('img')) foreach($images as $img) {
			if($image = File::find($path = urldecode(Director::makeRelative($img->getAttribute('src'))))) {
				$linkedFiles[] = $image->ID;
			} else {
				if(substr($path, 0, strlen(ASSETS_DIR) + 1) == ASSETS_DIR . '/') {
					$record->HasBrokenFile = true;
<?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.");
        }
    }

}
				}
			}
		}

		// Update the "LinkTracking" many_many
		if($record->ID && $record->manyManyComponent('LinkTracking') && $tracker = $record->LinkTracking()) {

			$tracker->removeByFilter(sprintf(
				'"FieldName" = \'%s\' AND "%s" = %d',
				$fieldName,
				$tracker->getForeignKey(),
				$record->ID
			));

			if($linkedPages) foreach($linkedPages as $item) {

				$tracker->add($item, array('FieldName' => $fieldName));
			}
		}

		// Update the "ImageTracking" many_many
		if($record->ID && $record->manyManyComponent('ImageTracking') && $tracker = $record->ImageTracking()) {
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 { }
			$tracker->removeByFilter(sprintf(
				'"FieldName" = \'%s\' AND "%s" = %d',
				$fieldName,
				$tracker->getForeignKey(),
				$record->ID
			));

			if($linkedFiles) foreach($linkedFiles as $item) {

				$tracker->add($item, array('FieldName' => $fieldName));
			}
		}
	}

	/**
	 * Find HTMLText fields on {@link owner} to scrape for links that need tracking
	 */
	public function augmentSyncLinkTracking() {
		// Reset boolean broken flags
		$this->owner->HasBrokenLink = false;
<?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.");
        }
    }

}
		$this->owner->HasBrokenFile = false;
<?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.");
        }
    }

}

		// Build a list of HTMLText fields
		$allFields = $this->owner->db();
		$htmlFields = array();
		foreach($allFields as $field => $fieldSpec) {
			if(preg_match('/([^(]+)/', $fieldSpec, $matches)) {
				$class = $matches[0];
				if(class_exists($class)){
					if($class == 'HTMLText' || is_subclass_of($class, 'HTMLText')) $htmlFields[] = $field;
				}
			}
		}

		foreach($htmlFields as $field) $this->trackLinksInField($field);
	}
}

/**
 * A helper object for extracting information about links.
 */
class SiteTreeLinkTracking_Parser {

	/**
	 * Finds the links that are of interest for the link tracking automation. Checks for brokenness and attaches
	 * extracted metadata so consumers can decide what to do with the DOM element (provided as DOMReference).
	 *
	 * @param SS_HTMLValue $htmlValue Object to parse the links from.
	 * @return array Associative array containing found links with the following field layout:
	 *		Type: string, name of the link type
	 *		Target: any, a reference to the target object, depends on the Type
	 *		Anchor: string, anchor part of the link
	 *		DOMReference: DOMElement, reference to the link to apply changes.
	 *		Broken: boolean, a flag highlighting whether the link should be treated as broken.
	 */
	public function process(SS_HTMLValue $htmlValue) {
		$results = array();

		$links = $htmlValue->getElementsByTagName('a');
		if(!$links) return $results;

		foreach($links as $link) {
			if (!$link->hasAttribute('href')) continue;

			$href = Director::makeRelative($link->getAttribute('href'));

			// Definitely broken links.
			if($href == '' || $href[0] == '/') {
				$results[] = array(
					'Type' => 'broken',
					'Target' => null,
					'Anchor' => null,
					'DOMReference' => $link,
					'Broken' => true
				);

				continue;
			}

			// Link to a page on this site.
			$matches = array();
			if(preg_match('/\[sitetree_link(?:\s*|%20|,)?id=([0-9]+)\](#(.*))?/i', $href, $matches)) {
				$page = DataObject::get_by_id('SiteTree', $matches[1]);
				$broken = false;

				if (!$page) {
					// Page doesn't exist.
					$broken = true;
				} else if (!empty($matches[3])) {
					$anchor = preg_quote($matches[3], '/');

					if (!preg_match("/(name|id)=\"{$anchor}\"/", $page->Content)) {
						// Broken anchor on the target page.
						$broken = true;
					}
				}

				$results[] = array(
					'Type' => 'sitetree',
					'Target' => $matches[1],
					'Anchor' => empty($matches[3]) ? null : $matches[3],
					'DOMReference' => $link,
					'Broken' => $broken
				);

				continue;
			}

			// Link to a file on this site.
			$matches = array();
			if(preg_match('/\[file_link(?:\s*|%20|,)?id=([0-9]+)\]/i', $href, $matches)) {

				$results[] = array(
					'Type' => 'file',
					'Target' => $matches[1],
					'Anchor' => null,
					'DOMReference' => $link,
					'Broken' => !DataObject::get_by_id('File', $matches[1])
				);

				continue;
			}

			// Local anchor.
			$matches = array();
			if(preg_match('/^#(.*)/i', $href, $matches)) {

				$results[] = array(
					'Type' => 'localanchor',
					'Target' => null,
					'Anchor' => $matches[1],
					'DOMReference' => $link,
					'Broken' => !preg_match("#(name|id)=\"{$matches[1]}\"#", $htmlValue->getContent())
				);

				continue;
			}

		}

		return $results;
	}

}


1		<?php
2
3		/**
4		* @package cms
5		* @subpackage model
6		*/
7
8		/**
9		* Adds tracking of links in any HTMLText fields which reference SiteTree or File items.
10		*
11		* Attaching this to any DataObject will add four fields which contain all links to SiteTree and File items
12		* referenced in any HTMLText fields, and two booleans to indicate if there are any broken links. Call
13		* augmentSyncLinkTracking to update those fields with any changes to those fields.
14		*
15		* @property SiteTree owner
16		*
17		* @property bool HasBrokenFile
18		* @property bool HasBrokenLink
19		*
20		* @method ManyManyList LinkTracking List of site pages linked on this page.
21		* @method ManyManyList ImageTracking List of Images linked on this page.
22		*/
23		class SiteTreeLinkTracking extends DataExtension {
24
25		public $parser;
26
27		private static $dependencies = array(
28		'parser' => '%$SiteTreeLinkTracking_Parser'
29		);
30
31		private static $db = array(
32		"HasBrokenFile" => "Boolean",
33		"HasBrokenLink" => "Boolean"
34		);
35
36		private static $many_many = array(
37		"LinkTracking" => "SiteTree",
38		"ImageTracking" => "File"
39		);
40
41		private static $many_many_extraFields = array(
42		"LinkTracking" => array("FieldName" => "Varchar"),
43		"ImageTracking" => array("FieldName" => "Varchar")
44		);
45
46		/**
47		* Scrape the content of a field to detect anly links to local SiteTree pages or files
48		*
49		* @param string $fieldName The name of the field on {@link @owner} to scrape
50		*/
51		public function trackLinksInField($fieldName) {
52		$record = $this->owner;
53
54		$linkedPages = array();
55		$linkedFiles = array();
56
57		$htmlValue = Injector::inst()->create('HTMLValue', $record->$fieldName);
58		$links = $this->parser->process($htmlValue);
59
60		// Highlight broken links in the content.
61		foreach ($links as $link) {
62		$classStr = trim($link['DOMReference']->getAttribute('class'));
63		if (!$classStr) {
64		$classes = array();
65		} else {
66		$classes = explode(' ', $classStr);
67		}
68
69		// Add or remove the broken class from the link, depending on the link status.
70		if ($link['Broken']) {
71		$classes = array_unique(array_merge($classes, array('ss-broken')));
72		} else {
73		$classes = array_diff($classes, array('ss-broken'));
74		}
75
76		if (!empty($classes)) {
77		$link['DOMReference']->setAttribute('class', implode(' ', $classes));
78		} else {
79		$link['DOMReference']->removeAttribute('class');
80		}
81		}
82		$record->$fieldName = $htmlValue->getContent();
83
84		// Populate link tracking for internal links & links to asset files.
85		foreach ($links as $link) {
86		switch ($link['Type']) {
87		case 'sitetree':
88		if ($link['Broken']) {
89		$record->HasBrokenLink = true;
		0 ignored issues – show Documentation introduced 2015-11-26 02:50 UTC by Report Bug Copy Issue Report The property `HasBrokenLink` does not exist on `object<SiteTree>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write 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."); } } } Since the property has write access only, you can use the @property-write 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...
90		} else {
91		$linkedPages[] = $link['Target'];
92		}
93		break;
94
95		case 'file':
96		if ($link['Broken']) {
97		$record->HasBrokenFile = true;
		0 ignored issues – show Documentation introduced 2015-11-26 02:50 UTC by Report Bug Copy Issue Report The property `HasBrokenFile` does not exist on `object<SiteTree>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write 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."); } } } Since the property has write access only, you can use the @property-write 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...
98		} else {
99		$linkedFiles[] = $link['Target'];
100		}
101		break;
102
103		default:
104		if ($link['Broken']) {
105		$record->HasBrokenLink = true;
		0 ignored issues – show Documentation introduced 2015-11-26 02:50 UTC by Report Bug Copy Issue Report The property `HasBrokenLink` does not exist on `object<SiteTree>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write 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."); } } } Since the property has write access only, you can use the @property-write 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...
106		}
107		break;
108		}
109		}
110
111		// Add file tracking for image references
112		if($images = $htmlValue->getElementsByTagName('img')) foreach($images as $img) {
113		if($image = File::find($path = urldecode(Director::makeRelative($img->getAttribute('src'))))) {
114		$linkedFiles[] = $image->ID;
115		} else {
116		if(substr($path, 0, strlen(ASSETS_DIR) + 1) == ASSETS_DIR . '/') {
117		$record->HasBrokenFile = true;
		0 ignored issues – show Documentation introduced 2015-11-26 02:50 UTC by Report Bug Copy Issue Report The property `HasBrokenFile` does not exist on `object<SiteTree>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write 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."); } } } Since the property has write access only, you can use the @property-write 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		}
119		}
120		}
121
122		// Update the "LinkTracking" many_many
123	View Code Duplication	if($record->ID && $record->manyManyComponent('LinkTracking') && $tracker = $record->LinkTracking()) {
		0 ignored issues – show Bug introduced 2015-12-07 04:49 UTC by Report Bug Copy Issue Report The method `LinkTracking()` does not exist on `SiteTree`. Did you maybe mean `syncLinkTracking()`? 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... Duplication introduced 2015-12-07 04:49 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
124		$tracker->removeByFilter(sprintf(
125		'"FieldName" = \'%s\' AND "%s" = %d',
126		$fieldName,
127		$tracker->getForeignKey(),
128		$record->ID
129		));
130
131		if($linkedPages) foreach($linkedPages as $item) {
		0 ignored issues – show Bug Best Practice introduced 2015-11-26 02:50 UTC by Report Bug Copy Issue Report The expression `$linkedPages` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
132		$tracker->add($item, array('FieldName' => $fieldName));
133		}
134		}
135
136		// Update the "ImageTracking" many_many
137	View Code Duplication	if($record->ID && $record->manyManyComponent('ImageTracking') && $tracker = $record->ImageTracking()) {
		0 ignored issues – show Documentation Bug introduced 2015-12-07 04:49 UTC by Report Bug Copy Issue Report The method `ImageTracking` does not exist on `object<SiteTree>`? 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... Duplication introduced 2015-12-07 04:49 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
138		$tracker->removeByFilter(sprintf(
139		'"FieldName" = \'%s\' AND "%s" = %d',
140		$fieldName,
141		$tracker->getForeignKey(),
142		$record->ID
143		));
144
145		if($linkedFiles) foreach($linkedFiles as $item) {
		0 ignored issues – show Bug Best Practice introduced 2015-11-26 02:50 UTC by Report Bug Copy Issue Report The expression `$linkedFiles` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
146		$tracker->add($item, array('FieldName' => $fieldName));
147		}
148		}
149		}
150
151		/**
152		* Find HTMLText fields on {@link owner} to scrape for links that need tracking
153		*/
154		public function augmentSyncLinkTracking() {
155		// Reset boolean broken flags
156		$this->owner->HasBrokenLink = false;
		0 ignored issues – show Documentation introduced 2015-11-26 02:50 UTC by Report Bug Copy Issue Report The property `HasBrokenLink` does not exist on `object<SiteTree>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write 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."); } } } Since the property has write access only, you can use the @property-write 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...
157		$this->owner->HasBrokenFile = false;
		0 ignored issues – show Documentation introduced 2015-11-26 02:50 UTC by Report Bug Copy Issue Report The property `HasBrokenFile` does not exist on `object<SiteTree>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write 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."); } } } Since the property has write access only, you can use the @property-write 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...
158
159		// Build a list of HTMLText fields
160		$allFields = $this->owner->db();
161		$htmlFields = array();
162		foreach($allFields as $field => $fieldSpec) {
163		if(preg_match('/([^(]+)/', $fieldSpec, $matches)) {
164		$class = $matches[0];
165		if(class_exists($class)){
166		if($class == 'HTMLText' \|\| is_subclass_of($class, 'HTMLText')) $htmlFields[] = $field;
167		}
168		}
169		}
170
171		foreach($htmlFields as $field) $this->trackLinksInField($field);
172		}
173		}
174
175		/**
176		* A helper object for extracting information about links.
177		*/
178		class SiteTreeLinkTracking_Parser {
179
180		/**
181		* Finds the links that are of interest for the link tracking automation. Checks for brokenness and attaches
182		* extracted metadata so consumers can decide what to do with the DOM element (provided as DOMReference).
183		*
184		* @param SS_HTMLValue $htmlValue Object to parse the links from.
185		* @return array Associative array containing found links with the following field layout:
186		* Type: string, name of the link type
187		* Target: any, a reference to the target object, depends on the Type
188		* Anchor: string, anchor part of the link
189		* DOMReference: DOMElement, reference to the link to apply changes.
190		* Broken: boolean, a flag highlighting whether the link should be treated as broken.
191		*/
192		public function process(SS_HTMLValue $htmlValue) {
193		$results = array();
194
195		$links = $htmlValue->getElementsByTagName('a');
196		if(!$links) return $results;
197
198		foreach($links as $link) {
199		if (!$link->hasAttribute('href')) continue;
200
201		$href = Director::makeRelative($link->getAttribute('href'));
202
203		// Definitely broken links.
204		if($href == '' \|\| $href[0] == '/') {
205		$results[] = array(
206		'Type' => 'broken',
207		'Target' => null,
208		'Anchor' => null,
209		'DOMReference' => $link,
210		'Broken' => true
211		);
212
213		continue;
214		}
215
216		// Link to a page on this site.
217		$matches = array();
218		if(preg_match('/\[sitetree_link(?:\s\|%20\|,)?id=([0-9]+)\](#(.))?/i', $href, $matches)) {
219		$page = DataObject::get_by_id('SiteTree', $matches[1]);
220		$broken = false;
221
222		if (!$page) {
223		// Page doesn't exist.
224		$broken = true;
225		} else if (!empty($matches[3])) {
226		$anchor = preg_quote($matches[3], '/');
227
228		if (!preg_match("/(name\|id)=\"{$anchor}\"/", $page->Content)) {
229		// Broken anchor on the target page.
230		$broken = true;
231		}
232		}
233
234		$results[] = array(
235		'Type' => 'sitetree',
236		'Target' => $matches[1],
237		'Anchor' => empty($matches[3]) ? null : $matches[3],
238		'DOMReference' => $link,
239		'Broken' => $broken
240		);
241
242		continue;
243		}
244
245		// Link to a file on this site.
246		$matches = array();
247	View Code Duplication	if(preg_match('/\[file_link(?:\s*\|%20\|,)?id=([0-9]+)\]/i', $href, $matches)) {
		0 ignored issues – show Duplication introduced 2015-11-26 02:50 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
248		$results[] = array(
249		'Type' => 'file',
250		'Target' => $matches[1],
251		'Anchor' => null,
252		'DOMReference' => $link,
253		'Broken' => !DataObject::get_by_id('File', $matches[1])
254		);
255
256		continue;
257		}
258
259		// Local anchor.
260		$matches = array();
261	View Code Duplication	if(preg_match('/^#(.*)/i', $href, $matches)) {
		0 ignored issues – show Duplication introduced 2015-11-26 02:50 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
262		$results[] = array(
263		'Type' => 'localanchor',
264		'Target' => null,
265		'Anchor' => $matches[1],
266		'DOMReference' => $link,
267		'Broken' => !preg_match("#(name\|id)=\"{$matches[1]}\"#", $htmlValue->getContent())
268		);
269
270		continue;
271		}
272
273		}
274
275		return $results;
276		}
277
278		}
279

silverstripe / silverstripe-cms

Pull Request — 3.2 (#1360)

SiteTreeLinkTracking_Parser::process() D

Complexity

Size

Duplication

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like