openstackid-resources/app/Models/Foundation/Summit/Events/SummitEvent.php

<?php namespace models\summit;
/**
 * Copyright 2015 OpenStack Foundation
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 **/

use App\Events\SummitEventCreated;
use App\Events\SummitEventDeleted;
use App\Events\SummitEventUpdated;
use Doctrine\Common\Collections\Criteria;
use Doctrine\ORM\Event\PreUpdateEventArgs;
use models\exceptions\ValidationException;
use models\main\Company;
use models\main\Tag;
use models\utils\PreRemoveEventArgs;
use models\utils\SilverstripeBaseModel;
use Doctrine\ORM\Mapping AS ORM;
use Doctrine\Common\Collections\ArrayCollection;
use DateTime;
use Illuminate\Support\Facades\Event;
use Illuminate\Support\Facades\Config;
use Cocur\Slugify\Slugify;

/**
 * @ORM\Entity
 * @ORM\Table(name="SummitEvent")
 * @ORM\InheritanceType("JOINED")
 * @ORM\DiscriminatorColumn(name="ClassName", type="string")
 * @ORM\DiscriminatorMap({"SummitEvent" = "SummitEvent", "Presentation" = "Presentation"})
 * @ORM\Entity(repositoryClass="repositories\summit\DoctrineSummitEventRepository")
 * @ORM\HasLifecycleCallbacks
 * Class SummitEvent
 * @package models\summit
 */
class SummitEvent extends SilverstripeBaseModel
{
    /**
     * @return string
     */
    public function getTitle()
    {
        return $this->title;
    }

    /**
     * @return string
     */
    public function getDescription()
    {
        return $this->description;
    }

    /**
     * @return boolean
     */
    public function isAllowFeedback()
    {
        return $this->getAllowFeedback();
    }

    /**
     * @return boolean
     */
    public function getAllowFeedback()
    {
        return $this->allow_feedback;
    }

    use SummitOwned;

    /**
     * SummitEvent constructor.
     */
    public function __construct()
    {
        parent::__construct();
        $this->allow_feedback = false;
        $this->published      = false;
        $this->avg_feedback   = 0;
        $this->head_count     = 0;
        $this->tags           = new ArrayCollection();
        $this->summit_types   = new ArrayCollection();
        $this->feedback       = new ArrayCollection();
        $this->attendees      = new ArrayCollection();
        $this->sponsors       = new ArrayCollection();
    }

   /**
     * @ORM\Column(name="Title", type="string")
     * @var string
     */
    protected $title;

    /**
     * @param string $title
     * @return $this
     */
    public function setTitle($title)
    {
        $this->title = $title;
        return $this;
    }

    /**
     * @return string
     */
    public function getClassName(){
        return "SummitEvent";
    }

    /**
     * @ORM\Column(name="Description", type="string")
     * @var string
     */
    protected $description;

    /**
     * @ORM\Column(name="ShortDescription", type="string")
     * @var string
     */
    protected $short_description;

    /**
     * @param string $description
     * @return $this
     */
    public function setDescription($description)
    {
        $this->description = $description;
        return $this;
    }

    /**
     * @ORM\Column(name="StartDate", type="datetime")
     * @var \DateTime
     */
    protected $start_date;

    /**
     * @ORM\Column(name="RSVPTemplateID", type="integer")
     * @var int
     */
    protected $rsvp_template_id;

    /**
     * @return string
     */
    public function getShortDescription()
    {
        $res = $this->short_description;
        if(empty($res))
            $res = $this->description;
        return $res;
    }

    /**
     * @param string $short_description
     */
    public function setShortDescription($short_description)
    {
        $this->short_description = $short_description;
    }

    /**
     * @return DateTime
     */
    public function getPublishedDate()
    {
        return $this->published_date;
    }

    /**
     * @param DateTime $published_date
     */
    public function setPublishedDate($published_date)
    {
        $this->published_date = $published_date;
    }

    /**
     * @return float
     */
    public function getAvgFeedbackRate()
    {
        return !is_null($this->avg_feedback) ? $this->avg_feedback : 0.0;
    }

    /**
     * @param float $avg_feedback
     */
    public function setAvgFeedbackRate($avg_feedback)
    {
        $this->avg_feedback = $avg_feedback;
    }

    /**
     * @return string
     */
    public function getRsvpLink()
    {
        if($this->rsvp_template_id > 0){
            $summit         = $this->getSummit();
            $main_page      = $summit->getMainPage();
            $schedule_page  = $summit->getSchedulePage();
            return sprintf("%ssummit/%s/%s/events/%s/%s/rsvp",
                Config::get("server.assets_base_url", 'https://www.openstack.org/'),
                $main_page,
                $schedule_page,
                $this->getId(),
                $this->getSlug()
            );
        }
        return $this->rsvp_link;
    }

    public function getSlug(){
        $slugify = new Slugify();
        return $slugify->slugify($this->title);
    }

    /**
     * @param string $rsvp_link
     */
    public function setRsvpLink($rsvp_link)
    {
        $this->rsvp_link = $rsvp_link;
    }

    /**
     * @return int
     */
    public function getHeadCount()
    {
        return $this->head_count;
    }

    /**
     * @param int $head_count
     */
    public function setHeadCount($head_count)
    {
        $this->head_count = $head_count;
    }

    /**
     * @ORM\Column(name="EndDate", type="datetime")
     * @var \DateTime
     */
    protected $end_date;

    /**
     * @ORM\Column(name="Published", type="boolean")
     * @var bool
     */
    protected $published;

    /**
     * @ORM\Column(name="PublishedDate", type="datetime")
     * @var \DateTime
     */
    protected $published_date;

    /**
     * @ORM\Column(name="AllowFeedBack", type="boolean")
     * @var bool
     */
    protected $allow_feedback;

    /**
     * @ORM\Column(name="AvgFeedbackRate", type="float")
     * @var float
     */
    protected $avg_feedback;

    /**
     * @ORM\Column(name="RSVPLink", type="string")
     * @var string
     */
    protected $rsvp_link;


    /**
     * @ORM\Column(name="HeadCount", type="integer")
     * @var int
     */
    protected $head_count;

    /**
     * @return bool
     */
    public function hasLocation(){
        return $this->getLocationId() > 0;
    }

    /**
     * @return int
     */
    public function getLocationId()
    {
        try {
            return !is_null($this->location)? $this->location->getId():0;
        }
        catch(\Exception $ex){
            return 0;
        }
    }

    /**
     * @param DateTime $value
     * @return $this
     */
    public function setStartDate(DateTime $value)
    {
        $summit = $this->getSummit();
        if(!is_null($summit))
        {
            $value = $summit->convertDateFromTimeZone2UTC($value);
        }
        $this->start_date = $value;
        return $this;
    }

    /**
     * @return DateTime|null
     */
    public function getLocalStartDate()
    {
        if(!empty($this->start_date)) {
            $value  = clone $this->start_date;
            $summit = $this->getSummit();
            if(!is_null($summit))
            {
                $res = $summit->convertDateFromUTC2TimeZone($value);
            }
            return $res;
        }
        return null;
    }

    /**
     * @return \DateTime|null
     */
    public function getStartDate()
    {
        return $this->start_date;
    }

    /**
     * @param DateTime $value
     * @return $this
     */
    public function setEndDate(DateTime $value)
    {
        $summit = $this->getSummit();
        if(!is_null($summit))
        {
            $value = $summit->convertDateFromTimeZone2UTC($value);
        }
        $this->end_date = $value;
        return $this;
    }

    /**
     * @return DateTime|null
     */
    public function getLocalEndDate()
    {
        if(!empty($this->end_date)) {
            $value  = clone $this->end_date;
            $summit = $this->getSummit();
            if(!is_null($summit))
            {
                $res = $summit->convertDateFromUTC2TimeZone($value);
            }
            return $res;
        }
        return null;
    }

    /**
     * @return \DateTime|null
     */
    public function getEndDate()
    {
       return $this->end_date;
    }

    /**
     * @param bool $allow_feeback
     * @return $this
     */
    public function setAllowFeedBack($allow_feeback)
    {
        $this->allow_feedback = $allow_feeback;
        return $this;
    }

    /**
     * @return int
     */
    public function getTypeId()
    {
        try {
            return $this->type->getId();
        }
        catch(\Exception $ex){
            return 0;
        }
    }

    /**
     * @ORM\ManyToOne(targetEntity="SummitEventType")
     * @ORM\JoinColumn(name="TypeID", referencedColumnName="ID")
     * @var SummitEventType
     */
    private $type;

    /**
     * @param SummitEventType $type
     * @return $this
     */
    public function setType(SummitEventType $type)
    {
        $this->type = $type;
        return $this;
    }

    /**
     * @return SummitEventType
     */
    public function getType(){
        return $this->type;
    }

    /**
     * @ORM\ManyToOne(targetEntity="SummitAbstractLocation")
     * @ORM\JoinColumn(name="LocationID", referencedColumnName="ID")
     */
    private $location = null;

    /**
     * @param SummitAbstractLocation $location
     * @return $this
     */
    public function setLocation(SummitAbstractLocation $location)
    {
        $this->location = $location;
        return $this;
    }

    /**
     * @return SummitAbstractLocation
     */
    public function getLocation()
    {
        return $this->location;
    }

    /**
     * @return array
     */
    public function getSummitTypesIds()
    {
        return $this->summit_types->map(function($entity)  {
            return $entity->getId();
        })->toArray();
    }

    /**
     * @return array
     */
    public function getSponsorsIds()
    {
        return $this->sponsors->map(function($entity)  {
            return $entity->getId();
        })->toArray();
    }

    /**
     * @ORM\ManyToMany(targetEntity="models\summit\SummitType")
     * @ORM\JoinTable(name="SummitEvent_AllowedSummitTypes",
     *      joinColumns={@ORM\JoinColumn(name="SummitEventID", referencedColumnName="ID")},
     *      inverseJoinColumns={@ORM\JoinColumn(name="SummitTypeID", referencedColumnName="ID")}
     *      )
     */
    protected $summit_types;

    /**
     * @return ArrayCollection
     */
    public function getSummitTypes(){
        return $this->summit_types;
    }

    /**
     * @param SummitType $summit_type
     */
    public function addSummitType(SummitType $summit_type)
    {
        $this->summit_types->add($summit_type);
    }

    public function clearSummitTypes()
    {
        $this->summit_types->clear();
    }

    /**
     * @ORM\ManyToMany(targetEntity="models\main\Company", inversedBy="sponsorships")
     * @ORM\JoinTable(name="SummitEvent_Sponsors",
     *      joinColumns={@ORM\JoinColumn(name="SummitEventID", referencedColumnName="ID")},
     *      inverseJoinColumns={@ORM\JoinColumn(name="CompanyID", referencedColumnName="ID")}
     *      )
     */
    protected $sponsors;

    /**
     * @return Company[]
     */
    public function getSponsors()
    {
        return $this->sponsors;
    }

    /**
     * @ORM\ManyToMany(targetEntity="models\summit\SummitAttendee")
     * @ORM\JoinTable(name="SummitAttendee_Schedule",
     *      joinColumns={@ORM\JoinColumn(name="SummitEventID", referencedColumnName="ID")},
     *      inverseJoinColumns={@ORM\JoinColumn(name="SummitAttendeeID", referencedColumnName="ID")}
     *      )
     */
    protected $attendees;

    /**
     * @return SummitAttendee[]
     */
    public function getAttendees()
    {
        $criteria = Criteria::create();
        $criteria->where(Criteria::expr()->eq('IsCheckedIn', 1));
        return $this->attendees->matching($criteria);
    }

    /**
     * @ORM\OneToMany(targetEntity="models\summit\SummitEventFeedback", mappedBy="event", cascade={"persist"})
     * @ORM\Cache("NONSTRICT_READ_WRITE")
     * @var SummitEventFeedback[]
     */
    protected $feedback;

    public function addFeedBack(SummitEventFeedback $feedback)
    {
       $this->feedback->add($feedback);
       $feedback->setEvent($this);
    }

    /**
     * @return SummitEventFeedback[]
     */
    public function getFeedback(){
        $criteria = Criteria::create();
        $criteria = $criteria->orderBy(['created' => Criteria::DESC]);
        return $this->feedback->matching($criteria);
    }

    /**
     * @ORM\ManyToMany(targetEntity="models\main\Tag", cascade={"persist"})
     * @ORM\JoinTable(name="SummitEvent_Tags",
     *      joinColumns={@ORM\JoinColumn(name="SummitEventID", referencedColumnName="ID")},
     *      inverseJoinColumns={@ORM\JoinColumn(name="TagID", referencedColumnName="ID")}
     *      )
     */
    protected $tags;

    /**
     * @return ArrayCollection
     */
    public function getTags(){
        return $this->tags;
    }

    /**
     * @param Tag $tag
     */
    public function addTag(Tag $tag)
    {
        $this->tags->add($tag);
    }

    public function clearTags()
    {
        $this->tags->clear();
    }

    /**
     * @throws EntityValidationException
     * @throws ValidationException
     * @return void
     */
    public function publish()
    {
        if($this->isPublished())
            throw new ValidationException('Already published Summit Event');

        if($this->getSummitTypes()->count() === 0)
            throw new EntityValidationException('To publish this event you must associate a valid summit type!');

        $start_date = $this->getStartDate();
        $end_date   = $this->getEndDate();

        if((is_null($start_date) || is_null($end_date)))
            throw new ValidationException('To publish this event you must define a start/end datetime!');

        $summit = $this->getSummit();

        if(is_null($summit))
            throw new ValidationException('To publish you must assign a summit');

        $timezone = $summit->getTimeZoneId();

        if(empty($timezone)){
            throw new ValidationException('Invalid Summit TimeZone!');
        }

        if($end_date < $start_date)
            throw new ValidationException('start datetime must be greather or equal than end datetime!');

        if(!$summit->isEventInsideSummitDuration($this))
            throw new ValidationException
            (
                sprintf
                (
                    'start/end datetime must be between summit start/end datetime! (%s - %s)',
                    $summit->getLocalBeginDate(),
                    $summit->getLocalEndDate()
                )
            );

        $this->published      = true;
        $this->published_date = new DateTime();
    }

    /**
     * @return bool
     */
    public function isPublished()
    {
        return $this->getPublished();
    }

    /**
     * @return bool
     */
    public function getPublished()
    {
        return  (bool)$this->published;
    }

    /**
     * @return void
     */
    public function unPublish()
    {
        $this->published     = false;
        $this->published_date = null;
    }

    // events

    /**
     * @var PreRemoveEventArgs
     */
    private $pre_remove_events;
    /**
     * @ORM\PreRemove:
     */
    public function deleting($args){
        $this->pre_remove_events = new PreRemoveEventArgs(['id' => $this->id, 'class_name' => $this->getClassName(), 'summit' => $this->summit ]);
    }

    /**
     * @ORM\PostRemove:
     */
    public function deleted($args){
        Event::fire(new SummitEventDeleted($this,  $this->pre_remove_events ));
        $this->pre_remove_events = null;
    }

    /**
     * @var PreUpdateEventArgs
     */
    private $pre_update_args;

    /**
     * @ORM\PreUpdate:
     */
    public function updating(PreUpdateEventArgs $args){
        $this->pre_update_args = $args;
    }

    /**
     * @ORM\PostUpdate:
     */
    public function updated($args)
    {
        Event::fire(new SummitEventUpdated($this, $this->pre_update_args));
        $this->pre_update_args = null;
    }

    /**
     * @ORM\PostPersist
     */
    public function inserted($args){
        Event::fire(new SummitEventCreated($this, $args));
    }

    public function hasMetricsAvailable(){
        if(is_null($this->location)) return false;
        if(!$this->location instanceof SummitVenueRoom) return false;
        return $this->location->getMetrics()->count() > 0;
    }

    /**
     * @return SummitEventMetricsSnapshot[]
     */
    public function getMetricsSnapShots(){
        $snapshots = [];
        if(is_null($this->location)) return $snapshots;
        if(!$this->location instanceof SummitVenueRoom) return $snapshots;
        foreach($this->location->getMetrics() as $metric){
            $snapshot =  $this->getMetricsValuesByType($metric);
            if(is_null($snapshot)) continue;
            $snapshots[] = $snapshot;
        }
        return $snapshots;
    }

    /**
     * @param int $type_id
     * @return SummitEventMetricsSnapshot
     */
    public function getMetricValuesByTypeId($type_id){

        $metrics = [];
        if(is_null($this->location)) return $metrics;
        if(!$this->location instanceof SummitVenueRoom) return $metrics;

        $metric_type = $this->location->getMetricsByType($type_id);
        if(is_null($metric_type)) return $metrics;
        if(!$metric_type instanceof RoomMetricType) return $metrics;

        return $this->getMetricsValuesByType($metric_type);
    }

    /**
     * @param RoomMetricType $type
     * @return SummitEventMetricsSnapshot
     */
    private function getMetricsValuesByType(RoomMetricType $type){

        $epoch_start_date = $this->getStartDate()->getTimestamp();
        $epoch_end_date   = $this->getEndDate()->getTimestamp();

        return new SummitEventMetricsSnapshot
        (
            $this,
            $type,
            $type->getMeanValueByTimeWindow($epoch_start_date, $epoch_end_date),
            $type->getMaxValueByTimeWindow($epoch_start_date, $epoch_end_date),
            $type->getMinValueByTimeWindow($epoch_start_date, $epoch_end_date),
            $type->getCurrentValueByTimeWindow($epoch_start_date, $epoch_end_date)
        );
    }

}