event.php

См. документацию.

<?php
 
namespace Bitrix\Calendar\Core\Event;
 
use Bitrix\Calendar\Core\Base\DateTimeZone;
use Bitrix\Calendar\Core\Base\EntityInterface;
use Bitrix\Calendar\Core\Builders\Builder;
use Bitrix\Calendar\Core\Event\Properties\AttendeeCollection;
use Bitrix\Calendar\Core\Base\Date;
use Bitrix\Calendar\Core\Event\Properties\ExcludedDatesCollection;
use Bitrix\Calendar\Core\Event\Properties\Location;
use Bitrix\Calendar\Core\Event\Properties\MeetingDescription;
use Bitrix\Calendar\Core\Event\Properties\RecurringEventRules;
use Bitrix\Calendar\Core\Event\Properties\Relations;
use Bitrix\Calendar\Core\Event\Tools\Dictionary;
use Bitrix\Calendar\Core\eventoption\EventOption;
use Bitrix\Calendar\Core\Role\Role;
use Bitrix\Calendar\Core\Section\Section;
use Bitrix\Main\Text\Emoji;
use Bitrix\Main\Type\Contract\Arrayable;
 
class Event implements EntityInterface, Arrayable
{
    private const MIN_MEETING_PARTICIPANT = 2;

    protected ?int $id = null;
    protected ?string $name = null;
    protected ?RecurringEventRules $recurringRule = null;
    protected ?Location $location = null;
    protected ?Date $start = null;
    protected ?Date $end = null;
    protected bool $isFullDay = true;
    protected ?AttendeeCollection $attendeeCollection = null;
    protected ?Properties\RemindCollection $remindCollection = null;
    protected ?string $description = null;
    protected ?string $color = null;
    protected ?string $transparent  = null;
    protected ?Section $section  = null;
    protected ?string $importance  = null;
    protected ?string $accessibility = 'busy';
    protected bool $isPrivate = false;
    protected ?Role $eventHost = null;
    protected ?Role $creator = null;
    protected ?Role $owner = null;
    protected ?MeetingDescription $meetingDescription = null;
    protected ?int $version = 0;
    protected ?string $eventType = null;
    protected ?string $calType = null;
    protected ?string $uid = null;
    protected bool $isActive = true;
    protected bool $isDeleted = false;
    protected ?int $recurrenceId = null;
    protected ?Date $originalDateFrom = null;
    protected ?Date $dateCreate = null;
    protected ?Date $dateModified = null;
    protected ?ExcludedDatesCollection $excludedDateCollection = null;
    protected ?DateTimeZone $startTimeZone = null;
    protected ?DateTimeZone $endTimeZone = null;
    private ?int $parentId = null;
    private bool $isMeeting = false;
    private ?int $dtLength = 0;
    private ?string $meetingStatus = null;
    private ?Relations $relations = null;
 
    private ?EventOption $eventOption = null;
 
    private ?int $collabId = null;

    public static function fromBuilder(Builder $builder): Event
    {
        return $builder->build();
    }

    public function __toString()
    {
        return $this->name ?? '';
    }

    public function setName(?string $name): Event
    {
        $this->name = $name ? Emoji::decode($name) : $name;
 
        return $this;
    }

    public function setRecurringRule(?RecurringEventRules $recurringRule): Event
    {
        $this->recurringRule = $recurringRule;
 
        return $this;
    }

    public function setLocation(?Location $location): Event
    {
        $this->location = $location;
 
        return $this;
    }

    public function setStart(?Date $start): Event
    {
        $this->start = $start;
 
        return $this;
    }

    public function setStartTimeZone(?DateTimeZone $timezone): Event
    {
        $this->startTimeZone = $timezone;
 
        return $this;
    }

    public function setEndTimeZone(?DateTimeZone $timezone): Event
    {
        $this->endTimeZone = $timezone;
        return $this;
    }

    public function setEnd(?Date $end): Event
    {
        $this->end = $end;
 
        return $this;
    }

    public function setAttendeesCollection(?AttendeeCollection $collection): Event
    {
        $this->attendeeCollection = $collection;
 
        return $this;
    }

    public function setIsFullDay(bool $isFullDay): Event
    {
        $this->isFullDay = $isFullDay;
 
        return $this;
    }

    public function setRemindCollection(?Properties\RemindCollection $remindCollection): Event
    {
        $this->remindCollection = $remindCollection;
 
        return $this;
    }

    public function setSection(?Section $section): Event
    {
        $this->section = $section;
 
        return $this;
    }

    public function setDescription(?string $description): Event
    {
        $this->description = $description ? Emoji::decode($description) : $description;
 
        return $this;
    }

    public function setColor(?string $color): Event
    {
        $this->color = $color;
 
        return $this;
    }

    public function setAccessibility(?string $accessibility): Event
    {
        $this->accessibility = $accessibility;
 
        return $this;
    }

    public function setImportance(?string $importance): Event
    {
        $this->importance = $importance;
 
        return $this;
    }

    public function setIsPrivate(bool $isPrivate): Event
    {
        $this->isPrivate = $isPrivate;
 
        return $this;
    }

    public function setEventHost(?Role $eventHost): Event
    {
        $this->eventHost = $eventHost;
 
        return $this;
    }

    public function setCreator(?Role $creator): Event
    {
        $this->creator = $creator;
 
        return $this;
    }

    public function setOwner(?Role $owner): Event
    {
        $this->owner = $owner;
 
        return $this;
    }

    public function setVersion(int $version): Event
    {
        $this->version = $version;
 
        return $this;
    }

    public function setOriginalDateFrom(?Date $originalDateFrom): Event
    {
        $this->originalDateFrom = $originalDateFrom;
 
        return $this;
    }

    public function setRecurrenceId(?int $recurrenceId): Event
    {
        $this->recurrenceId = $recurrenceId;
 
        return $this;
    }

    public function setDateCreate(?Date $dateCreate): Event
    {
        $this->dateCreate = $dateCreate;
 
        return $this;
    }

    public function setDateModified(?Date $dateModified): Event
    {
        $this->dateModified = $dateModified;
 
        return $this;
    }

    public function setIsActive(bool $isActive): Event
    {
        $this->isActive = $isActive;
 
        return $this;
    }

    public function setIsDeleted(bool $isDeleted): Event
    {
        $this->isDeleted = $isDeleted;
 
        return $this;
    }

    public function setUid(?string $uid): Event
    {
        $this->uid = $uid;
 
        return $this;
    }

    public function setTransparent(?string $transparent): Event
    {
        $this->transparent = $transparent;
 
        return $this;
    }

    public function setExcludedDateCollection(?ExcludedDatesCollection $excludedDateCollection): Event
    {
        $this->excludedDateCollection = $excludedDateCollection;
 
        return $this;
    }

    public function setEventType(?string $eventType): Event
    {
        $this->eventType = $eventType;
 
        return $this;
    }

    public function setSpecialLabel(?string $label): Event
    {
        $this->eventType = $label;
 
        return $this;
    }

    public function setMeetingDescription(?MeetingDescription $meetingDescription): Event
    {
        $this->meetingDescription = $meetingDescription;
 
        return $this;
    }

    public function setRelations(?Relations $relations): Event
    {
        $this->relations = $relations;
 
        return $this;
    }
 

    public function getName(): ?string
    {
        return $this->name;
    }

    public function getRecurringRule(): ?RecurringEventRules
    {
        return $this->recurringRule;
    }

    public function getLocation(): ?Location
    {
        return $this->location;
    }

    public function getStart(): Date
    {
        return $this->start;
    }

    public function getStartTimeZone(): ?DateTimeZone
    {
        return $this->startTimeZone;
    }

    public function getEndTimeZone(): ?DateTimeZone
    {
        return $this->endTimeZone;
    }

    public function getEnd(): Date
    {
        return $this->end;
    }

    public function getAttendeesCollection(): ?AttendeeCollection
    {
        if (is_null($this->attendeeCollection))
        {
            $this->initAttendeesCollection();
        }
        return $this->attendeeCollection;
    }

    public function getDescription(): ?string
    {
        return $this->description;
    }

    public function getOwner(): ?Role
    {
        return $this->owner;
    }

    public function getCreator(): ?Role
    {
        return $this->creator;
    }

    public function getEventHost(): ?Role
    {
        return $this->eventHost;
    }

    public function getIsPrivate(): bool
    {
        return $this->isPrivate;
    }

    public function isPrivate(): bool
    {
        return $this->isPrivate;
    }

    public function getAccessibility(): ?string
    {
        return $this->accessibility;
    }

    public function getImportance(): ?string
    {
        return $this->importance;
    }

    public function getSection(): Section
    {
        if ($this->section === null)
        {
            $this->initSection();
        }
 
        return $this->section;
    }

    public function getColor(): ?string
    {
        return $this->color;
    }

    public function getTransparent(): ?string
    {
        return $this->transparent;
    }

    public function getMeetingDescription(): ?MeetingDescription
    {
        return $this->meetingDescription;
    }

    public function getRelations(): ?Relations
    {
        return $this->relations;
    }

    public function getVersion(): int
    {
        return $this->version;
    }

    public function getEventType(): ?string
    {
        return $this->eventType;
    }

    public function getSpecialLabel(): ?string
    {
        return $this->eventType;
    }

    public function getUid(): ?string
    {
        return $this->uid;
    }

    public function isActive(): bool
    {
        return $this->isActive;
    }

    public function isDeleted(): bool
    {
        return $this->isDeleted;
    }

    public function isInstance(): bool
    {
        return $this->recurrenceId && $this->originalDateFrom;
    }

    public function getRecurrenceId(): ?int
    {
        return $this->recurrenceId;
    }

    public function getOriginalDateFrom(): ?Date
    {
        return $this->originalDateFrom;
    }

    public function getDateCreate(): ?Date
    {
        return $this->dateCreate;
    }

    public function getDateModified(): ?Date
    {
        return $this->dateModified;
    }

    public function getExcludedDateCollection(): ?ExcludedDatesCollection
    {
        return $this->excludedDateCollection;
    }

    public function isFullDayEvent(): bool
    {
        return $this->isFullDay;
    }

    public function isRecurrence(): bool
    {
        return $this->recurringRule && $this->recurringRule->getFrequency();
    }

    public function isSingle(): bool
    {
        return !$this->isInstance() && !$this->isRecurrence();
    }

    public function isBaseEvent(): bool
    {
        return ($this->id === $this->parentId) && ($this->id !== null);
    }

    public function getRemindCollection(): ?Properties\RemindCollection
    {
        return $this->remindCollection;
    }

    public function isMeeting(): bool
    {
        if ($this->isMeeting === false)
        {
            return $this->attendeeCollection
                && count($this->attendeeCollection) >= self::MIN_MEETING_PARTICIPANT;
        }
 
        return true;
    }

    public function getId(): ?int
    {
        return $this->id;
    }

    public function setId(?int $id): Event
    {
        $this->id = $id;
 
        return $this;
    }
 
    private function initAttendeesCollection(): void
    {
        // TODO: need to implement a logic
        $this->attendeeCollection = new AttendeeCollection();
    }
 
    private function initSection(): void
    {
        // TODO: need to implement a logic
        $this->section = new Section();
    }

    public function setParentId(?int $parentId): Event
    {
        $this->parentId = $parentId;
 
        return $this;
    }

    public function getParentId(): ?int
    {
        return $this->parentId;
    }

    public function setIsMeeting(bool $isMeeting): Event
    {
        $this->isMeeting = $isMeeting;
 
        return $this;
    }

    public function setMeetingStatus(?string $meetingStatus): Event
    {
        $this->meetingStatus = $meetingStatus;
 
        return $this;
    }

    public function getMeetingStatus(): ?string
    {
        return $this->meetingStatus;
    }

    public function isNew(): bool
    {
        return $this->id === 0 || $this->id === null;
    }

    public function upVersion(): self
    {
        $this->version++;
 
        return $this;
    }

    public function getCalendarType(): ?string
    {
        return $this->calType;
    }

    public function setCalendarType(?string $calendarType): self
    {
        $this->calType = $calendarType;
        return $this;
    }
 
    public function getEventOption(): ?EventOption
    {
        return $this->eventOption;
    }
 
    public function setEventOption(?EventOption $eventOption): self
    {
        $this->eventOption = $eventOption;
 
        return $this;
    }
 
    public function isOpenEvent(): bool
    {
        return $this->getSection()?->getType() === Dictionary::CALENDAR_TYPE['open_event'];
    }
 
    public function setDtLength(?int $dtLength): self
    {
        $this->dtLength = $dtLength;
 
        return $this;
    }
 
    public function getDtLength(): ?int
    {
        return $this->dtLength;
    }
 
    public function setCollabId(?int $collabId): self
    {
        $this->collabId = $collabId;
 
        return $this;
    }
 
    public function getCollabId(): ?int
    {
        return $this->collabId;
    }
 
    public function toArray(): array
    {
        return [
            'ID' => $this->id,
            'PARENT_ID' => $this->parentId,
            'ACTIVE' => $this->isActive ? 'Y' : 'N',
            'DELETED' => $this->isDeleted ? 'Y' : 'N',
            'CAL_TYPE' => $this->calType,
            'OWNER' => $this->owner?->getId(),
            'NAME' => $this->name,
            'DATE_FROM' => $this->start,
            'DATE_TO' => $this->end,
            'TZ_FROM' => $this->startTimeZone,
            'TZ_TO' => $this->endTimeZone,
            'DT_SKIP_TIME' => $this->isFullDay ? 'Y' : 'N',
            'DT_LENGTH' => $this->dtLength,
            'EVENT_TYPE' => $this->eventType,
            'CREATED_BY' => $this->creator?->getId(),
            'DATE_CREATE' => $this->dateCreate,
            'DESCRIPTION' => $this->description,
            'ACCESSIBILITY' => $this->accessibility,
            'IMPORTANCE' => $this->importance,
            'IS_MEETING' => $this->isMeeting,
            'MEETING_STATUS' => $this->meetingStatus,
            'MEETING_HOST' => $this->eventHost?->getId(),
            'MEETING' => $this->getMeetingDescription(),
            'LOCATION' => $this->location?->toString(),
            'REMIND' => $this->remindCollection->getCollection(),
            'COLOR' => $this->color,
            'RRULE' => $this->recurringRule->toArray(),
            'VERSION' => $this->version,
            'ATTENDEES_CODE' => implode(',', $this->attendeeCollection->getAttendeesCodes()),
            'SECTION_ID' => $this->section?->getId(),
        ];
    }
}