nextcloud/lib/private/Notification/Action.php

176 lines
3.5 KiB
PHP
Raw Normal View History

2015-08-31 13:24:37 +03:00
<?php
declare(strict_types=1);
2015-08-31 13:24:37 +03:00
/**
2016-01-12 17:02:16 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
2016-07-21 18:07:57 +03:00
*
* @author Joas Schilling <coding@schilljs.com>
*
2015-08-31 13:24:37 +03:00
* @license AGPL-3.0
*
* This code 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.
*
* 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, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
2015-08-31 13:24:37 +03:00
*
*/
namespace OC\Notification;
use OCP\Notification\IAction;
2015-08-31 13:24:37 +03:00
class Action implements IAction {
/** @var string */
protected $label;
/** @var string */
protected $labelParsed;
/** @var string */
protected $link;
2015-09-01 11:46:08 +03:00
/** @var string */
protected $requestType;
2015-08-31 13:24:37 +03:00
/** @var string */
protected $icon;
2015-11-16 18:14:52 +03:00
/** @var bool */
protected $primary;
2015-08-31 13:24:37 +03:00
public function __construct() {
$this->label = '';
$this->labelParsed = '';
$this->link = '';
2015-09-01 11:46:08 +03:00
$this->requestType = '';
$this->primary = false;
2015-08-31 13:24:37 +03:00
}
/**
* @param string $label
* @return $this
* @throws \InvalidArgumentException if the label is invalid
* @since 8.2.0
*/
public function setLabel(string $label): IAction {
if ($label === '' || isset($label[32])) {
2015-08-31 13:24:37 +03:00
throw new \InvalidArgumentException('The given label is invalid');
}
$this->label = $label;
return $this;
}
/**
* @return string
* @since 8.2.0
*/
public function getLabel(): string {
2015-08-31 13:24:37 +03:00
return $this->label;
}
/**
* @param string $label
* @return $this
* @throws \InvalidArgumentException if the label is invalid
* @since 8.2.0
*/
public function setParsedLabel(string $label): IAction {
if ($label === '') {
2015-08-31 13:24:37 +03:00
throw new \InvalidArgumentException('The given parsed label is invalid');
}
$this->labelParsed = $label;
return $this;
}
/**
* @return string
* @since 8.2.0
*/
public function getParsedLabel(): string {
2015-08-31 13:24:37 +03:00
return $this->labelParsed;
}
2015-11-16 18:14:52 +03:00
/**
* @param $primary bool
* @return $this
2015-11-16 18:14:52 +03:00
* @since 9.0.0
*/
public function setPrimary(bool $primary): IAction {
2015-11-16 18:14:52 +03:00
$this->primary = $primary;
return $this;
2015-11-16 18:14:52 +03:00
}
/**
* @return bool
* @since 9.0.0
*/
public function isPrimary(): bool {
2015-11-16 18:14:52 +03:00
return $this->primary;
}
2015-08-31 13:24:37 +03:00
/**
* @param string $link
2015-09-01 11:46:08 +03:00
* @param string $requestType
2015-08-31 13:24:37 +03:00
* @return $this
* @throws \InvalidArgumentException if the link is invalid
* @since 8.2.0
*/
public function setLink(string $link, string $requestType): IAction {
if ($link === '' || isset($link[256])) {
2015-08-31 13:24:37 +03:00
throw new \InvalidArgumentException('The given link is invalid');
}
if (!in_array($requestType, [
self::TYPE_GET,
self::TYPE_POST,
self::TYPE_PUT,
self::TYPE_DELETE,
self::TYPE_WEB,
], true)) {
2015-09-01 11:46:08 +03:00
throw new \InvalidArgumentException('The given request type is invalid');
}
2015-08-31 13:24:37 +03:00
$this->link = $link;
2015-09-01 18:06:38 +03:00
$this->requestType = $requestType;
2015-08-31 13:24:37 +03:00
return $this;
}
/**
* @return string
* @since 8.2.0
*/
public function getLink(): string {
2015-08-31 13:24:37 +03:00
return $this->link;
}
2015-09-01 13:09:39 +03:00
/**
* @return string
* @since 8.2.0
*/
public function getRequestType(): string {
2015-09-01 13:09:39 +03:00
return $this->requestType;
}
2015-08-31 13:24:37 +03:00
/**
* @return bool
*/
public function isValid(): bool {
2015-08-31 13:24:37 +03:00
return $this->label !== '' && $this->link !== '';
}
/**
* @return bool
*/
public function isValidParsed(): bool {
2015-08-31 13:24:37 +03:00
return $this->labelParsed !== '' && $this->link !== '';
}
}