Sidebar

Complexity

Total Complexity

30

Size/Duplication

Total Lines	209
Duplicated Lines	0 %

Importance

Changes	7
Bugs	0	Features	2

17 Methods

Rating	Name	Duplication	Size	Complexity
A	getTitle()	0	2	1
A	removeByUniqueName()	0	11	2
A	listWidgets()	0	2	1
A	removeById()	0	7	1
A	load()	0	8	2
A	__construct()	0	4	2
A	initialize()	0	18	3
A	getUniqueName()	0	2	1
A	listWidgetTplArray()	0	17	2
A	getRow()	0	2	1
A	getSidebarId()	0	2	1
A	create()	0	19	3
A	isDeletable()	0	2	1
A	isInitialized()	0	2	1
A	loadWidgets()	0	34	4
A	cast()	0	2	1
A	listSidebars()	0	21	3

<?php

/**
 * Copyright (c) 2018 Justin Kuenzel (jukusoft.com)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


/**
 * Project: RocketCMS
 * License: Apache 2.0 license
 * User: Justin
 * Date: 24.08.2018
 * Time: 13:44
 */

class Sidebar {

	protected $sidebar_id = -1;
	protected $row = array();

	protected $widget_rows = array();
	protected $widgets = array();

	protected static $is_initialized = false;
	protected static $all_sidebars = array();

	public function __construct() {
		//load in-memory cache, if neccessary
		if (!self::isInitialized()) {
			self::initialize();
		}
	}

	public function load (int $sidebar_id) {
		if (isset(self::$all_sidebars[$sidebar_id])) {
			$this->row = self::$all_sidebars[$sidebar_id];
		} else {
			throw new IllegalStateException("sidebar with id '" . $sidebar_id . "' doesnt exists.");
		}

		$this->sidebar_id = $sidebar_id;
	}

	public function loadWidgets () {
		$this->widgets = array();

		//load widgets
		if (Cache::contains("sidebars", "sidebar_widgets_" . $this->sidebar_id)) {
			$this->widget_rows = Cache::get("sidebars", "sidebar_widgets_" . $this->sidebar_id);
		} else {
			//list rows from database
			$rows = Database::getInstance()->listRows("SELECT * FROM `{praefix}sidebar_widgets` WHERE `sidebar_id` = :sidebar_id ORDER BY `order`; ", array(
				'sidebar_id' => $this->sidebar_id
			));

			//cache results
			Cache::put("sidebars", "sidebar_widgets_" . $this->sidebar_id, $rows);

			$this->widget_rows = $rows;
		}

		foreach ($this->widget_rows as $widget_row) {
			$class_name = $widget_row['class_name'];
			$widget_instance = new $class_name();

			if (!($widget_instance instanceof Widget)) {
				throw new IllegalStateException("instance has to be an instance of class Widget, this means widget types has to extends class Widget.");
			}

			//cast widget
			$widget = Widget::castWidget($widget_instance);

			//load widget and set row, so widget doesn't needs to load data seperate from database
			$widget->load($widget_row);

			//add widget to list
			$this->widgets[] = $widget;
		}
	}

	/**
	 * list widget instances
	 */
	public function listWidgets () : array {
		return $this->widgets;
	}

	public function listWidgetTplArray () : array {
		$array = array();

		foreach ($this->listWidgets() as $widget) {
			$widget = Widget::castWidget($widget);

			$array[] = array(
				'id' => $widget->getId(),
				'title' => $widget->getTitle(),
				'code' => $widget->getCode(),
				'css_id' => $widget->getCSSId(),
				'css_class' => $widget->getCSSClass(),
				'use_template' => $widget->useTemplate()
			);
		}

		return $array;
	}

	/**
	 * @return int sidebar id
	 */
	public function getSidebarId(): int {
		return $this->sidebar_id;
	}

	public function getUniqueName () : string {
		return $this->row['unique_name'];
	}

	public function getTitle () : string {
		return $this->row['title'];
	}

	public function isDeletable () : bool {
		return $this->row['deletable'] == 1;
	}

	public function getRow () : array {
		return $this->row;
	}

	/**
	 * @return bool
	 */
	protected static function isInitialized(): bool {
		return self::$is_initialized;
	}

	protected static function initialize () {
		if (Cache::contains("sidebars", "all_sidebars")) {
			self::$all_sidebars = Cache::get("sidebars", "all_sidebars");
		} else {
			$rows = Database::getInstance()->listRows("SELECT * FROM `{praefix}sidebars`; ");

			//clear in-memory cache
			self::$all_sidebars = array();

			foreach ($rows as $row) {
				self::$all_sidebars[$row['sidebar_id']] = $row;
			}

			//cache result
			Cache::put("sidebars", "all_sidebars", self::$all_sidebars);
		}

		self::$is_initialized = true;
	}

	public static function create (string $title, string $unique_name, bool $deletable = true) : int {
		if (empty($unique_name)) {
			throw new IllegalArgumentException("unique_name cannot be null.");
		}

		Database::getInstance()->execute("INSERT INTO `{praefix}sidebars` (
			`sidebar_id`, `unique_name`, `title`, `deletable`
		) VALUES (
			NULL, :unique_name, :title, :deletable
		) ON DUPLICATE KEY UPDATE `unique_name` = :unique_name, `title` = :title, `deletable` = :deletable; ", array(
			'unique_name' => $unique_name,
			'title' => $title,
			'deletable' => ($deletable ? 1 : 0)
		));

		//clear cache
		Cache::clear("sidebars");

		return Database::getInstance()->lastInsertId();
	}

	public static function removeById (int $id) {
		Database::getInstance()->execute("DELETE FROM `{praefix}sidebars` WHERE `sidebar_id` = :sidebar_id; ", array(
			'sidebar_id' => $id
		));

		//clear cache
		Cache::clear("sidebars");
	}

	public static function removeByUniqueName (string $unique_name) {
		if (empty($unique_name)) {
			throw new IllegalArgumentException("unique_name cannot be null.");
		}

		Database::getInstance()->execute("DELETE FROM `{praefix}sidebars` WHERE `unique_name` = :unique_name; ", array(
			'unique_name' => $unique_name
		));

		//clear cache
		Cache::clear("sidebars");
	}

	public static function listSidebars () : array {
		$rows = array();

		if (Cache::contains("sidebars", "list")) {
			$rows = Cache::get("sidebars", "list");
		} else {
			$rows = Database::getInstance()->listRows("SELECT * FROM `{praefix}sidebars`; ");

			Cache::put("sidebars", "list", $rows);
		}

		$list = array();

		foreach ($rows as $row) {
			$obj = new Sidebar();
			$obj->load($row);

			$list[] = $obj;
		}

		return $list;
	}

	public static function cast (Sidebar $sidebar) : Sidebar {
		return $sidebar;
	}

}

?>

It is not recommended to use PHP's closing tag ?> in files other than templates.