UsingRuntimeTable::saveRuntimeConfig() - Code Metrics - Inspection of "New: complete overhaul of RuntimeTable module; lot..." - datasift/storyplayer - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 0eaa4a...267174 )

by Stuart

created 2016-01-02 13:59 UTC

UsingRuntimeTable::saveRuntimeConfig() A

↳ Parent: UsingRuntimeTable

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
dl	0
loc	7
c	1
b	0
f	0
rs	9.4286
cc	1
eloc	3
nc	1
nop	1

<?php

/**
 * Copyright (c) 2013-present Mediasift Ltd
 * Copyright (c) 2016-present Ganbaro Digital Ltd
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in
 *     the documentation and/or other materials provided with the
 *     distribution.
 *
 *   * Neither the names of the copyright holders nor the names of his
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * @author    Michael Heap <[email protected]>
 * @author    Stuart Herbert <[email protected]>
 * @copyright 2013-present Mediasift Ltd www.datasift.com
 * @copyright 2016-present Ganbaro Digital Ltd www.ganbarodigital.com
 * @license   http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @link      http://datasift.github.io/storyplayer
 */

namespace StoryplayerInternals\SPv2\Modules\RuntimeTable;

use DataSift\Stone\ObjectLib\BaseObject;
use Storyplayer\SPv2\Modules\Exceptions;
use Storyplayer\SPv2\Modules\Log;
use StoryplayerInternals\SPv2\Modules\RuntimeTable;

class UsingRuntimeTable extends BaseRuntimeTable
{
    /**
     * addItem
     *
     * Add an item to a module's runtime config table
     *
     * @param string $key
     *        The key to save data under
     * @param mixed $value
     *        The value to save
     *
     * @return void
     */
    public function addItem($key, $value)

    {
        // get our table name from the constructor
        $tableName = $this->args[0];

        $log = Log::usingLog()->startAction("add item '{$key}' to {$tableName} table");

        // get the table
        $table = RuntimeTable::fromRuntimeTable($tableName)->getTable();

        // make sure we don't have a duplicate entry
        if (isset($table->$key)){
            $msg = "table already contains item '{$key}'";
            $log->endAction($msg);
            throw Exceptions::newActionFailedException(__METHOD__, $msg);
        }

        // add the entry
        $table->$key = $value;

        // save the updated runtime config
        $this->saveRuntimeConfig($log);

        // all done
        $log->endAction();
    }

    /**
     * removeItem
     *
     * Removes an item from the runtimeConfig file
     *
     * @param string $key
     *        The key that we want to remove
     *
     * @return void
     */
    public function removeItem($key)
    {
        // get our table name from the constructor
        $tableName = $this->args[0];

        // what are we doing?
        $log = Log::usingLog()->startAction("remove item '{$key}' from {$tableName} table");

        // get the table
        $table = RuntimeTable::fromRuntimeTable($tableName)->getTableIfExists();

        // does the table exist?
        if (!$table) {
            $msg = "table does not exist. '{$key}' not removed";
            $log->endAction($msg);
            return;
        }

        // make sure we have an entry to remove
        if (!isset($table->$key)) {
            $msg = "table does not contain item '{$key}'";
            $log->endAction($msg);
            return;
        }

        // remove the entry
        unset($table->$key);

        // remove the table if it's empty
        RuntimeTable::usingRuntimeTables()->removeTableIfEmpty($tableName);

        // save our changes
        $this->saveRuntimeConfig($log);

        // all done
        $log->endAction();
    }

    /**
     * updateItem
     *
     * Replace an item in the runtimeConfig file. If the item does not exist,
     * we will create it.
     *
     * @param string $key
     *        The key that we want to update
     * @param mixed $value
     *        The new value for $key
     *
     * @return void
     */
    public function updateItem($key, $value)
    {
        // get our table name from the constructor
        $tableName = $this->args[0];

        // what are we doing?
        $log = Log::usingLog()->startAction("update entry '{$key}' in {$tableName} table");

        // get the table config
        $table = RuntimeTable::fromRuntimeTable($tableName)->getTable();

        // update the entry
        $table->$key = $value;

        // save the changes
        $this->saveRuntimeConfig($log);

        // all done
        $log->endAction();

    }

    /**
     * Add an item to a module's runtime config table
     *
     * @param string $key
     *        The key to save data under
     * @param string $value
     *        The value to save
     *
     * @return void
     */
    public function addItemToGroup($group, $key, $value)
    {
        // get our table name from the constructor
        $tableName = $this->args[0];

        $log = Log::usingLog()->startAction("add entry '{$group}->{$key}' to {$tableName} table");

        // get the table config
        $table = RuntimeTable::fromRuntimeTable($tableName)->getTable();

        // make sure the group exists
        if (!isset($tables->$tableName->$group)) {

            $tables->$tableName->$group = new BaseObject;

        }

        // make sure we don't have a duplicate entry
        if (isset($tables->$tableName->$group->$key)){

            $msg = "table already contains an entry for '{$group}->{$key}'";
            $log->endAction($msg);
            throw Exceptions::newActionFailedException(__METHOD__, $msg);
        }

        // add the entry
        $table->$group->$key = $value;

        // make sure that the table's group is always available for
        // template expansion
        //
        // NOTE: any code that adds groups to tables by hand does NOT
        //       get this guarantee
        $activeConfig = $this->st->getActiveConfig();
        $activeConfig->setData($tableName, $tables->$tableName);


        // save the updated runtime config
        $this->saveRuntimeConfig($log);

        // all done
        $log->endAction();
    }

    /**
     * Removes an item from a group in the table
     *
     * @param string $key
     *        The key that we want to remove
     *
     * @return void
     */
    public function removeItemFromGroup($group, $key)
    {
        // get our table name from the constructor
        $tableName = $this->args[0];

        // what are we doing?
        $log = Log::usingLog()->startAction("remove item '{$key}' from group '{$group}' in {$tableName} table");

        // get the table config
        $table = RuntimeTable::fromRuntimeTable($tableName)->getTableIfExists();

        // does the group exist?
        if (!isset($table->$group)) {

            $msg = "table has no group '{$group}'. '{$group}->{$key}' not removed";
            $log->endAction($msg);
            return;
        }

        // does the group contain the item?
        if (!isset($table->$group->$key)) {
            $msg = "table does not contain item '{$item}' in group '{$group}'";

            $log->endAction($msg);
            return;
        }

        // remove the entry
        unset($table->$group->$key);

        // remove the table if it is now empty
        RuntimeTable::usingRuntimeTables()->removeTableIfEmpty($tableName);

        // save the changes
        $this->saveRuntimeConfig($log);

        // all done
        $log->endAction();
    }

    /**
     * removeTable
     *
     * deletes the entire table
     *
     * @return void
     */
    public function removeTable()
    {
        // get our table name from the constructor
        $tableName = $this->args[0];

        // what are we doing?
        $log = Log::usingLog()->startAction("remove the {$tableName} table from the runtime config");

        // there's a module to do this
        RuntimeTable::usingRuntimeTables()->removeTable($tableName);

        // save the changes
        $this->saveRuntimeConfig($log);

        // all done
        $log->endAction();
    }

    /**
     * save the updated runtime config to disk
     *
     * @param  object $log
     *         the currently active logger
     * @return void
     */
    protected function saveRuntimeConfig($log)
    {
        // save the updated runtime config
        $log->addStep("saving runtime config to disk", function() {
            $this->st->saveRuntimeConfig();
        });
    }
}


1		<?php
2
3		/**
4		* Copyright (c) 2013-present Mediasift Ltd
5		* Copyright (c) 2016-present Ganbaro Digital Ltd
6		* All rights reserved.
7		*
8		* Redistribution and use in source and binary forms, with or without
9		* modification, are permitted provided that the following conditions
10		* are met:
11		*
12		* * Redistributions of source code must retain the above copyright
13		* notice, this list of conditions and the following disclaimer.
14		*
15		* * Redistributions in binary form must reproduce the above copyright
16		* notice, this list of conditions and the following disclaimer in
17		* the documentation and/or other materials provided with the
18		* distribution.
19		*
20		* * Neither the names of the copyright holders nor the names of his
21		* contributors may be used to endorse or promote products derived
22		* from this software without specific prior written permission.
23		*
24		* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25		* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26		* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
27		* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
28		* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
29		* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
30		* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
31		* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
32		* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33		* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
34		* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35		* POSSIBILITY OF SUCH DAMAGE.
36		*
37		* @author Michael Heap <[email protected]>
38		* @author Stuart Herbert <[email protected]>
39		* @copyright 2013-present Mediasift Ltd www.datasift.com
40		* @copyright 2016-present Ganbaro Digital Ltd www.ganbarodigital.com
41		* @license http://www.opensource.org/licenses/bsd-license.php BSD License
42		* @link http://datasift.github.io/storyplayer
43		*/
44
45		namespace StoryplayerInternals\SPv2\Modules\RuntimeTable;
46
47		use DataSift\Stone\ObjectLib\BaseObject;
48		use Storyplayer\SPv2\Modules\Exceptions;
49		use Storyplayer\SPv2\Modules\Log;
50		use StoryplayerInternals\SPv2\Modules\RuntimeTable;
51
52		class UsingRuntimeTable extends BaseRuntimeTable
53		{
54		/**
55		* addItem
56		*
57		* Add an item to a module's runtime config table
58		*
59		* @param string $key
60		* The key to save data under
61		* @param mixed $value
62		* The value to save
63		*
64		* @return void
65		*/
66	View Code Duplication	public function addItem($key, $value)
		1 ignored issue – show Duplication introduced 2016-01-02 14:04 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
67		{
68		// get our table name from the constructor
69		$tableName = $this->args[0];
70
71		$log = Log::usingLog()->startAction("add item '{$key}' to {$tableName} table");
72
73		// get the table
74		$table = RuntimeTable::fromRuntimeTable($tableName)->getTable();
75
76		// make sure we don't have a duplicate entry
77		if (isset($table->$key)){
78		$msg = "table already contains item '{$key}'";
79		$log->endAction($msg);
80		throw Exceptions::newActionFailedException(__METHOD__, $msg);
81		}
82
83		// add the entry
84		$table->$key = $value;
85
86		// save the updated runtime config
87		$this->saveRuntimeConfig($log);
88
89		// all done
90		$log->endAction();
91		}
92
93		/**
94		* removeItem
95		*
96		* Removes an item from the runtimeConfig file
97		*
98		* @param string $key
99		* The key that we want to remove
100		*
101		* @return void
102		*/
103		public function removeItem($key)
104		{
105		// get our table name from the constructor
106		$tableName = $this->args[0];
107
108		// what are we doing?
109		$log = Log::usingLog()->startAction("remove item '{$key}' from {$tableName} table");
110
111		// get the table
112		$table = RuntimeTable::fromRuntimeTable($tableName)->getTableIfExists();
113
114		// does the table exist?
115		if (!$table) {
116		$msg = "table does not exist. '{$key}' not removed";
117		$log->endAction($msg);
118		return;
119		}
120
121		// make sure we have an entry to remove
122		if (!isset($table->$key)) {
123		$msg = "table does not contain item '{$key}'";
124		$log->endAction($msg);
125		return;
126		}
127
128		// remove the entry
129		unset($table->$key);
130
131		// remove the table if it's empty
132		RuntimeTable::usingRuntimeTables()->removeTableIfEmpty($tableName);
133
134		// save our changes
135		$this->saveRuntimeConfig($log);
136
137		// all done
138		$log->endAction();
139		}
140
141		/**
142		* updateItem
143		*
144		* Replace an item in the runtimeConfig file. If the item does not exist,
145		* we will create it.
146		*
147		* @param string $key
148		* The key that we want to update
149		* @param mixed $value
150		* The new value for $key
151		*
152		* @return void
153		*/
154		public function updateItem($key, $value)
155		{
156		// get our table name from the constructor
157		$tableName = $this->args[0];
158
159		// what are we doing?
160		$log = Log::usingLog()->startAction("update entry '{$key}' in {$tableName} table");
161
162		// get the table config
163		$table = RuntimeTable::fromRuntimeTable($tableName)->getTable();
164
165		// update the entry
166		$table->$key = $value;
167
168		// save the changes
169		$this->saveRuntimeConfig($log);
170
171		// all done
172		$log->endAction();
173
174		}
175
176		/**
177		* Add an item to a module's runtime config table
178		*
179		* @param string $key
180		* The key to save data under
181		* @param string $value
182		* The value to save
183		*
184		* @return void
185		*/
186		public function addItemToGroup($group, $key, $value)
187		{
188		// get our table name from the constructor
189		$tableName = $this->args[0];
190
191		$log = Log::usingLog()->startAction("add entry '{$group}->{$key}' to {$tableName} table");
192
193		// get the table config
194		$table = RuntimeTable::fromRuntimeTable($tableName)->getTable();
195
196		// make sure the group exists
197		if (!isset($tables->$tableName->$group)) {
		0 ignored issues – show Bug introduced 2016-01-02 14:04 UTC by Report Bug Copy Issue Report The variable `$tables` does not exist. Did you mean `$table`? This check looks for variables that are accessed but have not been defined. It raises an issue if it finds another variable that has a similar name. The variable may have been renamed without also renaming all references. Loading history...
198		$tables->$tableName->$group = new BaseObject;
		0 ignored issues – show Bug introduced 2016-01-02 14:04 UTC by Report Bug Copy Issue Report The variable `$tables` does not exist. Did you mean `$table`? This check looks for variables that are accessed but have not been defined. It raises an issue if it finds another variable that has a similar name. The variable may have been renamed without also renaming all references. Loading history...
199		}
200
201		// make sure we don't have a duplicate entry
202		if (isset($tables->$tableName->$group->$key)){
		0 ignored issues – show Bug introduced 2016-01-02 14:04 UTC by Report Bug Copy Issue Report The variable `$tables` does not exist. Did you mean `$table`? This check looks for variables that are accessed but have not been defined. It raises an issue if it finds another variable that has a similar name. The variable may have been renamed without also renaming all references. Loading history...
203		$msg = "table already contains an entry for '{$group}->{$key}'";
204		$log->endAction($msg);
205		throw Exceptions::newActionFailedException(__METHOD__, $msg);
206		}
207
208		// add the entry
209		$table->$group->$key = $value;
210
211		// make sure that the table's group is always available for
212		// template expansion
213		//
214		// NOTE: any code that adds groups to tables by hand does NOT
215		// get this guarantee
216		$activeConfig = $this->st->getActiveConfig();
217		$activeConfig->setData($tableName, $tables->$tableName);
		0 ignored issues – show Bug introduced 2016-01-02 14:04 UTC by Report Bug Copy Issue Report The variable `$tables` does not exist. Did you mean `$table`? This check looks for variables that are accessed but have not been defined. It raises an issue if it finds another variable that has a similar name. The variable may have been renamed without also renaming all references. Loading history...
218
219		// save the updated runtime config
220		$this->saveRuntimeConfig($log);
221
222		// all done
223		$log->endAction();
224		}
225
226		/**
227		* Removes an item from a group in the table
228		*
229		* @param string $key
230		* The key that we want to remove
231		*
232		* @return void
233		*/
234		public function removeItemFromGroup($group, $key)
235		{
236		// get our table name from the constructor
237		$tableName = $this->args[0];
238
239		// what are we doing?
240		$log = Log::usingLog()->startAction("remove item '{$key}' from group '{$group}' in {$tableName} table");
241
242		// get the table config
243		$table = RuntimeTable::fromRuntimeTable($tableName)->getTableIfExists();
244
245		// does the group exist?
246	View Code Duplication	if (!isset($table->$group)) {
		1 ignored issue – show Duplication introduced 2015-12-20 13:56 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
247		$msg = "table has no group '{$group}'. '{$group}->{$key}' not removed";
248		$log->endAction($msg);
249		return;
250		}
251
252		// does the group contain the item?
253	View Code Duplication	if (!isset($table->$group->$key)) {
254		$msg = "table does not contain item '{$item}' in group '{$group}'";
		0 ignored issues – show Bug introduced 2016-01-02 14:04 UTC by Report Bug Copy Issue Report The variable `$item` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
255		$log->endAction($msg);
256		return;
257		}
258
259		// remove the entry
260		unset($table->$group->$key);
261
262		// remove the table if it is now empty
263		RuntimeTable::usingRuntimeTables()->removeTableIfEmpty($tableName);
264
265		// save the changes
266		$this->saveRuntimeConfig($log);
267
268		// all done
269		$log->endAction();
270		}
271
272		/**
273		* removeTable
274		*
275		* deletes the entire table
276		*
277		* @return void
278		*/
279		public function removeTable()
280		{
281		// get our table name from the constructor
282		$tableName = $this->args[0];
283
284		// what are we doing?
285		$log = Log::usingLog()->startAction("remove the {$tableName} table from the runtime config");
286
287		// there's a module to do this
288		RuntimeTable::usingRuntimeTables()->removeTable($tableName);
289
290		// save the changes
291		$this->saveRuntimeConfig($log);
292
293		// all done
294		$log->endAction();
295		}
296
297		/**
298		* save the updated runtime config to disk
299		*
300		* @param object $log
301		* the currently active logger
302		* @return void
303		*/
304		protected function saveRuntimeConfig($log)
305		{
306		// save the updated runtime config
307		$log->addStep("saving runtime config to disk", function() {
308		$this->st->saveRuntimeConfig();
309		});
310		}
311		}
312

datasift / storyplayer

GitHub Access Token became invalid

Push — develop ( 0eaa4a...267174 )

UsingRuntimeTable::saveRuntimeConfig() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like