UserPage::remove() - Code Metrics - HaaseIT/HCSF - Measure and Improve Code Quality continuously with Scrutinizer

UserPage::remove() A
last analyzed 2019-11-13 08:51 UTC

↳ Parent: UserPage

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	14
rs	9.7998
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

/*
    HCSF - A multilingual CMS and Shopsystem
    Copyright (C) 2014  Marcus Haase - [email protected]

    This program 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 3 of the License, or
    (at your option) any later version.

    This program 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.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

namespace HaaseIT\HCSF;


use Zend\ServiceManager\ServiceManager;

/**
 * Class UserPage
 * @package HaaseIT\HCSF
 */
class UserPage extends Page
{
    /**
     * @var bool
     */
    protected $bReturnRaw;

    /**
     * @var int|string
     */
    public $cb_id;

    /**
     * @var string
     */
    public $cb_key;

    /**
     * @var int
     */
    public $cb_group;

    /**
     * @var bool
     */
    public $cb_html_from_file;

    /**
     * @var \HTMLPurifier
     */
    public $purifier;

    /**
     * @var \Doctrine\DBAL\Connection
     */
    protected $dbal;

    /**
     * UserPage constructor.
     * @param ServiceManager $serviceManager
     * @param $sPagekey
     * @param bool $bReturnRaw
     */
    public function __construct(ServiceManager $serviceManager, $sPagekey, $bReturnRaw = false)
    {
        //if (!$bReturnRaw) $this->container = $container;
        $this->serviceManager = $serviceManager;
        $this->status = 200;
        $this->bReturnRaw = $bReturnRaw;
        $this->dbal = $this->serviceManager->get('dbal');

        if ($sPagekey === '/_misc/index.html') {
            $this->cb_id = $sPagekey;
            $this->cb_key = $sPagekey;
            $this->cb_pagetype = 'itemoverview';
            $this->oPayload = $this->getPayload();
            $this->cb_pageconfig = (object) [];
        } else {
            // first get base data
            $querybuilder = $this->dbal->createQueryBuilder();
            $querybuilder
                ->select('cb_id, cb_key, cb_group, cb_pagetype, cb_pageconfig, cb_subnav, cb_html_from_file')
                ->from('content_base')
                ->where('cb_key = ?')
                ->setParameter(0, $sPagekey)
            ;
            $stmt = $querybuilder->execute();
            $stmt->setFetchMode(\PDO::FETCH_INTO, $this);

            if ($stmt->rowCount() === 1) {
                $stmt->fetch();

                if ($this->cb_pagetype !== 'shorturl') {
                    if (!$bReturnRaw) {
                        $this->cb_pageconfig = json_decode($this->cb_pageconfig);
                    }
                    $this->oPayload = $this->getPayload();
                }
            }
        }
    }

    /**
     * @return UserPagePayload
     */
    protected function getPayload()
    {
        return new UserPagePayload($this->serviceManager, $this->cb_id, $this->bReturnRaw, $this);
    }

    /**
     * @return bool
     */
    public function write()
    {
        $querybuilder = $this->dbal->createQueryBuilder();
        $querybuilder
            ->update('content_base')
            ->set('cb_pagetype', '?')
            ->set('cb_group', '?')
            ->set('cb_pageconfig', '?')
            ->set('cb_subnav', '?')
            ->set('cb_html_from_file', '?')
            ->where('cb_key = ?')
            ->setParameter(0, filter_var($this->cb_pagetype, FILTER_SANITIZE_STRING, FILTER_FLAG_STRIP_LOW))
            ->setParameter(1, filter_var($this->cb_group, FILTER_SANITIZE_STRING, FILTER_FLAG_STRIP_LOW))
            ->setParameter(2, $this->cb_pageconfig)
            ->setParameter(3, filter_var($this->cb_subnav, FILTER_SANITIZE_STRING, FILTER_FLAG_STRIP_LOW))
            ->setParameter(4, ($this->cb_html_from_file) ? 'Y' : 'N')
            ->setParameter(5, $this->cb_key)
        ;

        return $querybuilder->execute();
    }

    /**
     * @param string $sPagekeytoadd
     * @return mixed
     */
    public function insert($sPagekeytoadd)
    {
        $querybuilder = $this->dbal->createQueryBuilder();
        $querybuilder
            ->insert('content_base')
            ->setValue('cb_key', '?')
            ->setParameter(0, $sPagekeytoadd)
        ;

        return $querybuilder->execute();
    }

    /**
     * @return \Doctrine\DBAL\Driver\Statement|int
     */
    public function remove()
    {
        // delete children
        $this->oPayload->remove($this->cb_id);
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

        // then delete base row
        $queryBuilder = $this->dbal->createQueryBuilder();
        $queryBuilder
            ->delete('content_base')
            ->where('cb_id = '.$queryBuilder->createNamedParameter($this->cb_id))
        ;

        return $queryBuilder->execute();
    }
}


1			<?php
2
3			/*
4			HCSF - A multilingual CMS and Shopsystem
5			Copyright (C) 2014 Marcus Haase - [email protected]
6
7			This program is free software: you can redistribute it and/or modify
8			it under the terms of the GNU General Public License as published by
9			the Free Software Foundation, either version 3 of the License, or
10			(at your option) any later version.
11
12			This program is distributed in the hope that it will be useful,
13			but WITHOUT ANY WARRANTY; without even the implied warranty of
14			MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15			GNU General Public License for more details.
16
17			You should have received a copy of the GNU General Public License
18			along with this program. If not, see <http://www.gnu.org/licenses/>.
19			*/
20
21			namespace HaaseIT\HCSF;
22
23
24			use Zend\ServiceManager\ServiceManager;
25
26			/**
27			* Class UserPage
28			* @package HaaseIT\HCSF
29			*/
30			class UserPage extends Page
31			{
32			/**
33			* @var bool
34			*/
35			protected $bReturnRaw;
36
37			/**
38			* @var int\|string
39			*/
40			public $cb_id;
41
42			/**
43			* @var string
44			*/
45			public $cb_key;
46
47			/**
48			* @var int
49			*/
50			public $cb_group;
51
52			/**
53			* @var bool
54			*/
55			public $cb_html_from_file;
56
57			/**
58			* @var \HTMLPurifier
59			*/
60			public $purifier;
61
62			/**
63			* @var \Doctrine\DBAL\Connection
64			*/
65			protected $dbal;
66
67			/**
68			* UserPage constructor.
69			* @param ServiceManager $serviceManager
70			* @param $sPagekey
71			* @param bool $bReturnRaw
72			*/
73			public function __construct(ServiceManager $serviceManager, $sPagekey, $bReturnRaw = false)
74			{
75			//if (!$bReturnRaw) $this->container = $container;
76			$this->serviceManager = $serviceManager;
77			$this->status = 200;
78			$this->bReturnRaw = $bReturnRaw;
79			$this->dbal = $this->serviceManager->get('dbal');
80
81			if ($sPagekey === '/_misc/index.html') {
82			$this->cb_id = $sPagekey;
83			$this->cb_key = $sPagekey;
84			$this->cb_pagetype = 'itemoverview';
85			$this->oPayload = $this->getPayload();
86			$this->cb_pageconfig = (object) [];
87			} else {
88			// first get base data
89			$querybuilder = $this->dbal->createQueryBuilder();
90			$querybuilder
91			->select('cb_id, cb_key, cb_group, cb_pagetype, cb_pageconfig, cb_subnav, cb_html_from_file')
92			->from('content_base')
93			->where('cb_key = ?')
94			->setParameter(0, $sPagekey)
95			;
96			$stmt = $querybuilder->execute();
97			$stmt->setFetchMode(\PDO::FETCH_INTO, $this);
98
99			if ($stmt->rowCount() === 1) {
100			$stmt->fetch();
101
102			if ($this->cb_pagetype !== 'shorturl') {
103			if (!$bReturnRaw) {
104			$this->cb_pageconfig = json_decode($this->cb_pageconfig);
105			}
106			$this->oPayload = $this->getPayload();
107			}
108			}
109			}
110			}
111
112			/**
113			* @return UserPagePayload
114			*/
115			protected function getPayload()
116			{
117			return new UserPagePayload($this->serviceManager, $this->cb_id, $this->bReturnRaw, $this);
118			}
119
120			/**
121			* @return bool
122			*/
123			public function write()
124			{
125			$querybuilder = $this->dbal->createQueryBuilder();
126			$querybuilder
127			->update('content_base')
128			->set('cb_pagetype', '?')
129			->set('cb_group', '?')
130			->set('cb_pageconfig', '?')
131			->set('cb_subnav', '?')
132			->set('cb_html_from_file', '?')
133			->where('cb_key = ?')
134			->setParameter(0, filter_var($this->cb_pagetype, FILTER_SANITIZE_STRING, FILTER_FLAG_STRIP_LOW))
135			->setParameter(1, filter_var($this->cb_group, FILTER_SANITIZE_STRING, FILTER_FLAG_STRIP_LOW))
136			->setParameter(2, $this->cb_pageconfig)
137			->setParameter(3, filter_var($this->cb_subnav, FILTER_SANITIZE_STRING, FILTER_FLAG_STRIP_LOW))
138			->setParameter(4, ($this->cb_html_from_file) ? 'Y' : 'N')
139			->setParameter(5, $this->cb_key)
140			;
141
142			return $querybuilder->execute();
143			}
144
145			/**
146			* @param string $sPagekeytoadd
147			* @return mixed
148			*/
149			public function insert($sPagekeytoadd)
150			{
151			$querybuilder = $this->dbal->createQueryBuilder();
152			$querybuilder
153			->insert('content_base')
154			->setValue('cb_key', '?')
155			->setParameter(0, $sPagekeytoadd)
156			;
157
158			return $querybuilder->execute();
159			}
160
161			/**
162			* @return \Doctrine\DBAL\Driver\Statement\|int
163			*/
164			public function remove()
165			{
166			// delete children
167			$this->oPayload->remove($this->cb_id);
			0 ignored issues – show Bug introduced 2017-03-21 09:14 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `HaaseIT\HCSF\PagePayload` as the method `remove()` does only exist in the following sub-classes of `HaaseIT\HCSF\PagePayload`: `HaaseIT\HCSF\UserPagePayload`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
168
169			// then delete base row
170			$queryBuilder = $this->dbal->createQueryBuilder();
171			$queryBuilder
172			->delete('content_base')
173			->where('cb_id = '.$queryBuilder->createNamedParameter($this->cb_id))
174			;
175
176			return $queryBuilder->execute();
177			}
178			}
179

HaaseIT / HCSF

UserPage::remove() A last analyzed 2019-11-13 08:51 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

UserPage::remove() A
last analyzed 2019-11-13 08:51 UTC