smtech / canvas-ics-sync

src/SyncIntoCanvas/Calendar.php

Doc Comments +3 added lines

@@ -323,6 +323,9 @@
         $this->log(static::getTimestamp() . ' sync finished', $log);
     }
 
+    /**
+     * @param string $message
+     */
     private function log($message, Log $log, $flag = PEAR_LOG_INFO)
     {
         if ($log) {

Unused Use Statements -1 removed lines

@@ -2,7 +2,6 @@
 
 namespace smtech\CanvasICSSync\SyncIntoCanvas;
 
-use DateTime;
 use vcalendar;
 use Battis\DataUtilities;
 

Indentation +267 added lines, -267 removed lines

@@ -8,171 +8,171 @@ 
 
 class Calendar
 {
-    /**
-     * Canvas calendar context
-     * @var CalendarContext
-     */
-    protected $context;
+	/**
+	 * Canvas calendar context
+	 * @var CalendarContext
+	 */
+	protected $context;
 
-    /**
-     * ICS or webcal feed URL
-     * @var string
-     */
-    protected $feedUrl;
+	/**
+	 * ICS or webcal feed URL
+	 * @var string
+	 */
+	protected $feedUrl;
 
-    /**
-     * Name of this calendar (extracted from feed)
-     * @var string
-     */
-    protected $name;
+	/**
+	 * Name of this calendar (extracted from feed)
+	 * @var string
+	 */
+	protected $name;
 
-    /**
-     * Filter for events in this calendar
-     * @var Filter
-     */
-    protected $filter;
+	/**
+	 * Filter for events in this calendar
+	 * @var Filter
+	 */
+	protected $filter;
 
-    /**
-     * Construct a Calendar object
-     *
-     * @param string $canvasUrl URL of a Canvas calendar context
-     * @param string $feedUrl URL of a webcal or ICS calendar feed
-     * @param boolean $enableFilter (Optional, default `false`)
-     * @param string $include (Optional) Regular expression to select events
-     *     for inclusion in the calendar sync
-     * @param string $exclude (Optional) Regular expression to select events
-     *     for exclusion from the calendar sync
-     */
-    public function __construct($canvasUrl, $feedUrl, $enableFilter = false, $include = null, $exclude = null)
-    {
-        $this->setContext(new CalendarContext($canvasUrl));
-        $this->setFeed($feedUrl);
-        $this->setFilter(new Filter(
-            $enableFilter,
-            $include,
-            $exclude
-        ));
-    }
+	/**
+	 * Construct a Calendar object
+	 *
+	 * @param string $canvasUrl URL of a Canvas calendar context
+	 * @param string $feedUrl URL of a webcal or ICS calendar feed
+	 * @param boolean $enableFilter (Optional, default `false`)
+	 * @param string $include (Optional) Regular expression to select events
+	 *     for inclusion in the calendar sync
+	 * @param string $exclude (Optional) Regular expression to select events
+	 *     for exclusion from the calendar sync
+	 */
+	public function __construct($canvasUrl, $feedUrl, $enableFilter = false, $include = null, $exclude = null)
+	{
+		$this->setContext(new CalendarContext($canvasUrl));
+		$this->setFeed($feedUrl);
+		$this->setFilter(new Filter(
+			$enableFilter,
+			$include,
+			$exclude
+		));
+	}
 
-    /**
-     * Set the Canvas calendar context
-     *
-     * @param CalendarContext $context
-     * @throws Exception If `$context` is null
-     */
-    public function setContext(CalendarContext $context)
-    {
-        if (!empty($context)) {
-            $this->context = $context;
-        } else {
-            throw new Exception(
-                'Context cannot be null'
-            );
-        }
-    }
+	/**
+	 * Set the Canvas calendar context
+	 *
+	 * @param CalendarContext $context
+	 * @throws Exception If `$context` is null
+	 */
+	public function setContext(CalendarContext $context)
+	{
+		if (!empty($context)) {
+			$this->context = $context;
+		} else {
+			throw new Exception(
+				'Context cannot be null'
+			);
+		}
+	}
 
-    /**
-     * Get the Canvas calendar context
-     *
-     * @return CalendarContext
-     */
-    public function getContext()
-    {
-        return $this->context;
-    }
+	/**
+	 * Get the Canvas calendar context
+	 *
+	 * @return CalendarContext
+	 */
+	public function getContext()
+	{
+		return $this->context;
+	}
 
-    /**
-     * Set the webcal or ICS feed URl for this calendar
-     *
-     * @param string $feedUrl
-     * @throws Exception If `$feedUrl` is not a valid URL
-     */
-    public function setFeedUrl($feedUrl)
-    {
-        if (!empty($feedUrl)) {
-            /* crude test to see if the feed is a valid URL */
-            $handle = fopen($feedUrl, 'r');
-            if ($handle !== false) {
-                $this->feedUrl = $feedUrl;
-            }
-        }
-        throw new Exception(
-            'Feed must be a valid URL'
-        );
-    }
+	/**
+	 * Set the webcal or ICS feed URl for this calendar
+	 *
+	 * @param string $feedUrl
+	 * @throws Exception If `$feedUrl` is not a valid URL
+	 */
+	public function setFeedUrl($feedUrl)
+	{
+		if (!empty($feedUrl)) {
+			/* crude test to see if the feed is a valid URL */
+			$handle = fopen($feedUrl, 'r');
+			if ($handle !== false) {
+				$this->feedUrl = $feedUrl;
+			}
+		}
+		throw new Exception(
+			'Feed must be a valid URL'
+		);
+	}
 
-    /**
-     * Get the feed URL for this calendar
-     *
-     * @return string
-     */
-    public function getFeedUrl()
-    {
-        return $this->feedUrl;
-    }
+	/**
+	 * Get the feed URL for this calendar
+	 *
+	 * @return string
+	 */
+	public function getFeedUrl()
+	{
+		return $this->feedUrl;
+	}
 
-    /**
-     * Set the name of the calendar
-     *
-     * @param string $name
-     */
-    public function setName($name)
-    {
-        $this->name = (string) $name;
-    }
+	/**
+	 * Set the name of the calendar
+	 *
+	 * @param string $name
+	 */
+	public function setName($name)
+	{
+		$this->name = (string) $name;
+	}
 
-    /**
-     * Get the name of the calendar
-     *
-     * @return string
-     */
-    public function getName()
-    {
-        return $this->name;
-    }
+	/**
+	 * Get the name of the calendar
+	 *
+	 * @return string
+	 */
+	public function getName()
+	{
+		return $this->name;
+	}
 
-    /**
-     * Set the regular expression filter for this calendar
-     *
-     * @param Filter $filter
-     */
-    public function setFilter(Filter $filter)
-    {
-        $this->filter = $filter;
-    }
+	/**
+	 * Set the regular expression filter for this calendar
+	 *
+	 * @param Filter $filter
+	 */
+	public function setFilter(Filter $filter)
+	{
+		$this->filter = $filter;
+	}
 
-    /**
-     * Get the regular expression filter for this calendar
-     *
-     * @return Filter
-     */
-    public function getFilter()
-    {
-        return $this->filter;
-    }
+	/**
+	 * Get the regular expression filter for this calendar
+	 *
+	 * @return Filter
+	 */
+	public function getFilter()
+	{
+		return $this->filter;
+	}
 
-    /**
-     * Generate a unique ID to identify this particular pairing of ICS feed and
-     * Canvas calendar
-     **/
-    protected function getId($algorithm = 'md5')
-    {
-        return hash($algorithm, $this->getContext()->getCanonicalUrl() . $this->getFeedUrl());
-    }
+	/**
+	 * Generate a unique ID to identify this particular pairing of ICS feed and
+	 * Canvas calendar
+	 **/
+	protected function getId($algorithm = 'md5')
+	{
+		return hash($algorithm, $this->getContext()->getCanonicalUrl() . $this->getFeedUrl());
+	}
 
-    public function getContextCode()
-    {
-        return $this->getContext()->getContext() . '_' . $this->getContext()->getId();
-    }
+	public function getContextCode()
+	{
+		return $this->getContext()->getContext() . '_' . $this->getContext()->getId();
+	}
 
-    public function save()
-    {
-        $db = static::getDatabase();
-        $find = $db->prepare(
-            "SELECT * FROM `calendars` WHERE `id` = :id"
-        );
-        $update = $db->prepare(
-            "UPDATE `calendars`
+	public function save()
+	{
+		$db = static::getDatabase();
+		$find = $db->prepare(
+			"SELECT * FROM `calendars` WHERE `id` = :id"
+		);
+		$update = $db->prepare(
+			"UPDATE `calendars`
                 SET
                     `name` = :name,
                     `canvas_url` = :canvas_url,
@@ -183,9 +183,9 @@ 
                     `exclude_regexp` = :exclude_regexp
                 WHERE
                 `id` = :id"
-        );
-        $insert = $db->prepare(
-            "INSERT INTO `calendars`
+		);
+		$insert = $db->prepare(
+			"INSERT INTO `calendars`
                 (
                     `id`,
                     `name`,
@@ -205,140 +205,140 @@ 
                     :include_regexp,
                     :exclude_regexp
                 )"
-        );
-        $params = [
-            'id' => $this->getPairingHash(),
-            'name' => $this->getName(),
-            'canvas_url' => $this->getContext()->getCanonicalUrl(),
-            'ics_url' => $this->getFeedUrl(),
-            'synced' => static::getSyncTimestamp(),
-            'enable_regex_filter' => $this->getFilter()->isEnabled(),
-            'include_regexp' => $this->getFilter()->getIncludeExpression(),
-            'exclude_regexp' => $this->getFilter()->getExcludeExpression()
-        ];
+		);
+		$params = [
+			'id' => $this->getPairingHash(),
+			'name' => $this->getName(),
+			'canvas_url' => $this->getContext()->getCanonicalUrl(),
+			'ics_url' => $this->getFeedUrl(),
+			'synced' => static::getSyncTimestamp(),
+			'enable_regex_filter' => $this->getFilter()->isEnabled(),
+			'include_regexp' => $this->getFilter()->getIncludeExpression(),
+			'exclude_regexp' => $this->getFilter()->getExcludeExpression()
+		];
 
-        $find->execute($params);
-        if ($find->fetch() !== false) {
-            $update->execute($params);
-        } else {
-            $insert->execute($params);
-        }
-    }
+		$find->execute($params);
+		if ($find->fetch() !== false) {
+			$update->execute($params);
+		} else {
+			$insert->execute($params);
+		}
+	}
 
-    /**
-     * Load a Calendar from the database
-     *
-     * @param int $id
-     * @return Calendar
-     */
-    public static function load($id)
-    {
-        $find = static::getDatabase()->prepare(
-            "SELECT * FROM `calendars` WHERE `id` = :id"
-        );
-        $find->execute($id);
-        if (($calendar = $find->fetch()) !== false) {
-            return new Calendar(
-                $calendar['canvas_url'],
-                $calendar['ics_url'],
-                $calendar['enable_regex_filter'],
-                $calendar['include_regexp'],
-                $calendar['exclude_regexp']
-            );
-        }
-        return null;
-    }
+	/**
+	 * Load a Calendar from the database
+	 *
+	 * @param int $id
+	 * @return Calendar
+	 */
+	public static function load($id)
+	{
+		$find = static::getDatabase()->prepare(
+			"SELECT * FROM `calendars` WHERE `id` = :id"
+		);
+		$find->execute($id);
+		if (($calendar = $find->fetch()) !== false) {
+			return new Calendar(
+				$calendar['canvas_url'],
+				$calendar['ics_url'],
+				$calendar['enable_regex_filter'],
+				$calendar['include_regexp'],
+				$calendar['exclude_regexp']
+			);
+		}
+		return null;
+	}
 
-    public function sync(Log $log)
-    {
-        try {
-            $api->get($this->getContext()->getVerificationUrl());
-        } catch (Exception $e) {
-            $this->logThrow(new Exception("Cannot sync calendars without a valid Canvas context"), $log);
-        }
+	public function sync(Log $log)
+	{
+		try {
+			$api->get($this->getContext()->getVerificationUrl());
+		} catch (Exception $e) {
+			$this->logThrow(new Exception("Cannot sync calendars without a valid Canvas context"), $log);
+		}
 
-        if (!DataUtilities::URLexists($this>getFeedUrl())) {
-            $this->logThrow(new Exception("Cannot sync calendars with a valid calendar feed"), $log);
-        }
+		if (!DataUtilities::URLexists($this>getFeedUrl())) {
+			$this->logThrow(new Exception("Cannot sync calendars with a valid calendar feed"), $log);
+		}
 
-        $this->log(static::getTimestamp() . ' sync started', $log);
+		$this->log(static::getTimestamp() . ' sync started', $log);
 
-        $this->save();
+		$this->save();
 
-        $ics = new vcalendar([
-            'unique_id' => __FILE__,
-            'url' => $this->getFeedUrl()
-        ]);
-        $ics->parse();
+		$ics = new vcalendar([
+			'unique_id' => __FILE__,
+			'url' => $this->getFeedUrl()
+		]);
+		$ics->parse();
 
-        /*
+		/*
          * TODO: would it be worth the performance improvement to just process
          *     things from today's date forward? (i.e. ignore old items, even
          *     if they've changed...)
          */
-        /*
+		/*
          * TODO:0 the best window for syncing would be the term of the course
          *     in question, right? issue:12
          */
-        /*
+		/*
          * TODO:0 Arbitrarily selecting events in for a year on either side of
          *     today's date, probably a better system? issue:12
          */
-        foreach ($ics->selectComponents(
-            date('Y')-1, // startYear
-            date('m'), // startMonth
-            date('d'), // startDay
-            date('Y')+1, // endYEar
-            date('m'), // endMonth
-            date('d'), // endDay
-            'vevent', // cType
-            false, // flat
-            true, // any
-            true // split
-        ) as $year) {
-            foreach ($year as $month => $days) {
-                foreach ($days as $day => $events) {
-                    foreach ($events as $i => $_event) {
-                        try {
-                            $event = new Event($_event, $this);
-                            if ($this->getFilter()->filter($event)) {
-                                $event->save();
-                            } else {
-                                $event->delete();
-                            }
-                        } catch (Exception $e) {
-                            $this->logThrow($e, $log);
-                        }
-                    }
-                }
-            }
-        }
+		foreach ($ics->selectComponents(
+			date('Y')-1, // startYear
+			date('m'), // startMonth
+			date('d'), // startDay
+			date('Y')+1, // endYEar
+			date('m'), // endMonth
+			date('d'), // endDay
+			'vevent', // cType
+			false, // flat
+			true, // any
+			true // split
+		) as $year) {
+			foreach ($year as $month => $days) {
+				foreach ($days as $day => $events) {
+					foreach ($events as $i => $_event) {
+						try {
+							$event = new Event($_event, $this);
+							if ($this->getFilter()->filter($event)) {
+								$event->save();
+							} else {
+								$event->delete();
+							}
+						} catch (Exception $e) {
+							$this->logThrow($e, $log);
+						}
+					}
+				}
+			}
+		}
 
-        try {
-            Event::purgeUnmatched(static::getTimestamp(), $this);
-        } catch (Exception $e) {
-            $this->logThrow($e, $log);
-        }
+		try {
+			Event::purgeUnmatched(static::getTimestamp(), $this);
+		} catch (Exception $e) {
+			$this->logThrow($e, $log);
+		}
 
-        $this->log(static::getTimestamp() . ' sync finished', $log);
-    }
+		$this->log(static::getTimestamp() . ' sync finished', $log);
+	}
 
-    private function log($message, Log $log, $flag = PEAR_LOG_INFO)
-    {
-        if ($log) {
-            $log->log($message, $flag);
-        }
-    }
+	private function log($message, Log $log, $flag = PEAR_LOG_INFO)
+	{
+		if ($log) {
+			$log->log($message, $flag);
+		}
+	}
 
-    private function logThrow(
-        Exception $exception,
-        Log $log,
-        $flag = PEAR_LOG_ERR
-    ) {
-        if ($log) {
-            $log->log($e->getMessage() . ': ' . $e->getTraceAsString(), $flag);
-        } else {
-            throw $e;
-        }
-    }
+	private function logThrow(
+		Exception $exception,
+		Log $log,
+		$flag = PEAR_LOG_ERR
+	) {
+		if ($log) {
+			$log->log($e->getMessage() . ': ' . $e->getTraceAsString(), $flag);
+		} else {
+			throw $e;
+		}
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -118,7 +118,7 @@ 
      */
     public function setName($name)
     {
-        $this->name = (string) $name;
+        $this->name = (string)$name;
     }
 
     /**
@@ -157,12 +157,12 @@ 
      **/
     protected function getId($algorithm = 'md5')
     {
-        return hash($algorithm, $this->getContext()->getCanonicalUrl() . $this->getFeedUrl());
+        return hash($algorithm, $this->getContext()->getCanonicalUrl().$this->getFeedUrl());
     }
 
     public function getContextCode()
     {
-        return $this->getContext()->getContext() . '_' . $this->getContext()->getId();
+        return $this->getContext()->getContext().'_'.$this->getContext()->getId();
     }
 
     public function save()
@@ -257,11 +257,11 @@ 
             $this->logThrow(new Exception("Cannot sync calendars without a valid Canvas context"), $log);
         }
 
-        if (!DataUtilities::URLexists($this>getFeedUrl())) {
+        if (!DataUtilities::URLexists($this > getFeedUrl())) {
             $this->logThrow(new Exception("Cannot sync calendars with a valid calendar feed"), $log);
         }
 
-        $this->log(static::getTimestamp() . ' sync started', $log);
+        $this->log(static::getTimestamp().' sync started', $log);
 
         $this->save();
 
@@ -285,10 +285,10 @@ 
          *     today's date, probably a better system? issue:12
          */
         foreach ($ics->selectComponents(
-            date('Y')-1, // startYear
+            date('Y') - 1, // startYear
             date('m'), // startMonth
             date('d'), // startDay
-            date('Y')+1, // endYEar
+            date('Y') + 1, // endYEar
             date('m'), // endMonth
             date('d'), // endDay
             'vevent', // cType
@@ -320,7 +320,7 @@ 
             $this->logThrow($e, $log);
         }
 
-        $this->log(static::getTimestamp() . ' sync finished', $log);
+        $this->log(static::getTimestamp().' sync finished', $log);
     }
 
     private function log($message, Log $log, $flag = PEAR_LOG_INFO)
@@ -336,7 +336,7 @@ 
         $flag = PEAR_LOG_ERR
     ) {
         if ($log) {
-            $log->log($e->getMessage() . ': ' . $e->getTraceAsString(), $flag);
+            $log->log($e->getMessage().': '.$e->getTraceAsString(), $flag);
         } else {
             throw $e;
         }

src/SyncIntoCanvas/Event.php

Doc Comments +3 added lines

@@ -204,6 +204,9 @@
         }
     }
 
+    /**
+     * @param Calendar $calendar
+     */
     public static function purgeUnmatched($timestamp, $calendar)
     {
         $db = static::getDatabase();

Indentation +201 added lines, -201 removed lines

@@ -8,123 +8,123 @@ 
 
 class Event extends Syncable
 {
-    /*
+	/*
      * TODO:0 Can we detect the timezone for the Canvas instance and use it? issue:18
      */
-    const LOCAL_TIMEZONE = 'US/Eastern';
-    const CANVAS_TIMESTAMP_FORMAT = 'Y-m-d\TH:iP';
-
-    const FIELD_MAP = [
-        'calendar_event[title]' => 'SUMMARY',
-        'calendar_event[description]' => 'DESCRIPTION',
-        'calendar_event[start_at]' => [
-            0 => 'X-CURRENT-DTSTART',
-            1 => 'DTSTART'
-        ],
-        'calendar_event[end_at]' => [
-            0 => 'X-CURRENT-DTEND',
-            1 => 'DTEND'
-        ],
-        'calendar_event[location_name]' => 'LOCATION'
-    ];
-
-    /**
-     * VEVENT
-     * @var vevent
-     */
-    protected $vevent;
-
-    /**
-     * Calendar
-     * @var Calendar
-     */
-    protected $calendar;
-
-    /**
-     * Unique hash identifying this version of this event
-     * @var string
-     */
-    protected $hash;
-
-    protected $canvasId;
-
-    public function __construct(vevent $vevent, Calendar $calendar)
-    {
-        if (empty($vevent)) {
-            throw new Exception(
-                'Valid VEVENT required'
-            );
-        }
-        $this->vevent = $vevent;
-
-        if (empty($calendar)) {
-            throw new Exception(
-                'Valid Calendar required'
-            );
-        }
-        $this->calendar = $calendar;
-
-        $this->getHash();
-    }
-
-    public function getProperty($property)
-    {
-        return (empty($this->vevent) ? false : $this->vevent->getProperty($property));
-    }
-
-    public function getCalendar()
-    {
-        return $this->calendar;
-    }
-
-    /**
-     * Generate a hash of this version of an event to cache in the database
-     **/
-    public function getHash($algorithm = 'md5')
-    {
-        if (empty($this->hash)) {
-            $blob = '';
-            foreach (static::$FIELD_MAP as $field) {
-                if (is_array($field)) {
-                    foreach ($field as $option) {
-                        if (!empty($property = $this->getProperty($option))) {
-                            $blob .= serialize($property);
-                            break;
-                        }
-                    }
-                } else {
-                    if (!empty($property = $this->getProperty($field))) {
-                        $blob .= serialize($property);
-                    }
-                }
-            }
-            $this->hash = hash($algorithm, $blob);
-        }
-        return $this->hash;
-    }
-
-    public function save()
-    {
-        $db = static::getDatabase();
-        $api = static::getApi();
-
-        $select = $db->prepare(
-            "SELECT *
+	const LOCAL_TIMEZONE = 'US/Eastern';
+	const CANVAS_TIMESTAMP_FORMAT = 'Y-m-d\TH:iP';
+
+	const FIELD_MAP = [
+		'calendar_event[title]' => 'SUMMARY',
+		'calendar_event[description]' => 'DESCRIPTION',
+		'calendar_event[start_at]' => [
+			0 => 'X-CURRENT-DTSTART',
+			1 => 'DTSTART'
+		],
+		'calendar_event[end_at]' => [
+			0 => 'X-CURRENT-DTEND',
+			1 => 'DTEND'
+		],
+		'calendar_event[location_name]' => 'LOCATION'
+	];
+
+	/**
+	 * VEVENT
+	 * @var vevent
+	 */
+	protected $vevent;
+
+	/**
+	 * Calendar
+	 * @var Calendar
+	 */
+	protected $calendar;
+
+	/**
+	 * Unique hash identifying this version of this event
+	 * @var string
+	 */
+	protected $hash;
+
+	protected $canvasId;
+
+	public function __construct(vevent $vevent, Calendar $calendar)
+	{
+		if (empty($vevent)) {
+			throw new Exception(
+				'Valid VEVENT required'
+			);
+		}
+		$this->vevent = $vevent;
+
+		if (empty($calendar)) {
+			throw new Exception(
+				'Valid Calendar required'
+			);
+		}
+		$this->calendar = $calendar;
+
+		$this->getHash();
+	}
+
+	public function getProperty($property)
+	{
+		return (empty($this->vevent) ? false : $this->vevent->getProperty($property));
+	}
+
+	public function getCalendar()
+	{
+		return $this->calendar;
+	}
+
+	/**
+	 * Generate a hash of this version of an event to cache in the database
+	 **/
+	public function getHash($algorithm = 'md5')
+	{
+		if (empty($this->hash)) {
+			$blob = '';
+			foreach (static::$FIELD_MAP as $field) {
+				if (is_array($field)) {
+					foreach ($field as $option) {
+						if (!empty($property = $this->getProperty($option))) {
+							$blob .= serialize($property);
+							break;
+						}
+					}
+				} else {
+					if (!empty($property = $this->getProperty($field))) {
+						$blob .= serialize($property);
+					}
+				}
+			}
+			$this->hash = hash($algorithm, $blob);
+		}
+		return $this->hash;
+	}
+
+	public function save()
+	{
+		$db = static::getDatabase();
+		$api = static::getApi();
+
+		$select = $db->prepare(
+			"SELECT *
                 FROM `events`
                 WHERE
                     `event_hash` = :event_hash AND
                     `calendar` = :calendar"
-        );
-        $update = $db->prepare(
-            "UPDATE `events`
+		);
+		$update = $db->prepare(
+			"UPDATE `events`
                 SET
                     `synced` = :synced
                 WHERE
                     `event_hash` = :event_hash AND
                     `calendar` = :calendar"
-        );
-        $insert = $db->prepare(
-            "INSERT INTO `events`
+		);
+		$insert = $db->prepare(
+			"INSERT INTO `events`
                 (
                     `calendar`,
                     `calendar_event[id]`,
@@ -136,114 +136,114 @@ 
                     :event_hash,
                     :synced
                 )"
-        );
-
-        $params = [
-            'calendar' => $this->getCalendar()->getId(),
-            'event_hash' => $this->getHash(),
-            'synced' => static::getTimestamp()
-        ];
-
-        $select->execute($params);
-        if ($select->fetch() !== false) {
-            $update->execute($params);
-        } else {
-            /*
+		);
+
+		$params = [
+			'calendar' => $this->getCalendar()->getId(),
+			'event_hash' => $this->getHash(),
+			'synced' => static::getTimestamp()
+		];
+
+		$select->execute($params);
+		if ($select->fetch() !== false) {
+			$update->execute($params);
+		} else {
+			/*
              * FIXME: how sure are we of this? issue:14
              */
-            /*
+			/*
              * multi-day event instance start times need to be changed to
              * _this_ date
              */
-            $start = new DateTime(
-                iCalUtilityFunctions::_date2strdate(
-                    $this->getProperty('DTSTART')
-                )
-            );
-            $end = new DateTime(
-                iCalUtilityFunctions::_date2strdate(
-                    $this->getProperty('DTEND')
-                )
-            );
-            if ($this->getProperty('X-RECURRENCE')) {
-                $start = new DateTime($this->getProperty('X-CURRENT-DTSTART')[1]);
-                $end = new DateTime($this->getProperty('X-CURRENT-DTEND')[1]);
-            }
-            $start->setTimeZone(new DateTimeZone(self::LOCAL_TIMEZONE));
-            $end->setTimeZone(new DateTimeZone(self::LOCAL_TIMEZONE));
-
-            $calendarEvent = $api->post(
-                "/calendar_events",
-                [
-                    'calendar_event' => [
-                        'context_code' => $this->getCalendar()->getContextCode(),
-                        /*
+			$start = new DateTime(
+				iCalUtilityFunctions::_date2strdate(
+					$this->getProperty('DTSTART')
+				)
+			);
+			$end = new DateTime(
+				iCalUtilityFunctions::_date2strdate(
+					$this->getProperty('DTEND')
+				)
+			);
+			if ($this->getProperty('X-RECURRENCE')) {
+				$start = new DateTime($this->getProperty('X-CURRENT-DTSTART')[1]);
+				$end = new DateTime($this->getProperty('X-CURRENT-DTEND')[1]);
+			}
+			$start->setTimeZone(new DateTimeZone(self::LOCAL_TIMEZONE));
+			$end->setTimeZone(new DateTimeZone(self::LOCAL_TIMEZONE));
+
+			$calendarEvent = $api->post(
+				"/calendar_events",
+				[
+					'calendar_event' => [
+						'context_code' => $this->getCalendar()->getContextCode(),
+						/*
                          * TODO this should be configurable issue:5
                          */
-                        /* removing trailing [TAGS] from event title */
-                        'title' => preg_replace(
-                            '%^([^\]]+)(\s*\[[^\]]+\]\s*)+$%',
-                            '\\1',
-                            strip_tags($this->getProperty('SUMMARY'))
-                        ),
-                        'description' => Markdown::defaultTransform(
-                            str_replace(
-                                '\n',
-                                "\n\n",
-                                $this->getProperty('DESCRIPTION', 1)
-                            )
-                        ),
-                        'start_at' => $start->format(self::CANVAS_TIMESTAMP_FORMAT),
-                        'end_at' => $end->format(self::CANVAS_TIMESTAMP_FORMAT),
-                        'location_name' => $this->getProperty('LOCATION')
-                    ]
-                ]
-            );
-            $params['calendar_event_id'] = $calendarEvent['id'];
-            $insert->execute($params);
-        }
-    }
-
-    public static function purgeUnmatched($timestamp, $calendar)
-    {
-        $db = static::getDatabase();
-        $api = static::getApi();
-
-        $findDeletedEvents = $db->prepare(
-            "SELECT *
+						/* removing trailing [TAGS] from event title */
+						'title' => preg_replace(
+							'%^([^\]]+)(\s*\[[^\]]+\]\s*)+$%',
+							'\\1',
+							strip_tags($this->getProperty('SUMMARY'))
+						),
+						'description' => Markdown::defaultTransform(
+							str_replace(
+								'\n',
+								"\n\n",
+								$this->getProperty('DESCRIPTION', 1)
+							)
+						),
+						'start_at' => $start->format(self::CANVAS_TIMESTAMP_FORMAT),
+						'end_at' => $end->format(self::CANVAS_TIMESTAMP_FORMAT),
+						'location_name' => $this->getProperty('LOCATION')
+					]
+				]
+			);
+			$params['calendar_event_id'] = $calendarEvent['id'];
+			$insert->execute($params);
+		}
+	}
+
+	public static function purgeUnmatched($timestamp, $calendar)
+	{
+		$db = static::getDatabase();
+		$api = static::getApi();
+
+		$findDeletedEvents = $db->prepare(
+			"SELECT *
                 FROM `events`
                 WHERE
                     `calendar` = :calendar AND
                     `synced` != :synced"
-        );
-        $deleteCachedEvent = $db->prepare(
-            "DELETE FROM `events` WHERE `id` = :id"
-        );
-
-        $findDeletedEvents->execute([
-            'calendar' => $calendar->getId(),
-            'synced' => $timestamp
-        ]);
-        if (($deletedEvents = $findDeletedEvents->fetchAll()) !== false) {
-            foreach ($deletedEvents as $event) {
-                $params['cancel_reason'] = $timestamp;
-                if ($calendar->getContext()->getContext() == 'user') {
-                    $params['as_user_id'] = $calendar->getContext()->getId();
-                }
-                try {
-                    $api->delete(
-                        "/calendar_events/{$event['calendar_event[id]']}",
-                        $params
-                    );
-                } catch (Pest_Unauthorized $e) {
-                    /*
+		);
+		$deleteCachedEvent = $db->prepare(
+			"DELETE FROM `events` WHERE `id` = :id"
+		);
+
+		$findDeletedEvents->execute([
+			'calendar' => $calendar->getId(),
+			'synced' => $timestamp
+		]);
+		if (($deletedEvents = $findDeletedEvents->fetchAll()) !== false) {
+			foreach ($deletedEvents as $event) {
+				$params['cancel_reason'] = $timestamp;
+				if ($calendar->getContext()->getContext() == 'user') {
+					$params['as_user_id'] = $calendar->getContext()->getId();
+				}
+				try {
+					$api->delete(
+						"/calendar_events/{$event['calendar_event[id]']}",
+						$params
+					);
+				} catch (Pest_Unauthorized $e) {
+					/*
                      * Do nothing: an event was cached that had been deleted
                      * from Canvas -- deleting the cached event is
                      * inconsequential
                      */
-                }
-                $deleteCachedEvent->execute($event['id']);
-            }
-        }
-    }
+				}
+				$deleteCachedEvent->execute($event['id']);
+			}
+		}
+	}
 }

src/SyncIntoCanvas/CalendarContext.php

Indentation +82 added lines, -82 removed lines

@@ -4,106 +4,106 @@
 
 class CalendarContext
 {
-    /**
-     * The canonical URL for this context in Canvas
-     * @var string
-     */
-    protected $canonicalUrl;
+	/**
+	 * The canonical URL for this context in Canvas
+	 * @var string
+	 */
+	protected $canonicalUrl;
 
-    /**
-     * The context for this calendar in Canvas (user, group, course)
-     * @var CanvasContext
-     */
-    protected $context;
+	/**
+	 * The context for this calendar in Canvas (user, group, course)
+	 * @var CanvasContext
+	 */
+	protected $context;
 
-    /**
-     * Unique ID for this Canvas context
-     * @var int
-     */
-    protected $id;
+	/**
+	 * Unique ID for this Canvas context
+	 * @var int
+	 */
+	protected $id;
 
-    /**
-     * URL to verify this context against API
-     * @var string
-     */
-    protected $verificationUrl;
+	/**
+	 * URL to verify this context against API
+	 * @var string
+	 */
+	protected $verificationUrl;
 
-    /**
-     * Compute the calendar context for the canvas object based on its URL
-     *
-     * @param string $canvasUrl URL to the context for a calendar on this
-     *     Canvas instance
-     * @throws Exception If `$canvasInstance` is not a URL on this Canvas
-     *     instance
-     * @throws Exception if `$canvasInstance` is not a URL to a recognizable
-     *     calendar context
-     */
-    public function __construct($canvasUrl)
-    {
-        /*
+	/**
+	 * Compute the calendar context for the canvas object based on its URL
+	 *
+	 * @param string $canvasUrl URL to the context for a calendar on this
+	 *     Canvas instance
+	 * @throws Exception If `$canvasInstance` is not a URL on this Canvas
+	 *     instance
+	 * @throws Exception if `$canvasInstance` is not a URL to a recognizable
+	 *     calendar context
+	 */
+	public function __construct($canvasUrl)
+	{
+		/*
          * TODO: accept calendar2?contexts links too (they would be an intuitively obvious link to use, after all)
          */
-        /*
+		/*
          * FIXME: users aren't working
          */
-        /*
+		/*
          * TODO: it would probably be better to look up users by email address than URL
          */
-        /* get the context (user, course or group) for the canvas URL */
-        if (preg_match('%(https?://)?(' .
-            /*
+		/* get the context (user, course or group) for the canvas URL */
+		if (preg_match('%(https?://)?(' .
+			/*
              * FIXME not clear that we should be using $_SESSION
              */
-            parse_url($_SESSION[CANVAS_INSTANCE_URL], PHP_URL_HOST) . '/((about/(\d+))|(courses/(\d+)(/groups/(\d+))?)|(accounts/\d+/groups/(\d+))))%', $canvasUrl, $match)) {
-            $this->canonicalUrl = "https://{$match[2]}"; // https://stmarksschool.instructure.com/courses/953
+			parse_url($_SESSION[CANVAS_INSTANCE_URL], PHP_URL_HOST) . '/((about/(\d+))|(courses/(\d+)(/groups/(\d+))?)|(accounts/\d+/groups/(\d+))))%', $canvasUrl, $match)) {
+			$this->canonicalUrl = "https://{$match[2]}"; // https://stmarksschool.instructure.com/courses/953
 
-            // course or account groups
-            if (isset($match[9]) || isset($match[11])) {
-                $this->context = CanvasContext::GROUP(); // used for context_code in events
-                $this->id = ($match[9] > $match[11] ? $match[9] : $match[11]);
-                $this->verificationUrl = "groups/{$this->id}"; // used once to look up the object to be sure it really exists
+			// course or account groups
+			if (isset($match[9]) || isset($match[11])) {
+				$this->context = CanvasContext::GROUP(); // used for context_code in events
+				$this->id = ($match[9] > $match[11] ? $match[9] : $match[11]);
+				$this->verificationUrl = "groups/{$this->id}"; // used once to look up the object to be sure it really exists
 
-            // courses
-            } elseif (isset($match[7])) {
-                $this->context = CanvasContext::COURSE();
-                $this->id = $match[7];
-                $this->verificationUrl = "courses/{$this->id}";
+			// courses
+			} elseif (isset($match[7])) {
+				$this->context = CanvasContext::COURSE();
+				$this->id = $match[7];
+				$this->verificationUrl = "courses/{$this->id}";
 
-            // users
-            } elseif (isset($match[5])) {
-                $this->context = CanvasContext::USER();
-                $this->id = $match[5];
-                $this->verificationUrl = "users/{$this->id}/profile";
+			// users
+			} elseif (isset($match[5])) {
+				$this->context = CanvasContext::USER();
+				$this->id = $match[5];
+				$this->verificationUrl = "users/{$this->id}/profile";
 
-            // we're somewhere where we don't know where we are
-            } else {
-                throw new Exception(
-                    "'$canvasUrl' is not a recognizable calendar context"
-                );
-            }
-        }
-        throw new Exception(
-            "'$canvasUrl' is not recognized as a URL to a calendar context on this Canvas instance"
-        );
-    }
+			// we're somewhere where we don't know where we are
+			} else {
+				throw new Exception(
+					"'$canvasUrl' is not a recognizable calendar context"
+				);
+			}
+		}
+		throw new Exception(
+			"'$canvasUrl' is not recognized as a URL to a calendar context on this Canvas instance"
+		);
+	}
 
-    public function getCanonicalUrl()
-    {
-        return $this->canonicalUrl;
-    }
+	public function getCanonicalUrl()
+	{
+		return $this->canonicalUrl;
+	}
 
-    public function getContext()
-    {
-        return $this->context;
-    }
+	public function getContext()
+	{
+		return $this->context;
+	}
 
-    public function getId()
-    {
-        return $this->id;
-    }
+	public function getId()
+	{
+		return $this->id;
+	}
 
-    public function getVerificationUrl()
-    {
-        return $this->verificationUrl;
-    }
+	public function getVerificationUrl()
+	{
+		return $this->verificationUrl;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -50,11 +50,11 @@
          * TODO: it would probably be better to look up users by email address than URL
          */
         /* get the context (user, course or group) for the canvas URL */
-        if (preg_match('%(https?://)?(' .
+        if (preg_match('%(https?://)?('.
             /*
              * FIXME not clear that we should be using $_SESSION
              */
-            parse_url($_SESSION[CANVAS_INSTANCE_URL], PHP_URL_HOST) . '/((about/(\d+))|(courses/(\d+)(/groups/(\d+))?)|(accounts/\d+/groups/(\d+))))%', $canvasUrl, $match)) {
+            parse_url($_SESSION[CANVAS_INSTANCE_URL], PHP_URL_HOST).'/((about/(\d+))|(courses/(\d+)(/groups/(\d+))?)|(accounts/\d+/groups/(\d+))))%', $canvasUrl, $match)) {
             $this->canonicalUrl = "https://{$match[2]}"; // https://stmarksschool.instructure.com/courses/953
 
             // course or account groups

src/Constants.php

Indentation +8 added lines, -8 removed lines

@@ -4,13 +4,13 @@
 
 class Constants
 {
-    /* argument values for sync */
-    const SCHEDULE_ONCE = 'once';
-    const SCHEDULE_WEEKLY = 'weekly';
-    const SCHEDULE_DAILY = 'daily';
-    const SCHEDULE_HOURLY = 'hourly';
-    const SCHEDULE_CUSTOM = 'custom';
+	/* argument values for sync */
+	const SCHEDULE_ONCE = 'once';
+	const SCHEDULE_WEEKLY = 'weekly';
+	const SCHEDULE_DAILY = 'daily';
+	const SCHEDULE_HOURLY = 'hourly';
+	const SCHEDULE_CUSTOM = 'custom';
 
-    const VALUE_OVERWRITE_CANVAS_CALENDAR = 'overwrite';
-    const VALUE_ENABLE_REGEXP_FILTER = 'enable_filter';
+	const VALUE_OVERWRITE_CANVAS_CALENDAR = 'overwrite';
+	const VALUE_ENABLE_REGEXP_FILTER = 'enable_filter';
 }