import-facebook-events / includes / lib / icalcreator / src / Traits / ACTIONtrait.php

ACTIONtrait.php in Import Social Events 1.8.5, at includes/lib/icalcreator/src/Traits/ACTIONtrait.php

135 lines 4.2 KB

Raw Download Zip

1	<?php
2	/**
3	* iCalcreator, the PHP class package managing iCal (rfc2445/rfc5445) calendar information.
4	*
5	* copyright (c) 2007-2021 Kjell-Inge Gustafsson, kigkonsult, All rights reserved
6	* Link https://kigkonsult.se
7	* Package iCalcreator
8	* Version 2.30
9	* License Subject matter of licence is the software iCalcreator.
10	* The above copyright, link, package and version notices,
11	* this licence notice and the invariant [rfc5545] PRODID result use
12	* as implemented and invoked in iCalcreator shall be included in
13	* all copies or substantial portions of the iCalcreator.
14	*
15	* iCalcreator is free software: you can redistribute it and/or modify
16	* it under the terms of the GNU Lesser General Public License as published
17	* by the Free Software Foundation, either version 3 of the License,
18	* or (at your option) any later version.
19	*
20	* iCalcreator is distributed in the hope that it will be useful,
21	* but WITHOUT ANY WARRANTY; without even the implied warranty of
22	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23	* GNU Lesser General Public License for more details.
24	*
25	* You should have received a copy of the GNU Lesser General Public License
26	* along with iCalcreator. If not, see <https://www.gnu.org/licenses/>.
27	*
28	* This file is a part of iCalcreator.
29	*/
30
31	namespace Kigkonsult\Icalcreator\Traits;
32
33	use Kigkonsult\Icalcreator\Util\StringFactory;
34	use Kigkonsult\Icalcreator\Util\Util;
35	use Kigkonsult\Icalcreator\Util\ParameterFactory;
36	use InvalidArgumentException;
37
38	use function strtoupper;
39
40	/**
41	* ACTION property functions
42	*
43	* @author Kjell-Inge Gustafsson, kigkonsult <ical@kigkonsult.se>
44	* @since 2.29.14 2019-09-03
45	*/
46	trait ACTIONtrait
47	{
48	/**
49	* @var array component property ACTION value
50	*/
51	protected $action = null;
52
53	/**
54	* Return formatted output for calendar component property action
55	*
56	* @return string
57	*/
58	public function createAction()
59	{
60	if( empty( $this->action )) {
61	return null;
62	}
63	if( empty( $this->action[Util::$LCvalue] )) {
64	return $this->getConfig( self::ALLOWEMPTY )
65	? StringFactory::createElement( self::ACTION )
66	: null;
67	}
68	return StringFactory::createElement(
69	self::ACTION,
70	ParameterFactory::createParams( $this->action[Util::$LCparams] ),
71	$this->action[Util::$LCvalue]
72	);
73	}
74
75	/**
76	* Delete calendar component property action
77	*
78	* @return bool
79	* @since 2.27.1 - 2018-12-15
80	*/
81	public function deleteAction()
82	{
83	$this->action = null;
84	return true;
85	}
86
87	/**
88	* Get calendar component property action
89	*
90	* @param bool $inclParam
91	* @return bool\|array
92	* @since 2.27.1 - 2018-12-13
93	*/
94	public function getAction( $inclParam = false )
95	{
96	if( empty( $this->action )) {
97	return false;
98	}
99	return ( $inclParam ) ? $this->action : $this->action[Util::$LCvalue];
100	}
101
102	/**
103	* Set calendar component property action
104	*
105	* @param string $value "AUDIO" / "DISPLAY" / "EMAIL" / "PROCEDURE" / iana-token / x-name ??
106	* @param mixed $params
107	* @return static
108	* @throws InvalidArgumentException
109	* @since 2.29.14 2019-09-03
110	*/
111	public function setAction( $value = null, $params = [] )
112	{
113	static $STDVALUES = [
114	self::AUDIO,
115	self::DISPLAY,
116	self::EMAIL,
117	self::PROCEDURE // deprecated in rfc5545
118	];
119	if( empty( $value )) {
120	$this->assertEmptyValue( $value, self::ACTION );
121	$value = Util::$SP0;
122	$params = [];
123	}
124	elseif( Util::isPropInList( $value, $STDVALUES )) {
125	$value = strtoupper( $value );
126	}
127	Util::assertString( $value, self::ACTION );
128	$this->action = [
129	Util::$LCvalue => strtoupper( StringFactory::trimTrailNL((string) $value )),
130	Util::$LCparams => ParameterFactory::setParams( $params ),
131	];
132	return $this;
133	}
134	}
135