SiteTreeFileExtension::onAfterVersionedPublish() - Code Metrics - Inspection of "TinyMCE image shortcodes" - silverstripe/silverstripe-cms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1423)

by Damian

created 2016-03-20 20:25 UTC

SiteTreeFileExtension::onAfterVersionedPublish() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	5
rs	9.4285
cc	1
eloc	2
nc	1
nop	0

<?php

/**
 * Extension applied to {@see File} object to track links to {@see SiteTree} records.
 *
 * {@see SiteTreeLinkTracking} for the extension applied to {@see SiteTree}
 *
 * Note that since both SiteTree and File are versioned, LinkTracking and ImageTracking will
 * only be enabled for the Stage record.
 *
 * @property File $owner
 *
 * @package cms
 * @subpackage model
 */
class SiteTreeFileExtension extends DataExtension {

	private static $belongs_many_many = array(
		'BackLinkTracking' => 'SiteTree.ImageTracking' // {@see SiteTreeLinkTracking}
	);

	/**
	 * Images tracked by pages are owned by those pages
	 *
	 * @config
	 * @var array
	 */
	private static $owned_by = array(
		'BackLinkTracking'
	);

	public function updateCMSFields(FieldList $fields) {
		$fields->insertAfter(
			ReadonlyField::create(
				'BackLinkCount',
				_t('AssetTableField.BACKLINKCOUNT', 'Used on:'),
				$this->BackLinkTracking()->Count() . ' ' . _t('AssetTableField.PAGES', 'page(s)')
			)
				->addExtraClass('cms-description-toggle')
				->setDescription($this->BackLinkHTMLList()),
			'LastEdited'
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		);
	}

	/**
	 * Generate an HTML list which provides links to where a file is used.
	 *
	 * @return string
	 */
	public function BackLinkHTMLList() {
		$html = '<em>' . _t(
			'SiteTreeFileExtension.BACKLINK_LIST_DESCRIPTION',
			'This list shows all pages where the file has been added through a WYSIWYG editor.'
		) . '</em>';

		$html .= '<ul>';
		foreach ($this->BackLinkTracking() as $backLink) {
			// Add the page link and CMS link
			$html .= sprintf(
				'<li><a href="%s" target="_blank">%s</a> &ndash; <a href="%s">%s</a></li>',
				Convert::raw2att($backLink->Link()),
				Convert::raw2xml($backLink->MenuTitle),
				Convert::raw2att($backLink->CMSEditLink()),
				_t('SiteTreeFileExtension.EDIT', 'Edit')
			);
		}
		$html .= '</ul>';

		return $html;
	}

	/**
	 * Extend through {@link updateBackLinkTracking()} in your own {@link Extension}.
	 *
	 * @return ManyManyList
	 */
	public function BackLinkTracking() {
		if(class_exists("Subsite")){
			$rememberSubsiteFilter = Subsite::$disable_subsite_filter;
			Subsite::disable_subsite_filter(true);
		}

		$links = $this->owner->getManyManyComponents('BackLinkTracking');
		$this->owner->extend('updateBackLinkTracking', $links);

		if(class_exists("Subsite")){
			Subsite::disable_subsite_filter($rememberSubsiteFilter);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
		}

		return $links;
	}

	/**
	 * @todo Unnecessary shortcut for AssetTableField, coupled with cms module.
	 *
	 * @return integer
	 */
	public function BackLinkTrackingCount() {
		$pages = $this->owner->BackLinkTracking();
		if($pages) {
			return $pages->Count();
		} else {
			return 0;
		}
	}

	/**
	 * Updates link tracking in the current stage.
	 */
	public function onAfterDelete() {
		// Skip live stage
		if(\Versioned::get_stage() === Versioned::LIVE) {

			return;
		}

		// We query the explicit ID list, because BackLinkTracking will get modified after the stage
		// site does its thing
		$brokenPageIDs = $this->owner->BackLinkTracking()->column("ID");
		if($brokenPageIDs) {
			// This will syncLinkTracking on the same stage as this file
			$brokenPages = DataObject::get('SiteTree')->byIDs($brokenPageIDs);
			foreach($brokenPages as $brokenPage) {
				$brokenPage->write();
			}
		}
	}
}


1			<?php
2
3			/**
4			* Extension applied to {@see File} object to track links to {@see SiteTree} records.
5			*
6			* {@see SiteTreeLinkTracking} for the extension applied to {@see SiteTree}
7			*
8			* Note that since both SiteTree and File are versioned, LinkTracking and ImageTracking will
9			* only be enabled for the Stage record.
10			*
11			* @property File $owner
12			*
13			* @package cms
14			* @subpackage model
15			*/
16			class SiteTreeFileExtension extends DataExtension {
17
18			private static $belongs_many_many = array(
19			'BackLinkTracking' => 'SiteTree.ImageTracking' // {@see SiteTreeLinkTracking}
20			);
21
22			/**
23			* Images tracked by pages are owned by those pages
24			*
25			* @config
26			* @var array
27			*/
28			private static $owned_by = array(
29			'BackLinkTracking'
30			);
31
32			public function updateCMSFields(FieldList $fields) {
33			$fields->insertAfter(
34			ReadonlyField::create(
35			'BackLinkCount',
36			_t('AssetTableField.BACKLINKCOUNT', 'Used on:'),
37			$this->BackLinkTracking()->Count() . ' ' . _t('AssetTableField.PAGES', 'page(s)')
38			)
39			->addExtraClass('cms-description-toggle')
40			->setDescription($this->BackLinkHTMLList()),
41			'LastEdited'
			0 ignored issues – show Documentation introduced 2015-11-26 02:50 UTC by Report Bug Copy Issue Report `'LastEdited'` is of type `string`, but the function expects a `object<FormField>`. 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...
42			);
43			}
44
45			/**
46			* Generate an HTML list which provides links to where a file is used.
47			*
48			* @return string
49			*/
50			public function BackLinkHTMLList() {
51			$html = '<em>' . _t(
52			'SiteTreeFileExtension.BACKLINK_LIST_DESCRIPTION',
53			'This list shows all pages where the file has been added through a WYSIWYG editor.'
54			) . '</em>';
55
56			$html .= '<ul>';
57			foreach ($this->BackLinkTracking() as $backLink) {
58			// Add the page link and CMS link
59			$html .= sprintf(
60			'<li><a href="%s" target="_blank">%s</a> – <a href="%s">%s</a></li>',
61			Convert::raw2att($backLink->Link()),
62			Convert::raw2xml($backLink->MenuTitle),
63			Convert::raw2att($backLink->CMSEditLink()),
64			_t('SiteTreeFileExtension.EDIT', 'Edit')
65			);
66			}
67			$html .= '</ul>';
68
69			return $html;
70			}
71
72			/**
73			* Extend through {@link updateBackLinkTracking()} in your own {@link Extension}.
74			*
75			* @return ManyManyList
76			*/
77			public function BackLinkTracking() {
78			if(class_exists("Subsite")){
79			$rememberSubsiteFilter = Subsite::$disable_subsite_filter;
80			Subsite::disable_subsite_filter(true);
81			}
82
83			$links = $this->owner->getManyManyComponents('BackLinkTracking');
84			$this->owner->extend('updateBackLinkTracking', $links);
85
86			if(class_exists("Subsite")){
87			Subsite::disable_subsite_filter($rememberSubsiteFilter);
			0 ignored issues – show Bug introduced 2015-11-26 02:50 UTC by Report Bug Copy Issue Report The variable `$rememberSubsiteFilter` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
88			}
89
90			return $links;
91			}
92
93			/**
94			* @todo Unnecessary shortcut for AssetTableField, coupled with cms module.
95			*
96			* @return integer
97			*/
98			public function BackLinkTrackingCount() {
99			$pages = $this->owner->BackLinkTracking();
100			if($pages) {
101			return $pages->Count();
102			} else {
103			return 0;
104			}
105			}
106
107			/**
108			* Updates link tracking in the current stage.
109			*/
110			public function onAfterDelete() {
111			// Skip live stage
112			if(\Versioned::get_stage() === Versioned::LIVE) {
			0 ignored issues – show Bug introduced 2016-03-08 06:22 UTC by Report Bug Copy Issue Report The method `get_stage()` does not seem to exist on `object<Versioned>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
113			return;
114			}
115
116			// We query the explicit ID list, because BackLinkTracking will get modified after the stage
117			// site does its thing
118			$brokenPageIDs = $this->owner->BackLinkTracking()->column("ID");
119			if($brokenPageIDs) {
120			// This will syncLinkTracking on the same stage as this file
121			$brokenPages = DataObject::get('SiteTree')->byIDs($brokenPageIDs);
122			foreach($brokenPages as $brokenPage) {
123			$brokenPage->write();
124			}
125			}
126			}
127			}
128

silverstripe / silverstripe-cms

Pull Request — master (#1423)

SiteTreeFileExtension::onAfterVersionedPublish() A

Complexity

Size

Duplication

Available Fixes

Duplication Side-by-Side

Filter issues like