ilCalendarRemoteReader Class Reference

Reader for remote ical calendars. More...

Collaboration diagram for ilCalendarRemoteReader:

Public Member Functions
	__construct ($a_url)
	Constructor init curl. More...
	setUser ($a_user)
	setPass ($a_pass)
	getType ()
	getUrl ()
	read ()
	Read ical format. More...
	import (ilCalendarCategory $cat)
	Import appointments in calendar. More...

Data Fields
const	TYPE_ICAL = 1

Protected Member Functions
	readIcal ()
	Read ical. More...
	importIcal (ilCalendarCategory $cat)
	Import ical in calendar. More...
	initCurl ()
	Init curl connection. More...
	replaceWebCalProtocol ()

Private Member Functions
	call ()
	call peer More...

Private Attributes
	$type = self::TYPE_ICAL
	$curl = null
	$url
	$user
	$pass
	$ical

Detailed Description

Reader for remote ical calendars.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Definition at line 14 of file class.ilCalendarRemoteReader.php.

Constructor & Destructor Documentation

__construct()

ilCalendarRemoteReader::__construct

(

$a_url

)

Constructor init curl.

Definition at line 34 of file class.ilCalendarRemoteReader.php.

    {
        $this->url = $a_url;
    }

Member Function Documentation

call()

ilCalendarRemoteReader::call ( )

private

call peer

private

Exceptions

ilCurlConnectionException

Definition at line 168 of file class.ilCalendarRemoteReader.php.

References $res.

Referenced by readIcal().

    {
        try {
            $res = $this->curl->exec();
            return $res;
        } catch (ilCurlConnectionException $exc) {
            throw($exc);
        }
    }

Here is the caller graph for this function:

getType()

ilCalendarRemoteReader::getType

(

)

Definition at line 49 of file class.ilCalendarRemoteReader.php.

References $type.

Referenced by import(), and read().

    {
        return $this->type;
    }

Here is the caller graph for this function:

getUrl()

ilCalendarRemoteReader::getUrl

(

)

Definition at line 54 of file class.ilCalendarRemoteReader.php.

References $url.

Referenced by initCurl(), and replaceWebCalProtocol().

    {
        return $this->url;
    }

Here is the caller graph for this function:

import()

ilCalendarRemoteReader::import

(

ilCalendarCategory

$cat

)

Import appointments in calendar.

Returns

type

Definition at line 79 of file class.ilCalendarRemoteReader.php.

References getType(), and importIcal().

    {
        switch ($this->getType()) {
            case self::TYPE_ICAL:
                return $this->importIcal($cat);
        }
    }

Here is the call graph for this function:

importIcal()

ilCalendarRemoteReader::importIcal ( ilCalendarCategory  $cat )

protected

Import ical in calendar.

Parameters

ilCalendarCategory

$cat

Definition at line 103 of file class.ilCalendarRemoteReader.php.

References $parser, ilCalendarEntry\_delete(), ilCalendarCategoryAssignments\_deleteByCategoryId(), ilCalendarCategoryAssignments\_getAssignedAppointments(), array, ilCalendarCategory\getCategoryID(), and ilICalParser\INPUT_STRING.

Referenced by import().

    {
        // Delete old appointments
        include_once('./Services/Calendar/classes/class.ilCalendarCategoryAssignments.php');
        foreach (ilCalendarCategoryAssignments::_getAssignedAppointments(array($cat->getCategoryID())) as $app_id) {
            include_once('./Services/Calendar/classes/class.ilCalendarEntry.php');
            ilCalendarEntry::_delete($app_id);
        }
        ilCalendarCategoryAssignments::_deleteByCategoryId($cat->getCategoryID());
        
        // Import new appointments
        include_once './Services/Calendar/classes/iCal/class.ilICalParser.php';
        $parser = new ilICalParser($this->ical, ilICalParser::INPUT_STRING);
        $parser->setCategoryId($cat->getCategoryID());
        $parser->parse();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initCurl()

ilCalendarRemoteReader::initCurl ( )

protected

Init curl connection.

Definition at line 123 of file class.ilCalendarRemoteReader.php.

References ilProxySettings\_getInstance(), getUrl(), replaceWebCalProtocol(), and user().

Referenced by read().

    {
        try {
            $this->replaceWebCalProtocol();
            
            $this->curl = new ilCurlConnection($this->getUrl());
            $this->curl->init();

            if (ilProxySettings::_getInstance()->isActive()) {
                $this->curl->setOpt(CURLOPT_HTTPPROXYTUNNEL, true);
                $this->curl->setOpt(CURLOPT_PROXY, ilProxySettings::_getInstance()->getHost());
                $this->curl->setOpt(CURLOPT_PROXYPORT, ilProxySettings::_getInstance()->getPort());
            }

            $this->curl->setOpt(CURLOPT_SSL_VERIFYPEER, 0);
            $this->curl->setOpt(CURLOPT_SSL_VERIFYHOST, 0);
            $this->curl->setOpt(CURLOPT_RETURNTRANSFER, 1);
            
            $this->curl->setOpt(CURLOPT_FOLLOWLOCATION, 1);
            $this->curl->setOpt(CURLOPT_MAXREDIRS, 3);
            
            if ($this->user) {
                $this->curl->setOpt(CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
                $this->curl->setOpt(CURLOPT_USERPWD, $this->user . ':' . $this->pass);
            }
        } catch (Exception $e) {
            throw $e;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

read()

ilCalendarRemoteReader::read

(

)

Read ical format.

Exceptions

sonething

Definition at line 65 of file class.ilCalendarRemoteReader.php.

References getType(), initCurl(), and readIcal().

    {
        $this->initCurl();
        
        switch ($this->getType()) {
            case self::TYPE_ICAL:
                return $this->readIcal();
        }
    }

Here is the call graph for this function:

readIcal()

ilCalendarRemoteReader::readIcal ( )

protected

Read ical.

Exceptions

ilCurlConnectionException

Definition at line 92 of file class.ilCalendarRemoteReader.php.

References $GLOBALS, and call().

Referenced by read().

    {
        $this->ical = $this->call();
        $GLOBALS['ilLog']->write(__METHOD__ . ': ' . $this->ical);
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

replaceWebCalProtocol()

ilCalendarRemoteReader::replaceWebCalProtocol ( )

protected

Definition at line 153 of file class.ilCalendarRemoteReader.php.

References $GLOBALS, and getUrl().

Referenced by initCurl().

    {
        if (substr($this->getUrl(), 0, 6) == 'webcal') {
            $purged = preg_replace('/webcal/', 'http', $this->getUrl(), 1);
            $this->url = $purged;
            $GLOBALS['ilLog']->write(__METHOD__ . ': Using new url: ' . $this->getUrl());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setPass()

ilCalendarRemoteReader::setPass

(

$a_pass

)

Definition at line 44 of file class.ilCalendarRemoteReader.php.

    {
        $this->pass = $a_pass;
    }

setUser()

ilCalendarRemoteReader::setUser

(

$a_user

)

Definition at line 39 of file class.ilCalendarRemoteReader.php.

References user().

Referenced by ilCalendarCategoryGUI\doSynchronisation(), and ilCalendarPresentationGUI\synchroniseExternalCalendars().

    {
        $this->user = $a_user;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$curl

ilCalendarRemoteReader::$curl = null

private

Definition at line 21 of file class.ilCalendarRemoteReader.php.

$ical

ilCalendarRemoteReader::$ical

private

Definition at line 27 of file class.ilCalendarRemoteReader.php.

$pass

ilCalendarRemoteReader::$pass

private

Definition at line 25 of file class.ilCalendarRemoteReader.php.

$type

ilCalendarRemoteReader::$type = self::TYPE_ICAL

private

Definition at line 19 of file class.ilCalendarRemoteReader.php.

Referenced by getType().

$url

ilCalendarRemoteReader::$url

private

Definition at line 23 of file class.ilCalendarRemoteReader.php.

Referenced by getUrl().

$user

ilCalendarRemoteReader::$user

private

Definition at line 24 of file class.ilCalendarRemoteReader.php.

TYPE_ICAL

const ilCalendarRemoteReader::TYPE_ICAL = 1

Definition at line 16 of file class.ilCalendarRemoteReader.php.

---

The documentation for this class was generated from the following file:

• Services/Calendar/classes/class.ilCalendarRemoteReader.php