BackendUtility::BEenableFields() - Code Metrics - Inspection of "Release 3.0.0 - <https://github.com/fabarea/vidi/c..." - fabarea/vidi - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 7f2d14...7fc8f2 )

by Fabien

created 2019-01-28 08:46 UTC

BackendUtility::BEenableFields() B

↳ Parent: BackendUtility

Complexity

Conditions	8
Paths	30

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	50
rs	7.8464
c	0
b	0
f	0
cc	8
nc	30
nop	2

<?php
namespace Fab\Vidi\Utility;

/*
 * This file is part of the Fab/Vidi project under GPLv2 or later.
 *
 * For the full copyright and license information, please read the
 * LICENSE.md file that was distributed with this source code.
 */

use Psr\Log\LoggerInterface;
use TYPO3\CMS\Backend\Backend\Shortcut\ShortcutRepository;
use TYPO3\CMS\Backend\Routing\UriBuilder;
use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use TYPO3\CMS\Core\Cache\CacheManager;
use TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
use TYPO3\CMS\Core\Core\Environment;
use TYPO3\CMS\Core\Database\Connection;
use TYPO3\CMS\Core\Database\ConnectionPool;
use TYPO3\CMS\Core\Database\Query\QueryBuilder;
use TYPO3\CMS\Core\Database\Query\QueryHelper;
use TYPO3\CMS\Core\Database\Query\Restriction\BackendWorkspaceRestriction;
use TYPO3\CMS\Core\Database\Query\Restriction\DeletedRestriction;
use TYPO3\CMS\Core\Database\Query\Restriction\HiddenRestriction;
use TYPO3\CMS\Core\Database\RelationHandler;
use TYPO3\CMS\Core\Exception\SiteNotFoundException;
use TYPO3\CMS\Core\Http\ServerRequest;
use TYPO3\CMS\Core\Imaging\Icon;
use TYPO3\CMS\Core\Imaging\IconFactory;
use TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariantCollection;
use TYPO3\CMS\Core\Localization\LanguageService;
use TYPO3\CMS\Core\Log\LogManager;
use TYPO3\CMS\Core\Resource\AbstractFile;
use TYPO3\CMS\Core\Resource\Exception\ResourceDoesNotExistException;
use TYPO3\CMS\Core\Resource\File;
use TYPO3\CMS\Core\Resource\ProcessedFile;
use TYPO3\CMS\Core\Resource\ResourceFactory;
use TYPO3\CMS\Core\Routing\InvalidRouteArgumentsException;
use TYPO3\CMS\Core\Routing\RouterInterface;
use TYPO3\CMS\Core\Routing\SiteMatcher;
use TYPO3\CMS\Core\Site\Entity\PseudoSite;
use TYPO3\CMS\Core\Site\Entity\Site;
use TYPO3\CMS\Core\Site\SiteFinder;
use TYPO3\CMS\Core\Type\Bitmask\Permission;
use TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser;
use TYPO3\CMS\Core\Utility\ArrayUtility;
use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\Utility\HttpUtility;
use TYPO3\CMS\Core\Utility\MathUtility;
use TYPO3\CMS\Core\Utility\PathUtility;
use TYPO3\CMS\Core\Versioning\VersionState;
use TYPO3\CMS\Frontend\Compatibility\LegacyDomainResolver;
use TYPO3\CMS\Frontend\Page\PageRepository;

/**
 * Standard functions available for the TYPO3 backend.
 * You are encouraged to use this class in your own applications (Backend Modules)
 * Don't instantiate - call functions with "\TYPO3\CMS\Backend\Utility\BackendUtility::" prefixed the function name.
 */
class BackendUtility
{

    /*******************************************
     *
     * SQL-related, selecting records, searching
     *
     *******************************************/
    /**
     * Returns the WHERE clause " AND NOT [tablename].[deleted-field]" if a deleted-field
     * is configured in $GLOBALS['TCA'] for the tablename, $table
     * This function should ALWAYS be called in the backend for selection on tables which
     * are configured in $GLOBALS['TCA'] since it will ensure consistent selection of records,
     * even if they are marked deleted (in which case the system must always treat them as non-existent!)
     * In the frontend a function, ->enableFields(), is known to filter hidden-field, start- and endtime
     * and fe_groups as well. But that is a job of the frontend, not the backend. If you need filtering
     * on those fields as well in the backend you can use ->BEenableFields() though.
     *
     * @param string $table Table name present in $GLOBALS['TCA']
     * @param string $tableAlias Table alias if any
     * @return string WHERE clause for filtering out deleted records, eg " AND tablename.deleted=0
     */
    public static function deleteClause($table, $tableAlias = '')
    {
        if (empty($GLOBALS['TCA'][$table]['ctrl']['delete'])) {
            return '';
        }
        $expressionBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
            ->getQueryBuilderForTable($table)
            ->expr();
        return ' AND ' . $expressionBuilder->eq(
                ($tableAlias ?: $table) . '.' . $GLOBALS['TCA'][$table]['ctrl']['delete'],
                0
            );
    }
    /**
     * Backend implementation of enableFields()
     * Notice that "fe_groups" is not selected for - only disabled, starttime and endtime.
     * Notice that deleted-fields are NOT filtered - you must ALSO call deleteClause in addition.
     * $GLOBALS["SIM_ACCESS_TIME"] is used for date.
     *
     * @param string $table The table from which to return enableFields WHERE clause. Table name must have a 'ctrl' section in $GLOBALS['TCA'].
     * @param bool $inv Means that the query will select all records NOT VISIBLE records (inverted selection)
     * @return string WHERE clause part
     */
    public static function BEenableFields($table, $inv = false)
    {
        $ctrl = $GLOBALS['TCA'][$table]['ctrl'];
        $expressionBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
            ->getConnectionForTable($table)
            ->getExpressionBuilder();
        $query = $expressionBuilder->andX();
        $invQuery = $expressionBuilder->orX();

        if (is_array($ctrl)) {
            if (is_array($ctrl['enablecolumns'])) {
                if ($ctrl['enablecolumns']['disabled'] ?? false) {
                    $field = $table . '.' . $ctrl['enablecolumns']['disabled'];
                    $query->add($expressionBuilder->eq($field, 0));
                    $invQuery->add($expressionBuilder->neq($field, 0));
                }
                if ($ctrl['enablecolumns']['starttime'] ?? false) {
                    $field = $table . '.' . $ctrl['enablecolumns']['starttime'];
                    $query->add($expressionBuilder->lte($field, (int)$GLOBALS['SIM_ACCESS_TIME']));
                    $invQuery->add(
                        $expressionBuilder->andX(
                            $expressionBuilder->neq($field, 0),
                            $expressionBuilder->gt($field, (int)$GLOBALS['SIM_ACCESS_TIME'])
                        )
                    );
                }
                if ($ctrl['enablecolumns']['endtime'] ?? false) {
                    $field = $table . '.' . $ctrl['enablecolumns']['endtime'];
                    $query->add(
                        $expressionBuilder->orX(
                            $expressionBuilder->eq($field, 0),
                            $expressionBuilder->gt($field, (int)$GLOBALS['SIM_ACCESS_TIME'])
                        )
                    );
                    $invQuery->add(
                        $expressionBuilder->andX(
                            $expressionBuilder->neq($field, 0),
                            $expressionBuilder->lte($field, (int)$GLOBALS['SIM_ACCESS_TIME'])
                        )
                    );
                }
            }
        }

        if ($query->count() === 0) {
            return '';
        }

        return ' AND ' . ($inv ? $invQuery : $query);
    }

    /**
     * Returns the URL to a given module
     *
     * @param string $moduleName Name of the module
     * @param array $urlParameters URL parameters that should be added as key value pairs
     * @return string Calculated URL
     */
    public static function getModuleUrl($moduleName, $urlParameters = [])
    {
        $uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);
        try {
            $uri = $uriBuilder->buildUriFromRoute($moduleName, $urlParameters);
        } catch (\TYPO3\CMS\Backend\Routing\Exception\RouteNotFoundException $e) {

            $uri = $uriBuilder->buildUriFromRoutePath($moduleName, $urlParameters);
        }
        return (string)$uri;
    }

}


1			<?php
2			namespace Fab\Vidi\Utility;
3
4			/*
5			* This file is part of the Fab/Vidi project under GPLv2 or later.
6			*
7			* For the full copyright and license information, please read the
8			* LICENSE.md file that was distributed with this source code.
9			*/
10
11			use Psr\Log\LoggerInterface;
12			use TYPO3\CMS\Backend\Backend\Shortcut\ShortcutRepository;
13			use TYPO3\CMS\Backend\Routing\UriBuilder;
14			use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
15			use TYPO3\CMS\Core\Cache\CacheManager;
16			use TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
17			use TYPO3\CMS\Core\Core\Environment;
18			use TYPO3\CMS\Core\Database\Connection;
19			use TYPO3\CMS\Core\Database\ConnectionPool;
20			use TYPO3\CMS\Core\Database\Query\QueryBuilder;
21			use TYPO3\CMS\Core\Database\Query\QueryHelper;
22			use TYPO3\CMS\Core\Database\Query\Restriction\BackendWorkspaceRestriction;
23			use TYPO3\CMS\Core\Database\Query\Restriction\DeletedRestriction;
24			use TYPO3\CMS\Core\Database\Query\Restriction\HiddenRestriction;
25			use TYPO3\CMS\Core\Database\RelationHandler;
26			use TYPO3\CMS\Core\Exception\SiteNotFoundException;
27			use TYPO3\CMS\Core\Http\ServerRequest;
28			use TYPO3\CMS\Core\Imaging\Icon;
29			use TYPO3\CMS\Core\Imaging\IconFactory;
30			use TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariantCollection;
31			use TYPO3\CMS\Core\Localization\LanguageService;
32			use TYPO3\CMS\Core\Log\LogManager;
33			use TYPO3\CMS\Core\Resource\AbstractFile;
34			use TYPO3\CMS\Core\Resource\Exception\ResourceDoesNotExistException;
35			use TYPO3\CMS\Core\Resource\File;
36			use TYPO3\CMS\Core\Resource\ProcessedFile;
37			use TYPO3\CMS\Core\Resource\ResourceFactory;
38			use TYPO3\CMS\Core\Routing\InvalidRouteArgumentsException;
39			use TYPO3\CMS\Core\Routing\RouterInterface;
40			use TYPO3\CMS\Core\Routing\SiteMatcher;
41			use TYPO3\CMS\Core\Site\Entity\PseudoSite;
42			use TYPO3\CMS\Core\Site\Entity\Site;
43			use TYPO3\CMS\Core\Site\SiteFinder;
44			use TYPO3\CMS\Core\Type\Bitmask\Permission;
45			use TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser;
46			use TYPO3\CMS\Core\Utility\ArrayUtility;
47			use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
			0 ignored issues – show Bug introduced 2019-01-28 08:49 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `Fab\Vidi\Utility\ExtensionManagementUtility`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
48			use TYPO3\CMS\Core\Utility\GeneralUtility;
49			use TYPO3\CMS\Core\Utility\HttpUtility;
50			use TYPO3\CMS\Core\Utility\MathUtility;
51			use TYPO3\CMS\Core\Utility\PathUtility;
52			use TYPO3\CMS\Core\Versioning\VersionState;
53			use TYPO3\CMS\Frontend\Compatibility\LegacyDomainResolver;
54			use TYPO3\CMS\Frontend\Page\PageRepository;
55
56			/**
57			* Standard functions available for the TYPO3 backend.
58			* You are encouraged to use this class in your own applications (Backend Modules)
59			* Don't instantiate - call functions with "\TYPO3\CMS\Backend\Utility\BackendUtility::" prefixed the function name.
60			*/
61			class BackendUtility
62			{
63
64			/*******************************************
65			*
66			* SQL-related, selecting records, searching
67			*
68			*******************************************/
69			/**
70			* Returns the WHERE clause " AND NOT [tablename].[deleted-field]" if a deleted-field
71			* is configured in $GLOBALS['TCA'] for the tablename, $table
72			* This function should ALWAYS be called in the backend for selection on tables which
73			* are configured in $GLOBALS['TCA'] since it will ensure consistent selection of records,
74			* even if they are marked deleted (in which case the system must always treat them as non-existent!)
75			* In the frontend a function, ->enableFields(), is known to filter hidden-field, start- and endtime
76			* and fe_groups as well. But that is a job of the frontend, not the backend. If you need filtering
77			* on those fields as well in the backend you can use ->BEenableFields() though.
78			*
79			* @param string $table Table name present in $GLOBALS['TCA']
80			* @param string $tableAlias Table alias if any
81			* @return string WHERE clause for filtering out deleted records, eg " AND tablename.deleted=0
82			*/
83			public static function deleteClause($table, $tableAlias = '')
84			{
85			if (empty($GLOBALS['TCA'][$table]['ctrl']['delete'])) {
86			return '';
87			}
88			$expressionBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
89			->getQueryBuilderForTable($table)
90			->expr();
91			return ' AND ' . $expressionBuilder->eq(
92			($tableAlias ?: $table) . '.' . $GLOBALS['TCA'][$table]['ctrl']['delete'],
93			0
94			);
95			}
96			/**
97			* Backend implementation of enableFields()
98			* Notice that "fe_groups" is not selected for - only disabled, starttime and endtime.
99			* Notice that deleted-fields are NOT filtered - you must ALSO call deleteClause in addition.
100			* $GLOBALS["SIM_ACCESS_TIME"] is used for date.
101			*
102			* @param string $table The table from which to return enableFields WHERE clause. Table name must have a 'ctrl' section in $GLOBALS['TCA'].
103			* @param bool $inv Means that the query will select all records NOT VISIBLE records (inverted selection)
104			* @return string WHERE clause part
105			*/
106			public static function BEenableFields($table, $inv = false)
107			{
108			$ctrl = $GLOBALS['TCA'][$table]['ctrl'];
109			$expressionBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
110			->getConnectionForTable($table)
111			->getExpressionBuilder();
112			$query = $expressionBuilder->andX();
113			$invQuery = $expressionBuilder->orX();
114
115			if (is_array($ctrl)) {
116			if (is_array($ctrl['enablecolumns'])) {
117			if ($ctrl['enablecolumns']['disabled'] ?? false) {
118			$field = $table . '.' . $ctrl['enablecolumns']['disabled'];
119			$query->add($expressionBuilder->eq($field, 0));
120			$invQuery->add($expressionBuilder->neq($field, 0));
121			}
122			if ($ctrl['enablecolumns']['starttime'] ?? false) {
123			$field = $table . '.' . $ctrl['enablecolumns']['starttime'];
124			$query->add($expressionBuilder->lte($field, (int)$GLOBALS['SIM_ACCESS_TIME']));
125			$invQuery->add(
126			$expressionBuilder->andX(
127			$expressionBuilder->neq($field, 0),
128			$expressionBuilder->gt($field, (int)$GLOBALS['SIM_ACCESS_TIME'])
129			)
130			);
131			}
132			if ($ctrl['enablecolumns']['endtime'] ?? false) {
133			$field = $table . '.' . $ctrl['enablecolumns']['endtime'];
134			$query->add(
135			$expressionBuilder->orX(
136			$expressionBuilder->eq($field, 0),
137			$expressionBuilder->gt($field, (int)$GLOBALS['SIM_ACCESS_TIME'])
138			)
139			);
140			$invQuery->add(
141			$expressionBuilder->andX(
142			$expressionBuilder->neq($field, 0),
143			$expressionBuilder->lte($field, (int)$GLOBALS['SIM_ACCESS_TIME'])
144			)
145			);
146			}
147			}
148			}
149
150			if ($query->count() === 0) {
151			return '';
152			}
153
154			return ' AND ' . ($inv ? $invQuery : $query);
155			}
156
157			/**
158			* Returns the URL to a given module
159			*
160			* @param string $moduleName Name of the module
161			* @param array $urlParameters URL parameters that should be added as key value pairs
162			* @return string Calculated URL
163			*/
164			public static function getModuleUrl($moduleName, $urlParameters = [])
165			{
166			$uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);
167			try {
168			$uri = $uriBuilder->buildUriFromRoute($moduleName, $urlParameters);
169			} catch (\TYPO3\CMS\Backend\Routing\Exception\RouteNotFoundException $e) {
			0 ignored issues – show Bug introduced 2019-01-28 08:49 UTC by Report Bug Copy Issue Report The class `TYPO3\CMS\Backend\Routin...\RouteNotFoundException` does not exist. Did you forget a USE statement, or did you not list all dependencies? Scrutinizer analyzes your `composer.json`/`composer.lock` file if available to determine the classes, and functions that are defined by your dependencies. It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis. Loading history...
170			$uri = $uriBuilder->buildUriFromRoutePath($moduleName, $urlParameters);
171			}
172			return (string)$uri;
173			}
174
175			}
176

fabarea / vidi

Push — master ( 7f2d14...7fc8f2 )

BackendUtility::BEenableFields() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like