smtech / canvas-ics-sync

src/SyncIntoCanvas/Filter.php

Doc Comments +5 added lines

@@ -22,6 +22,11 @@
      */
     protected $exclude;
 
+    /**
+     * @param boolean $enabled
+     * @param string|null $include
+     * @param string|null $exclude
+     */
     public function __construct($enabled, $include, $exclude)
     {
         $this->setEnabled($enabled);

Indentation +70 added lines, -70 removed lines

@@ -4,84 +4,84 @@
 
 class Filter
 {
-    /**
-     * Whether or not this filter is enabled
-     * @var boolean
-     */
-    protected $enabled = false;
+	/**
+	 * Whether or not this filter is enabled
+	 * @var boolean
+	 */
+	protected $enabled = false;
 
-    /**
-     * Regex to include (applied first)
-     * @var string
-     */
-    protected $include;
+	/**
+	 * Regex to include (applied first)
+	 * @var string
+	 */
+	protected $include;
 
-    /**
-     * Regex to exclude (applied second)
-     * @var string
-     */
-    protected $exclude;
+	/**
+	 * Regex to exclude (applied second)
+	 * @var string
+	 */
+	protected $exclude;
 
-    public function __construct($enabled, $include, $exclude)
-    {
-        $this->setEnabled($enabled);
-        $this->setIncludeExpression($include);
-        $this->setExcludeExpression($exclude);
-    }
+	public function __construct($enabled, $include, $exclude)
+	{
+		$this->setEnabled($enabled);
+		$this->setIncludeExpression($include);
+		$this->setExcludeExpression($exclude);
+	}
 
-    public function setEnabled($enabled)
-    {
-        $this->enabled = (boolean) $enabled;
-    }
+	public function setEnabled($enabled)
+	{
+		$this->enabled = (boolean) $enabled;
+	}
 
-    public function isEnabled()
-    {
-        return $enabled;
-    }
+	public function isEnabled()
+	{
+		return $enabled;
+	}
 
-    public function setIncludeExpression($regex)
-    {
-        $this->include = (string) $regex;
-    }
+	public function setIncludeExpression($regex)
+	{
+		$this->include = (string) $regex;
+	}
 
-    public function getIncludeExpression()
-    {
-        if (empty($this->include)) {
-            return false;
-        }
-        return $this->include;
-    }
+	public function getIncludeExpression()
+	{
+		if (empty($this->include)) {
+			return false;
+		}
+		return $this->include;
+	}
 
-    public function setExcludeExpression($regex)
-    {
-        $this->exclude = (string) $regex;
-    }
+	public function setExcludeExpression($regex)
+	{
+		$this->exclude = (string) $regex;
+	}
 
-    public function getExcludeExpression()
-    {
-        if (empty($this->exclude)) {
-            return false;
-        }
-        return $this->exclude;
-    }
+	public function getExcludeExpression()
+	{
+		if (empty($this->exclude)) {
+			return false;
+		}
+		return $this->exclude;
+	}
 
-    public function filter(Event $event)
-    {
-        return (
-            // include this event if filtering is off...
-            $this->isEnabled() == false ||
-            (
-               (
-                   ( // if filtering is on, and there's an include pattern test that pattern...
-                       $this->getIncludeExpression() &&
-                       preg_match('%' . $this->getIncludeExpression() . '%', $event->getProperty('SUMMARY'))
-                   )
-               ) &&
-               !( // if there is an exclude pattern, make sure that this event is NOT excluded
-                   $this->getExcludeExpression() &&
-                   preg_match('%' . $this->getExcludeExpression() . '%', $event->getProperty('SUMMARY'))
-               )
-           )
-        );
-    }
+	public function filter(Event $event)
+	{
+		return (
+			// include this event if filtering is off...
+			$this->isEnabled() == false ||
+			(
+			   (
+				   ( // if filtering is on, and there's an include pattern test that pattern...
+					   $this->getIncludeExpression() &&
+					   preg_match('%' . $this->getIncludeExpression() . '%', $event->getProperty('SUMMARY'))
+				   )
+			   ) &&
+			   !( // if there is an exclude pattern, make sure that this event is NOT excluded
+				   $this->getExcludeExpression() &&
+				   preg_match('%' . $this->getExcludeExpression() . '%', $event->getProperty('SUMMARY'))
+			   )
+		   )
+		);
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -31,7 +31,7 @@ 
 
     public function setEnabled($enabled)
     {
-        $this->enabled = (boolean) $enabled;
+        $this->enabled = (boolean)$enabled;
     }
 
     public function isEnabled()
@@ -41,7 +41,7 @@ 
 
     public function setIncludeExpression($regex)
     {
-        $this->include = (string) $regex;
+        $this->include = (string)$regex;
     }
 
     public function getIncludeExpression()
@@ -54,7 +54,7 @@ 
 
     public function setExcludeExpression($regex)
     {
-        $this->exclude = (string) $regex;
+        $this->exclude = (string)$regex;
     }
 
     public function getExcludeExpression()
@@ -74,12 +74,12 @@ 
                (
                    ( // if filtering is on, and there's an include pattern test that pattern...
                        $this->getIncludeExpression() &&
-                       preg_match('%' . $this->getIncludeExpression() . '%', $event->getProperty('SUMMARY'))
+                       preg_match('%'.$this->getIncludeExpression().'%', $event->getProperty('SUMMARY'))
                    )
                ) &&
                !( // if there is an exclude pattern, make sure that this event is NOT excluded
                    $this->getExcludeExpression() &&
-                   preg_match('%' . $this->getExcludeExpression() . '%', $event->getProperty('SUMMARY'))
+                   preg_match('%'.$this->getExcludeExpression().'%', $event->getProperty('SUMMARY'))
                )
            )
         );

src/Toolbox.php

Indentation +20 added lines, -20 removed lines

@@ -7,24 +7,24 @@
 
 class Toolbox extends \smtech\StMarksReflexiveCanvasLTI\Toolbox
 {
-    /**
-     * Write messages to the log file if a script is being run
-     * non-interactively from the command line
-     *
-     * @param string $subject
-     * @param string $body
-     * @param string $flag (Optional, default `NotificationMessage::INFO`)
-     * @param Log $log (Optional, defaults to app log)
-     */
-    public function smarty_addMessage($subject, $body, $flag = NotificationMessage::INFO, Log $log = null)
-    {
-        if (empty($log)) {
-            $log = $this->getLog();
-        }
-        if (php_sapi_name() == 'cli') {
-            $log->log("[$flag] $subject: $body");
-        } else {
-            parent::smarty_addMessage($subject, $body, $flag);
-        }
-    }
+	/**
+	 * Write messages to the log file if a script is being run
+	 * non-interactively from the command line
+	 *
+	 * @param string $subject
+	 * @param string $body
+	 * @param string $flag (Optional, default `NotificationMessage::INFO`)
+	 * @param Log $log (Optional, defaults to app log)
+	 */
+	public function smarty_addMessage($subject, $body, $flag = NotificationMessage::INFO, Log $log = null)
+	{
+		if (empty($log)) {
+			$log = $this->getLog();
+		}
+		if (php_sapi_name() == 'cli') {
+			$log->log("[$flag] $subject: $body");
+		} else {
+			parent::smarty_addMessage($subject, $body, $flag);
+		}
+	}
 }

src/SyncIntoCanvas/Event.php

Indentation +35 added lines, -35 removed lines

@@ -4,40 +4,40 @@
 
 class Event
 {
-    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'
-    ];
+	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'
+	];
 
-    /**
-     * Generate a hash of this version of an event to cache in the database
-     **/
-    public function getEventHash($event)
-    {
-        $blob = '';
-        foreach (static::$FIELD_MAP as $field) {
-            if (is_array($field)) {
-                foreach ($field as $option) {
-                    if (!empty($property = $event->getProperty($option))) {
-                        $blob .= serialize($property);
-                        break;
-                    }
-                }
-            } else {
-                if (!empty($property = $event->getProperty($field))) {
-                    $blob .= serialize($property);
-                }
-            }
-        }
-        return md5($blob);
-    }
+	/**
+	 * Generate a hash of this version of an event to cache in the database
+	 **/
+	public function getEventHash($event)
+	{
+		$blob = '';
+		foreach (static::$FIELD_MAP as $field) {
+			if (is_array($field)) {
+				foreach ($field as $option) {
+					if (!empty($property = $event->getProperty($option))) {
+						$blob .= serialize($property);
+						break;
+					}
+				}
+			} else {
+				if (!empty($property = $event->getProperty($field))) {
+					$blob .= serialize($property);
+				}
+			}
+		}
+		return md5($blob);
+	}
 }

src/SyncIntoCanvas/Schedule.php

Indentation +18 added lines, -18 removed lines

@@ -4,23 +4,23 @@
 
 class Schedule
 {
-    protected $syncTimestamp;
+	protected $syncTimestamp;
 
-    /**
-     * Generate a unique identifier for this synchronization pass
-     **/
-    public function getSyncTimestamp()
-    {
-        if (empty($this->syncTimestamp)) {
-            $timestamp = new DateTime();
-            $this->syncTimestamp =
-                $timestamp->format(Constants::SYNC_TIMESTAMP_FORMAT) .
-                Constants::SEPARATOR . md5(
-                    (php_sapi_name() == 'cli' ?
-                        'cli' : $_SERVER['REMOTE_ADDR']
-                    ) . time()
-                );
-        }
-        return $this->syncTimestamp;
-    }
+	/**
+	 * Generate a unique identifier for this synchronization pass
+	 **/
+	public function getSyncTimestamp()
+	{
+		if (empty($this->syncTimestamp)) {
+			$timestamp = new DateTime();
+			$this->syncTimestamp =
+				$timestamp->format(Constants::SYNC_TIMESTAMP_FORMAT) .
+				Constants::SEPARATOR . md5(
+					(php_sapi_name() == 'cli' ?
+						'cli' : $_SERVER['REMOTE_ADDR']
+					) . time()
+				);
+		}
+		return $this->syncTimestamp;
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -14,11 +14,11 @@
         if (empty($this->syncTimestamp)) {
             $timestamp = new DateTime();
             $this->syncTimestamp =
-                $timestamp->format(Constants::SYNC_TIMESTAMP_FORMAT) .
-                Constants::SEPARATOR . md5(
+                $timestamp->format(Constants::SYNC_TIMESTAMP_FORMAT).
+                Constants::SEPARATOR.md5(
                     (php_sapi_name() == 'cli' ?
                         'cli' : $_SERVER['REMOTE_ADDR']
-                    ) . time()
+                    ).time()
                 );
         }
         return $this->syncTimestamp;

src/SyncIntoCanvas/Syncable.php

Indentation +75 added lines, -75 removed lines

@@ -12,86 +12,86 @@
  */
 abstract class Syncable
 {
-    /**
-     * MySQL connection
-     *
-     * @var mysqli|null
-     */
-    protected static $mysql;
+	/**
+	 * MySQL connection
+	 *
+	 * @var mysqli|null
+	 */
+	protected static $mysql;
 
-    /**
-     * Canvas API connection
-     *
-     * @var CanvasPest|null
-     */
-    protected static $api;
+	/**
+	 * Canvas API connection
+	 *
+	 * @var CanvasPest|null
+	 */
+	protected static $api;
 
-    /**
-     * Update the MySQL connection
-     *
-     * @param mysqli $mysql
-     * @throws Exception If `$mysql` is null
-     */
-    public static function setMySql(mysqli $mysql)
-    {
-        if (empty($mysql)) {
-            throw new Exception(
-                'A non-null MySQL connection is required'
-            );
-        } else {
-            static::$mysql = $mysql;
-        }
-    }
+	/**
+	 * Update the MySQL connection
+	 *
+	 * @param mysqli $mysql
+	 * @throws Exception If `$mysql` is null
+	 */
+	public static function setMySql(mysqli $mysql)
+	{
+		if (empty($mysql)) {
+			throw new Exception(
+				'A non-null MySQL connection is required'
+			);
+		} else {
+			static::$mysql = $mysql;
+		}
+	}
 
-    /**
-     * Get the MySQL connection
-     *
-     * @return mysqli
-     */
-    public static function getMySql()
-    {
-        return static::$mysql;
-    }
+	/**
+	 * Get the MySQL connection
+	 *
+	 * @return mysqli
+	 */
+	public static function getMySql()
+	{
+		return static::$mysql;
+	}
 
-    /**
-     * Update the API connection
-     *
-     * @param CanvasPest $api
-     * @throws Exception if `$api` is null
-     */
-    public static function setApi(CanvasPest $api)
-    {
-        if (empty($api)) {
-            throw new Exception(
-                'A non-null API connection is required'
-            );
-        } else {
-            static::$api = $api;
-        }
-    }
+	/**
+	 * Update the API connection
+	 *
+	 * @param CanvasPest $api
+	 * @throws Exception if `$api` is null
+	 */
+	public static function setApi(CanvasPest $api)
+	{
+		if (empty($api)) {
+			throw new Exception(
+				'A non-null API connection is required'
+			);
+		} else {
+			static::$api = $api;
+		}
+	}
 
-    /**
-     * Get the API connection
-     *
-     * @return CanvasPest|null
-     */
-    public static function getApi()
-    {
-        return static::$api;
-    }
+	/**
+	 * Get the API connection
+	 *
+	 * @return CanvasPest|null
+	 */
+	public static function getApi()
+	{
+		return static::$api;
+	}
 
-    /**
-     * Save the syncable object to the MySQL database
-     *
-     * @return [type] [description]
-     */
-    abstract public function save();
+	/**
+	 * Save the syncable object to the MySQL database
+	 *
+	 * @return [type] [description]
+	 */
+	abstract public function save();
 
-    /**
-     * Load a syncable object from the MySQL database
-     *
-     * @param int $id
-     * @return Syncable
-     */
-    abstract public static function load($id);
+	/**
+	 * Load a syncable object from the MySQL database
+	 *
+	 * @param int $id
+	 * @return Syncable
+	 */
+	abstract public static function load($id);
 }

src/SyncIntoCanvas/CalendarContext.php

Indentation +84 added lines, -84 removed lines

@@ -4,107 +4,107 @@
 
 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?://)?(' . parse_url($_SESSION[Constants::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
+		/* get the context (user, course or group) for the canvas URL */
+		if (preg_match('%(https?://)?(' . parse_url($_SESSION[Constants::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;
+	}
 
-    public function __toString()
-    {
-        return $this->getCanonicalUrl();
-    }
+	public function __toString()
+	{
+		return $this->getCanonicalUrl();
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -50,7 +50,7 @@
          * 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?://)?(' . parse_url($_SESSION[Constants::CANVAS_INSTANCE_URL], PHP_URL_HOST) . '/((about/(\d+))|(courses/(\d+)(/groups/(\d+))?)|(accounts/\d+/groups/(\d+))))%', $canvasUrl, $match)) {
+        if (preg_match('%(https?://)?('.parse_url($_SESSION[Constants::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/SyncIntoCanvas/CanvasContext.php

Indentation +3 added lines, -3 removed lines

@@ -6,7 +6,7 @@
 
 class CanvasContext extends Enum
 {
-    const COURSE = 'course';
-    const USER = 'user';
-    const GROUP = 'group';
+	const COURSE = 'course';
+	const USER = 'user';
+	const GROUP = 'group';
 }

src/SyncIntoCanvas/Calendar.php

Indentation +214 added lines, -214 removed lines

@@ -4,220 +4,220 @@
 
 class Calendar
 {
-    /**
-     * Canvas calendar context
-     * @var CalendarContext
-     */
-    protected $context;
-
-    /**
-     * ICS or webcal feed URL
-     * @var string
-     */
-    protected $feedUrl;
-
-    /**
-     * Name of this calendar (extracted from feed)
-     * @var string
-     */
-    protected $name;
-
-    /**
-     * 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
-        ));
-    }
-
-    /**
-     * 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;
-    }
-
-    /**
-     * 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;
-    }
-
-    /**
-     * 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;
-    }
-
-    /**
-     * 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;
-    }
-
-    /**
-     * Generate a unique ID to identify this particular pairing of ICS feed and
-     * Canvas calendar
-     **/
-    protected function getPairingHash()
-    {
-        global $metadata;
-        return md5($this->getContext() . $this->getFeedUrl());
-    }
-
-    public function save()
-    {
-        $sql = static::getMySql();
-
-        $params = [
-            'id' => $sql->escape_string($this->getPairingHash()),
-            'name' => $sql->escape_string($this->getName()),
-            'canvas_url' => $sql->escape_string($this->getContext()->getCanonicalUrl()),
-            'ics_url' => $sql->escape_string($this->getFeedUrl()),
-            'enable_regex_filter' => $this->getFilter()->isEnabled(),
-            'include_regexp' => $sql->escape_string($this->getFilter()->getIncludeExpression()),
-            'exclude_regexp' => $sql->escape_string($this->getFilter()->getExcludeExpression())
-        ];
-        foreach ($params as $field => $value) {
-            if (empty($value)) {
-                $params[$field] = 'NULL';
-            } else {
-                $params[$field] = "'$value'";
-            }
-        }
-        $response = static::getMySql()->query("
+	/**
+	 * Canvas calendar context
+	 * @var CalendarContext
+	 */
+	protected $context;
+
+	/**
+	 * ICS or webcal feed URL
+	 * @var string
+	 */
+	protected $feedUrl;
+
+	/**
+	 * Name of this calendar (extracted from feed)
+	 * @var string
+	 */
+	protected $name;
+
+	/**
+	 * 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
+		));
+	}
+
+	/**
+	 * 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;
+	}
+
+	/**
+	 * 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;
+	}
+
+	/**
+	 * 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;
+	}
+
+	/**
+	 * 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;
+	}
+
+	/**
+	 * Generate a unique ID to identify this particular pairing of ICS feed and
+	 * Canvas calendar
+	 **/
+	protected function getPairingHash()
+	{
+		global $metadata;
+		return md5($this->getContext() . $this->getFeedUrl());
+	}
+
+	public function save()
+	{
+		$sql = static::getMySql();
+
+		$params = [
+			'id' => $sql->escape_string($this->getPairingHash()),
+			'name' => $sql->escape_string($this->getName()),
+			'canvas_url' => $sql->escape_string($this->getContext()->getCanonicalUrl()),
+			'ics_url' => $sql->escape_string($this->getFeedUrl()),
+			'enable_regex_filter' => $this->getFilter()->isEnabled(),
+			'include_regexp' => $sql->escape_string($this->getFilter()->getIncludeExpression()),
+			'exclude_regexp' => $sql->escape_string($this->getFilter()->getExcludeExpression())
+		];
+		foreach ($params as $field => $value) {
+			if (empty($value)) {
+				$params[$field] = 'NULL';
+			} else {
+				$params[$field] = "'$value'";
+			}
+		}
+		$response = static::getMySql()->query("
             SELECT * FROM `calendars` WHERE `id` = '$_id'
         ");
-        $previous = $response->fetch_assoc();
-        if ($previous) {
-            $query = "UPDATE `calendars` SET\n";
-            foreach ($params as $field => $value) {
-                if ($key != 'id') {
-                    $query .= "`$field` = $value\n";
-                }
-            }
-            $query .= "WHERE `id` = '{$params['id']}'";
-        } else {
-            $query = "INSERT INTO `calendars` (\n`";
-            $query .= implode('`, `', array_keys($params));
-            $query .= "`) VALUES (";
-            $query .= implode(', ', $params);
-            $query .= ')';
-        }
-        if (static::getMySql($query)->query() === false) {
-            throw new Exception(
-                "Failed to store calendar ID {$this->id} to database"
-            );
-        }
-    }
-
-    /**
-     * Load a Calendar from the MySQL database
-     *
-     * @param int $id
-     * @return Calendar
-     */
-    public static function load($id)
-    {
-        $sql = static::getMySql();
-        $query = "SELECT * FROM `calendars` WHERE `id` = '" . $sql->escape_string($id) . "'";
-        $response = $sql->query($query);
-        if ($response) {
-            $calendar = $response->fetch_assoc();
-            return new Calendar($calendar['canvas_url'], $calendar['ics_url'], $calendar['enable_regex_filter'], $calendar['include_regexp'], $calendar['exclude_regexp']);
-        }
-        return null;
-    }
+		$previous = $response->fetch_assoc();
+		if ($previous) {
+			$query = "UPDATE `calendars` SET\n";
+			foreach ($params as $field => $value) {
+				if ($key != 'id') {
+					$query .= "`$field` = $value\n";
+				}
+			}
+			$query .= "WHERE `id` = '{$params['id']}'";
+		} else {
+			$query = "INSERT INTO `calendars` (\n`";
+			$query .= implode('`, `', array_keys($params));
+			$query .= "`) VALUES (";
+			$query .= implode(', ', $params);
+			$query .= ')';
+		}
+		if (static::getMySql($query)->query() === false) {
+			throw new Exception(
+				"Failed to store calendar ID {$this->id} to database"
+			);
+		}
+	}
+
+	/**
+	 * Load a Calendar from the MySQL database
+	 *
+	 * @param int $id
+	 * @return Calendar
+	 */
+	public static function load($id)
+	{
+		$sql = static::getMySql();
+		$query = "SELECT * FROM `calendars` WHERE `id` = '" . $sql->escape_string($id) . "'";
+		$response = $sql->query($query);
+		if ($response) {
+			$calendar = $response->fetch_assoc();
+			return new Calendar($calendar['canvas_url'], $calendar['ics_url'], $calendar['enable_regex_filter'], $calendar['include_regexp'], $calendar['exclude_regexp']);
+		}
+		return null;
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -114,7 +114,7 @@ 
      */
     public function setName($name)
     {
-        $this->name = (string) $name;
+        $this->name = (string)$name;
     }
 
     /**
@@ -154,7 +154,7 @@ 
     protected function getPairingHash()
     {
         global $metadata;
-        return md5($this->getContext() . $this->getFeedUrl());
+        return md5($this->getContext().$this->getFeedUrl());
     }
 
     public function save()
@@ -212,7 +212,7 @@ 
     public static function load($id)
     {
         $sql = static::getMySql();
-        $query = "SELECT * FROM `calendars` WHERE `id` = '" . $sql->escape_string($id) . "'";
+        $query = "SELECT * FROM `calendars` WHERE `id` = '".$sql->escape_string($id)."'";
         $response = $sql->query($query);
         if ($response) {
             $calendar = $response->fetch_assoc();