SugarCacheFile::_getExternal() - Code Metrics - adamjakab/SuiteCRM - Measure and Improve Code Quality continuously with Scrutinizer

SugarCacheFile::_getExternal() A
last analyzed 2016-05-10 08:39 UTC

↳ Parent: SugarCacheFile

Complexity

Conditions	3
Paths	4

Size

Total Lines	13
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Metric	Value
cc	3
eloc	7
nc	4
nop	1
dl	0
loc	13
ccs	0
cts	10
cp	0
crap	12
rs	9.4285

<?php
/*********************************************************************************
 * SugarCRM Community Edition is a customer relationship management program developed by
 * SugarCRM, Inc. Copyright (C) 2004-2013 SugarCRM Inc.

 * SuiteCRM is an extension to SugarCRM Community Edition developed by Salesagility Ltd.
 * Copyright (C) 2011 - 2014 Salesagility Ltd.
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License version 3 as published by the
 * Free Software Foundation with the addition of the following permission added
 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
 * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
 * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
 *
 * 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 Affero General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Affero General Public License along with
 * this program; if not, see http://www.gnu.org/licenses or write to the Free
 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301 USA.
 *
 * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
 * SW2-130, Cupertino, CA 95014, USA. or at email address [email protected].
 *
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License version 3.
 *
 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
 * these Appropriate Legal Notices must retain the display of the "Powered by
 * SugarCRM" logo and "Supercharged by SuiteCRM" logo. If the display of the logos is not
 * reasonably feasible for  technical reasons, the Appropriate Legal Notices must
 * display the words  "Powered by SugarCRM" and "Supercharged by SuiteCRM".
 ********************************************************************************/


require_once('include/SugarCache/SugarCacheAbstract.php');

class SugarCacheFile extends SugarCacheAbstract
{
    /**
     * @var path and file which will store the cache used for this backend
     */
    protected $_cacheFileName = 'externalCache.php';

    /**
     * @var bool true if the cache has changed and needs written to disk
     */
    protected $_cacheChanged = false;

    /**
     * @see SugarCacheAbstract::$_priority
     */
    protected $_priority = 990;

    /**
     * @see SugarCacheAbstract::useBackend()
     */
    public function useBackend()
    {
        if ( !parent::useBackend() )
            return false;

        if ( !empty($GLOBALS['sugar_config']['external_cache_enabled_file']) )
            return true;

        return false;
    }

    /**
     * @see SugarCacheAbstract::__construct()
     *
     * For this backend, we'll read from the SugarCacheFile::_cacheFileName file into
     * the SugarCacheFile::$localCache array.
     */
    public function __construct()
    {
        parent::__construct();

        if ( isset($GLOBALS['sugar_config']['external_cache_filename']) )
            $this->_cacheFileName = $GLOBALS['sugar_config']['external_cache_filename'];
    }

    /**
     * @see SugarCacheAbstract::__destruct()
     *
     * For this backend, we'll write the SugarCacheFile::$localCache array serialized out to a file
     */
    public function __destruct()
    {
        parent::__destruct();

        if ( $this->_cacheChanged )
            sugar_file_put_contents(sugar_cached($this->_cacheFileName), serialize($this->_localStore));
    }

    /**
	 * This is needed to prevent unserialize vulnerability
     */
    public function __wakeup()
    {
        // clean all properties
        foreach(get_object_vars($this) as $k => $v) {
            $this->$k = null;
        }
        throw new Exception("Not a serializable object");
    }

    /**
     * @see SugarCacheAbstract::_setExternal()
     *
     * Does nothing; we write to cache on destroy
     */
    protected function _setExternal(
        $key,
        $value
        )
    {
        $this->_cacheChanged = true;
    }

    /**
     * @see SugarCacheAbstract::_getExternal()
     */
    protected function _getExternal(
        $key
        )
    {
        // load up the external cache file
        if ( sugar_is_file($cachedfile = sugar_cached($this->_cacheFileName)))
            $this->localCache = unserialize(file_get_contents($cachedfile));
<?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.");
        }
    }

}

        if ( isset($this->_localStore[$key]) )
            return $this->_localStore[$key];

        return null;
    }

    /**
     * @see SugarCacheAbstract::_clearExternal()
     *
     * Does nothing; we write to cache on destroy
     */
    protected function _clearExternal(
        $key
        )
    {
        $this->_cacheChanged = true;
    }

    /**
     * @see SugarCacheAbstract::_resetExternal()
     *
     * Does nothing; we write to cache on destroy
     */
    protected function _resetExternal()
    {
        $this->_cacheChanged = true;
    }
}


1			<?php
2			/*********************************************************************************
3			* SugarCRM Community Edition is a customer relationship management program developed by
4			* SugarCRM, Inc. Copyright (C) 2004-2013 SugarCRM Inc.
5
6			* SuiteCRM is an extension to SugarCRM Community Edition developed by Salesagility Ltd.
7			* Copyright (C) 2011 - 2014 Salesagility Ltd.
8			*
9			* This program is free software; you can redistribute it and/or modify it under
10			* the terms of the GNU Affero General Public License version 3 as published by the
11			* Free Software Foundation with the addition of the following permission added
12			* to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
13			* IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
14			* OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
15			*
16			* This program is distributed in the hope that it will be useful, but WITHOUT
17			* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
18			* FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
19			* details.
20			*
21			* You should have received a copy of the GNU Affero General Public License along with
22			* this program; if not, see http://www.gnu.org/licenses or write to the Free
23			* Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
24			* 02110-1301 USA.
25			*
26			* You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
27			* SW2-130, Cupertino, CA 95014, USA. or at email address [email protected].
28			*
29			* The interactive user interfaces in modified source and object code versions
30			* of this program must display Appropriate Legal Notices, as required under
31			* Section 5 of the GNU Affero General Public License version 3.
32			*
33			* In accordance with Section 7(b) of the GNU Affero General Public License version 3,
34			* these Appropriate Legal Notices must retain the display of the "Powered by
35			* SugarCRM" logo and "Supercharged by SuiteCRM" logo. If the display of the logos is not
36			* reasonably feasible for technical reasons, the Appropriate Legal Notices must
37			* display the words "Powered by SugarCRM" and "Supercharged by SuiteCRM".
38			********************************************************************************/
39
40
41			require_once('include/SugarCache/SugarCacheAbstract.php');
42
43			class SugarCacheFile extends SugarCacheAbstract
44			{
45			/**
46			* @var path and file which will store the cache used for this backend
47			*/
48			protected $_cacheFileName = 'externalCache.php';
49
50			/**
51			* @var bool true if the cache has changed and needs written to disk
52			*/
53			protected $_cacheChanged = false;
54
55			/**
56			* @see SugarCacheAbstract::$_priority
57			*/
58			protected $_priority = 990;
59
60			/**
61			* @see SugarCacheAbstract::useBackend()
62			*/
63			public function useBackend()
64			{
65			if ( !parent::useBackend() )
66			return false;
67
68			if ( !empty($GLOBALS['sugar_config']['external_cache_enabled_file']) )
69			return true;
70
71			return false;
72			}
73
74			/**
75			* @see SugarCacheAbstract::__construct()
76			*
77			* For this backend, we'll read from the SugarCacheFile::_cacheFileName file into
78			* the SugarCacheFile::$localCache array.
79			*/
80			public function __construct()
81			{
82			parent::__construct();
83
84			if ( isset($GLOBALS['sugar_config']['external_cache_filename']) )
85			$this->_cacheFileName = $GLOBALS['sugar_config']['external_cache_filename'];
86			}
87
88			/**
89			* @see SugarCacheAbstract::__destruct()
90			*
91			* For this backend, we'll write the SugarCacheFile::$localCache array serialized out to a file
92			*/
93			public function __destruct()
94			{
95			parent::__destruct();
96
97			if ( $this->_cacheChanged )
98			sugar_file_put_contents(sugar_cached($this->_cacheFileName), serialize($this->_localStore));
99			}
100
101			/**
102			* This is needed to prevent unserialize vulnerability
103			*/
104			public function __wakeup()
105			{
106			// clean all properties
107			foreach(get_object_vars($this) as $k => $v) {
108			$this->$k = null;
109			}
110			throw new Exception("Not a serializable object");
111			}
112
113			/**
114			* @see SugarCacheAbstract::_setExternal()
115			*
116			* Does nothing; we write to cache on destroy
117			*/
118			protected function _setExternal(
119			$key,
120			$value
121			)
122			{
123			$this->_cacheChanged = true;
124			}
125
126			/**
127			* @see SugarCacheAbstract::_getExternal()
128			*/
129			protected function _getExternal(
130			$key
131			)
132			{
133			// load up the external cache file
134			if ( sugar_is_file($cachedfile = sugar_cached($this->_cacheFileName)))
135			$this->localCache = unserialize(file_get_contents($cachedfile));
			0 ignored issues – show Documentation introduced 2016-03-07 17:58 UTC by Report Bug Copy Issue Report The property `localCache` does not exist on `object<SugarCacheFile>`. 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...
136
137			if ( isset($this->_localStore[$key]) )
138			return $this->_localStore[$key];
139
140			return null;
141			}
142
143			/**
144			* @see SugarCacheAbstract::_clearExternal()
145			*
146			* Does nothing; we write to cache on destroy
147			*/
148			protected function _clearExternal(
149			$key
150			)
151			{
152			$this->_cacheChanged = true;
153			}
154
155			/**
156			* @see SugarCacheAbstract::_resetExternal()
157			*
158			* Does nothing; we write to cache on destroy
159			*/
160			protected function _resetExternal()
161			{
162			$this->_cacheChanged = true;
163			}
164			}
165

adamjakab / SuiteCRM

SugarCacheFile::_getExternal() A last analyzed 2016-05-10 08:39 UTC

Complexity

Size

Duplication

Code Coverage

Duplication Side-by-Side

Filter issues like

SugarCacheFile::_getExternal() A
last analyzed 2016-05-10 08:39 UTC