nextcloud-server/lib/public/Dashboard/Model/WidgetButton.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;

/**
 * Button for a dashboard widget
 *
 * @since 25.0.0
 */
class WidgetButton {
	/**
	 * @since 25.0.0
	 */
	public const TYPE_NEW = 'new';

	/**
	 * @since 25.0.0
	 */
	public const TYPE_MORE = 'more';

	/**
	 * @since 25.0.0
	 */
	public const TYPE_SETUP = 'setup';

	private string $type;
	private string $link;
	private string $text;

	/**
	 * @param string $type
	 * @param string $link
	 * @param string $text
	 * @since 25.0.0
	 */
	public function __construct(string $type, string $link, string $text) {
		$this->type = $type;
		$this->link = $link;
		$this->text = $text;
	}

	/**
	 * Get the button type, either "new", "more" or "setup"
	 *
	 * @return string
	 * @since 25.0.0
	 */
	public function getType(): string {
		return $this->type;
	}

	/**
	 * Get the absolute url the buttons links to
	 *
	 * @return string
	 * @since 25.0.0
	 */
	public function getLink(): string {
		return $this->link;
	}

	/**
	 * Get the translated text for the button
	 *
	 * @return string
	 * @since 25.0.0
	 */
	public function getText(): string {
		return $this->text;
	}
}