PageElement::getElementDescription() - Code Metrics - AOEpeople/languagevisibility - Measure and Improve Code Quality continuously with Scrutinizer

PageElement::getElementDescription() A
last analyzed 2017-07-20 07:06 UTC

↳ Parent: PageElement

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php

namespace AOE\Languagevisibility;

/***************************************************************
 * Copyright notice
 *
 * (c) 2016 AOE GmbH <[email protected]>
 * All rights reserved
 *
 * This script is part of the TYPO3 project. The TYPO3 project is
 * free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * The GNU General Public License can be found at
 * http://www.gnu.org/copyleft/gpl.html.
 *
 * This script is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/

/**
 *
 * @author	Daniel Poetzinger <[email protected]>
 * @coauthor Tolleiv Nietsch <[email protected]>
 * @coauthor Timo Schmidt <[email protected]>
 */
class PageElement extends Element {

	/**
	 * Returns if this Element is a translation or not.
	 * Pages are always original records, because overlays are stored in the
	 * table pages_language_overlay
	 *
	 * @return boolean
	 */
	protected function isOrigElement() {
		return TRUE;
	}

	/**
	 * Returns a simple description of the element type.
	 *
	 * @return string
	 */
	public function getElementDescription() {
		return 'Page';
	}

	/**
	 * This method is used to determine if this element is an element
	 * in the default language. For pages this is always true, because
	 * the table pages does not contain translations.
	 *
	 * @return boolean
	 */
	public function isLanguageSetToDefault() {
		return TRUE;
	}

	/**
	 * Returns an Informative description of the element.
	 *
	 * @return string
	 */
	public function getInformativeDescription() {
		return 'this is a normal page element (translations are managed with seperate overlay records)';
	}

	/**
	 * Method to get an overlay of an element for a certain langugae
	 *
	 * @param int $lUid
	 * @internal param bool $onlyUid
	 * @return array return the database row
	 */
	protected function getOverLayRecordForCertainLanguageImplementation($lUid) {
		if ($lUid > 0) {
			$fieldArr = explode(',', $GLOBALS['TYPO3_CONF_VARS']['FE']['pageOverlayFields']);
			$page_id = $this->row['t3ver_oid']?$this->row['t3ver_oid']:$this->getUid();	// Was the whole record
			$fieldArr = array_intersect($fieldArr,array_keys($this->row));		// Make sure that only fields which exist in the incoming record are overlaid!

			if (count($fieldArr)) {
				$table = 'pages_language_overlay';
				if (is_object($GLOBALS['TSFE']->sys_page)) {
					$enableFields = $GLOBALS['TSFE']->sys_page->enableFields($table);
				} else {
					$enableFields = \TYPO3\CMS\Backend\Utility\BackendUtility::deleteClause($table);
				}
				$fieldArr[] = 'deleted';
				$fieldArr[] = 'hidden';
				$fieldArr[] = 'tx_languagevisibility_visibility';

					// Selecting overlay record:
				$res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
					implode(',', $fieldArr),
					'pages_language_overlay',
					'pid=' . intval($page_id) . '
						AND sys_language_uid=' . intval($lUid) .
						$enableFields,
					'',
					'',
					'1'
				);
				$olrow = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);
				$olrow = $this->getContextIndependentWorkspaceOverlay($table, $olrow);
				$GLOBALS['TYPO3_DB']->sql_free_result($res);

				if ($this->getEnableFieldResult($olrow)) {
					$overlayRecord = $olrow;
				}
			} else {
				$overlayRecord =  $this->row;
			}
		} else {
			$overlayRecord =  $this->row;
		}
		return $overlayRecord;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

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

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

	/**
	 * Returns which field in the language should be used to read the default visibility
	 *
	 * @return string (blank=default / page=page)
	 */
	public function getFieldToUseForDefaultVisibility() {
		return 'page';
	}

	/**
	 * Method to determine if this element has any translations in any workspace.
	 *
	 * @return boolean
	 */
	public function hasOverLayRecordForAnyLanguageInAnyWorkspace() {
		//if we handle a workspace record, we need to get it's live version
		if ($this->row['pid'] == -1) {
			$useUid = $this->row['t3ver_oid'];
		} else {
			$useUid = $this->row['uid'];
		}

			// if a workspace record has an overlay, an overlay also exists in the livews with versionstate = 1
			// therefore we have to look for any undeleted overlays of the live version
		$fields = 'count(uid) as anz';
		$table = 'pages_language_overlay';
		$where = 'deleted = 0 AND pid=' . $useUid;

		$rows = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows($fields, $table, $where);
		$anz = $rows[0]['anz'];

		return ($anz > 0);
	}

	/**
	 * The page elements supports inheritance.
	 *
	 * @param void
	 * @return boolean
	 */
	public function supportsInheritance() {
		return TRUE;
	}
}


1			<?php
2
3			namespace AOE\Languagevisibility;
4
5			/***************************************************************
6			* Copyright notice
7			*
8			* (c) 2016 AOE GmbH <[email protected]>
9			* All rights reserved
10			*
11			* This script is part of the TYPO3 project. The TYPO3 project is
12			* free software; you can redistribute it and/or modify
13			* it under the terms of the GNU General Public License as published by
14			* the Free Software Foundation; either version 2 of the License, or
15			* (at your option) any later version.
16			*
17			* The GNU General Public License can be found at
18			* http://www.gnu.org/copyleft/gpl.html.
19			*
20			* This script is distributed in the hope that it will be useful,
21			* but WITHOUT ANY WARRANTY; without even the implied warranty of
22			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23			* GNU General Public License for more details.
24			*
25			* This copyright notice MUST APPEAR in all copies of the script!
26			***************************************************************/
27
28			/**
29			*
30			* @author Daniel Poetzinger <[email protected]>
31			* @coauthor Tolleiv Nietsch <[email protected]>
32			* @coauthor Timo Schmidt <[email protected]>
33			*/
34			class PageElement extends Element {
35
36			/**
37			* Returns if this Element is a translation or not.
38			* Pages are always original records, because overlays are stored in the
39			* table pages_language_overlay
40			*
41			* @return boolean
42			*/
43			protected function isOrigElement() {
44			return TRUE;
45			}
46
47			/**
48			* Returns a simple description of the element type.
49			*
50			* @return string
51			*/
52			public function getElementDescription() {
53			return 'Page';
54			}
55
56			/**
57			* This method is used to determine if this element is an element
58			* in the default language. For pages this is always true, because
59			* the table pages does not contain translations.
60			*
61			* @return boolean
62			*/
63			public function isLanguageSetToDefault() {
64			return TRUE;
65			}
66
67			/**
68			* Returns an Informative description of the element.
69			*
70			* @return string
71			*/
72			public function getInformativeDescription() {
73			return 'this is a normal page element (translations are managed with seperate overlay records)';
74			}
75
76			/**
77			* Method to get an overlay of an element for a certain langugae
78			*
79			* @param int $lUid
80			* @internal param bool $onlyUid
81			* @return array return the database row
82			*/
83			protected function getOverLayRecordForCertainLanguageImplementation($lUid) {
84			if ($lUid > 0) {
85			$fieldArr = explode(',', $GLOBALS['TYPO3_CONF_VARS']['FE']['pageOverlayFields']);
86			$page_id = $this->row['t3ver_oid']?$this->row['t3ver_oid']:$this->getUid(); // Was the whole record
87			$fieldArr = array_intersect($fieldArr,array_keys($this->row)); // Make sure that only fields which exist in the incoming record are overlaid!
88
89			if (count($fieldArr)) {
90			$table = 'pages_language_overlay';
91			if (is_object($GLOBALS['TSFE']->sys_page)) {
92			$enableFields = $GLOBALS['TSFE']->sys_page->enableFields($table);
93			} else {
94			$enableFields = \TYPO3\CMS\Backend\Utility\BackendUtility::deleteClause($table);
95			}
96			$fieldArr[] = 'deleted';
97			$fieldArr[] = 'hidden';
98			$fieldArr[] = 'tx_languagevisibility_visibility';
99
100			// Selecting overlay record:
101			$res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
102			implode(',', $fieldArr),
103			'pages_language_overlay',
104			'pid=' . intval($page_id) . '
105			AND sys_language_uid=' . intval($lUid) .
106			$enableFields,
107			'',
108			'',
109			'1'
110			);
111			$olrow = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);
112			$olrow = $this->getContextIndependentWorkspaceOverlay($table, $olrow);
113			$GLOBALS['TYPO3_DB']->sql_free_result($res);
114
115			if ($this->getEnableFieldResult($olrow)) {
116			$overlayRecord = $olrow;
117			}
118			} else {
119			$overlayRecord = $this->row;
120			}
121			} else {
122			$overlayRecord = $this->row;
123			}
124			return $overlayRecord;
			0 ignored issues – show Bug introduced 2016-01-28 14:55 UTC by Report Bug Copy Issue Report The variable `$overlayRecord` 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...
125			}
126
127			/**
128			* Returns which field in the language should be used to read the default visibility
129			*
130			* @return string (blank=default / page=page)
131			*/
132			public function getFieldToUseForDefaultVisibility() {
133			return 'page';
134			}
135
136			/**
137			* Method to determine if this element has any translations in any workspace.
138			*
139			* @return boolean
140			*/
141			public function hasOverLayRecordForAnyLanguageInAnyWorkspace() {
142			//if we handle a workspace record, we need to get it's live version
143			if ($this->row['pid'] == -1) {
144			$useUid = $this->row['t3ver_oid'];
145			} else {
146			$useUid = $this->row['uid'];
147			}
148
149			// if a workspace record has an overlay, an overlay also exists in the livews with versionstate = 1
150			// therefore we have to look for any undeleted overlays of the live version
151			$fields = 'count(uid) as anz';
152			$table = 'pages_language_overlay';
153			$where = 'deleted = 0 AND pid=' . $useUid;
154
155			$rows = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows($fields, $table, $where);
156			$anz = $rows[0]['anz'];
157
158			return ($anz > 0);
159			}
160
161			/**
162			* The page elements supports inheritance.
163			*
164			* @param void
165			* @return boolean
166			*/
167			public function supportsInheritance() {
168			return TRUE;
169			}
170			}
171

AOEpeople / languagevisibility

PageElement::getElementDescription() A last analyzed 2017-07-20 07:06 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

PageElement::getElementDescription() A
last analyzed 2017-07-20 07:06 UTC