ilCalendarRemoteReader Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilCalendarRemoteReader:

Public Member Functions
	__construct (string $a_url)
	setUser (string $a_user)
	setPass (string $a_pass)
	getType ()
	getUrl ()
	read ()
	import (ilCalendarCategory $cat)

Protected Member Functions
	readIcal ()
	importIcal (ilCalendarCategory $cat)
	initCurl ()
	replaceWebCalProtocol ()

Protected Attributes
const	TYPE_ICAL = 1

Private Member Functions
	call ()

Private Attributes
int	$type = self::TYPE_ICAL
ilCurlConnection	$curl = null
string	$url = ''
string	$user = ''
string	$pass = ''
string	$ical = ''
ilLogger	$logger

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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 26 of file class.ilCalendarRemoteReader.php.

Constructor & Destructor Documentation

__construct()

ilCalendarRemoteReader::__construct

(

string

$a_url

)

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

References $DIC, and ILIAS\Repository\logger().

    {
        global $DIC;

        $this->logger = $DIC->logger()->cal();
        $this->url = $a_url;
    }

Here is the call graph for this function:

Member Function Documentation

call()

ilCalendarRemoteReader::call ( )

private

Exceptions

ilCurlConnectionException

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

Referenced by readIcal().

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

Here is the caller graph for this function:

getType()

ilCalendarRemoteReader::getType

(

)

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

References $type.

Referenced by import(), and read().

                             : int
    {
        return $this->type;
    }

Here is the caller graph for this function:

getUrl()

ilCalendarRemoteReader::getUrl

(

)

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

References $url.

Referenced by initCurl(), and replaceWebCalProtocol().

                            : string
    {
        return $this->url;
    }

Here is the caller graph for this function:

import()

ilCalendarRemoteReader::import

(

ilCalendarCategory

$cat

)

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

References getType(), and importIcal().

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

Here is the call graph for this function:

importIcal()

ilCalendarRemoteReader::importIcal ( ilCalendarCategory  $cat )

protected

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

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

Referenced by import().

                                                          : void
    {
        // Delete old appointments
        foreach (ilCalendarCategoryAssignments::_getAssignedAppointments(array($cat->getCategoryID())) as $app_id) {
            ilCalendarEntry::_delete($app_id);
        }
        ilCalendarCategoryAssignments::_deleteByCategoryId($cat->getCategoryID());

        // Import new appointments
        $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

Exceptions

ilCurlConnectionException

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

References Vendor\Package\$e, getUrl(), replaceWebCalProtocol(), and ILIAS\Repository\user().

Referenced by read().

                                 : void
    {
        try {
            $this->replaceWebCalProtocol();

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

            $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

(

)

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

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

                          : void
    {
        $this->initCurl();

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

Here is the call graph for this function:

readIcal()

ilCalendarRemoteReader::readIcal ( )

protected

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

References call(), and ILIAS\Repository\logger().

Referenced by read().

                                 : void
    {
        $this->ical = $this->call();
        $this->logger->debug($this->ical);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

replaceWebCalProtocol()

ilCalendarRemoteReader::replaceWebCalProtocol ( )

protected

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

References getUrl().

Referenced by initCurl().

                                              : void
    {
        if (substr($this->getUrl(), 0, 6) == 'webcal') {
            $purged = preg_replace('/webcal/', 'http', $this->getUrl(), 1);
            $this->url = (string) $purged;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setPass()

ilCalendarRemoteReader::setPass

(

string

$a_pass

)

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

                                           : void
    {
        $this->pass = $a_pass;
    }

setUser()

ilCalendarRemoteReader::setUser

(

string

$a_user

)

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

References ILIAS\Repository\user().

Referenced by ilCalendarCategoryGUI\doSynchronisation(), and ilCalendarCronRemoteReader\run().

                                           : void
    {
        $this->user = $a_user;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$curl

ilCurlConnection ilCalendarRemoteReader::$curl = null

private

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

$ical

string ilCalendarRemoteReader::$ical = ''

private

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

$logger

ilLogger ilCalendarRemoteReader::$logger

private

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

$pass

string ilCalendarRemoteReader::$pass = ''

private

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

$type

int ilCalendarRemoteReader::$type = self::TYPE_ICAL

private

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

Referenced by getType().

$url

string ilCalendarRemoteReader::$url = ''

private

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

Referenced by getUrl().

$user

string ilCalendarRemoteReader::$user = ''

private

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

TYPE_ICAL

const ilCalendarRemoteReader::TYPE_ICAL = 1

protected

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

---

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

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