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

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

143 lines 4.6 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	/**
39	* COMMENT property functions
40	*
41	* @author Kjell-Inge Gustafsson, kigkonsult <ical@kigkonsult.se>
42	* @since 2.29.14 2019-09-03
43	*/
44	trait COMMENTtrait
45	{
46	/**
47	* @var array component property COMMENT value
48	*/
49	protected $comment = null;
50
51	/**
52	* Return formatted output for calendar component property comment
53	*
54	* @return string
55	*/
56	public function createComment()
57	{
58	if( empty( $this->comment )) {
59	return null;
60	}
61	$output = null;
62	$lang = $this->getConfig( self::LANGUAGE );
63	foreach( $this->comment as $cx => $commentPart ) {
64	if( empty( $commentPart[Util::$LCvalue] )) {
65	if( $this->getConfig( self::ALLOWEMPTY )) {
66	$output .= StringFactory::createElement( self::COMMENT );
67	}
68	continue;
69	}
70	$output .= StringFactory::createElement(
71	self::COMMENT,
72	ParameterFactory::createParams(
73	$commentPart[Util::$LCparams],
74	self::$ALTRPLANGARR,
75	$lang
76	),
77	StringFactory::strrep( $commentPart[Util::$LCvalue] )
78	);
79	} // end foreach
80	return $output;
81	}
82
83	/**
84	* Delete calendar component property comment
85	*
86	* @param int $propDelIx specific property in case of multiply occurrence
87	* @return bool
88	* @since 2.27.1 - 2018-12-15
89	*/
90	public function deleteComment( $propDelIx = null )
91	{
92	if( empty( $this->comment )) {
93	unset( $this->propDelIx[self::COMMENT] );
94	return false;
95	}
96	return $this->deletePropertyM( $this->comment, self::COMMENT, $propDelIx );
97	}
98
99	/**
100	* Get calendar component property comment
101	*
102	* @param int $propIx specific property in case of multiply occurrence
103	* @param bool $inclParam
104	* @return bool\|array
105	* @since 2.27.1 - 2018-12-12
106	*/
107	public function getComment( $propIx = null, $inclParam = false )
108	{
109	if( empty( $this->comment )) {
110	unset( $this->propIx[self::COMMENT] );
111	return false;
112	}
113	return $this->getPropertyM(
114	$this->comment,
115	self::COMMENT,
116	$propIx,
117	$inclParam
118	);
119	}
120
121	/**
122	* Set calendar component property comment
123	*
124	* @param string $value
125	* @param array $params
126	* @param integer $index
127	* @return static
128	* @throws InvalidArgumentException
129	* @since 2.29.14 2019-09-03
130	*/
131	public function setComment( $value = null, $params = [], $index = null )
132	{
133	if( empty( $value )) {
134	$this->assertEmptyValue( $value, self::COMMENT );
135	$value = Util::$SP0;
136	$params = [];
137	}
138	Util::assertString( $value, self::COMMENT );
139	$this->setMval( $this->comment, (string) $value, $params, null, $index );
140	return $this;
141	}
142	}
143