<?php
/**
 * iCalcreator, a PHP rfc2445/rfc5545 solution.
 *
 * This file is a part of iCalcreator.
 *
 * Copyright (c) 2007-2017 Kjell-Inge Gustafsson, kigkonsult, All rights reserved
 * Link      http://kigkonsult.se/iCalcreator/index.php
 * Package   iCalcreator
 * Version   2.24
 * License   Subject matter of licence is the software iCalcreator.
 *           The above copyright, link, package and version notices,
 *           this licence notice and the [rfc5545] PRODID as implemented and
 *           invoked in iCalcreator shall be included in all copies or
 *           substantial portions of the iCalcreator.
 *           iCalcreator can be used either under the terms of
 *           a proprietary license, available at <https://kigkonsult.se/>
 *           or the GNU Affero General Public License, version 3:
 *           iCalcreator 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.
 *           iCalcreator 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 kigkonsult\iCalcreator\traits;
use kigkonsult\iCalcreator\util\util;
/**
 * RELATED-TO property functions
 *
 * @author Kjell-Inge Gustafsson, kigkonsult <ical@kigkonsult.se>
 * @since 2.22.23 - 2017-02-17
 */
trait RELATED_TOtrait {
/**
 * @var array component property RELATED_TO value
 * @access protected
 */
  protected $relatedto = null;
/**
 * Return formatted output for calendar component property related-to
 *
 * @return string
 */
  public function createRelatedTo() {
    if( empty( $this->relatedto ))
      return null;
    $output = null;
    foreach( $this->relatedto as $rx => $relation ) {
      if( ! empty( $relation[util::$LCvalue] ))
        $output .= util::createElement( util::$RELATED_TO,
                                        util::createParams( $relation[util::$LCparams] ),
                                        util::strrep( $relation[util::$LCvalue] ));
      elseif( $this->getConfig( util::$ALLOWEMPTY ))
        $output .= util::createElement( util::$RELATED_TO );
    }
    return $output;
  }
/**
 * Set calendar component property related-to
 *
 * @param string  $value
 * @param array   $params
 * @param int     $index
 * @return bool
 */
  public function setRelatedTo( $value, $params=null, $index=null ) {
    static $RELTYPE = 'RELTYPE';
    static $PARENT  = 'PARENT';
    if( empty( $value )) {
      if( $this->getConfig( util::$ALLOWEMPTY ))
        $value = util::$EMPTYPROPERTY;
      else
        return false;
    }
    util::existRem( $params, $RELTYPE, $PARENT, true ); // remove default
    util::setMval( $this->relatedto,
                   util::trimTrailNL( $value ),
                   $params,
                   false,
                   $index );
    return true;
  }
}