nextcloud-server/lib/public/Dashboard/Model/WidgetOptions.php

<?php

declare(strict_types=1);
/**
 * @copyright Copyright (c) 2022 Robin Appelman <robin@icewind.nl>
 *
 * @license GNU AGPL version 3 or any later version
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero 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 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/>.
 *
 */

namespace OCP\Dashboard\Model;

/**
 * Option for displaying a widget
 *
 * @since 25.0.0
 */
class WidgetOptions {
	private bool $roundItemIcons;

	/**
	 * @param bool $roundItemIcons
	 * @since 25.0.0
	 */
	public function __construct(bool $roundItemIcons) {
		$this->roundItemIcons = $roundItemIcons;
	}

	/**
	 * Get the default set of options
	 *
	 * @return WidgetOptions
	 * @since 25.0.0
	 */
	public static function getDefault(): WidgetOptions {
		return new WidgetOptions(false);
	}

	/**
	 * Whether the clients should render icons for widget items as round icons
	 *
	 * @return bool
	 * @since 25.0.0
	 */
	public function withRoundItemIcons(): bool {
		return $this->roundItemIcons;
	}
}