ilLoggingErrorSettings Class Reference

Settings for the error protcoll system. More...

Collaboration diagram for ilLoggingErrorSettings:

Public Member Functions
	setMail ($mail)
	folder ()
	mail ()
	update ()
	writes mail recipient into client.ini.php More...

Static Public Member Functions
static	getInstance ()

Protected Member Functions
	__construct ()
	setFolder ($folder)
	read ()
	reads the values from ilias.ini.php More...

Protected Attributes
	$folder
	$mail

Detailed Description

Settings for the error protcoll system.

Author

Stefan Hecken stefa.nosp@m.n.he.nosp@m.cken@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de

Definition at line 9 of file class.ilLoggingErrorSettings.php.

Constructor & Destructor Documentation

__construct()

ilLoggingErrorSettings::__construct ( )

protected

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

References $ilIliasIniFile, $ini, folder(), mail(), and read().

    {
        global $ilIliasIniFile, $ini, $ilClientIniFile;

        //realy not nice but necessary to initalize logger at setup
        //ilias_ini is named only as $ini in inc.setup_header.php
        if (!$ilIliasIniFile) {
            if (!$ini) {
                throw new Exception("No ILIAS ini");
            } else {
                $this->ilias_ini = $ini;
            }
        } else {
            $this->ilias_ini = $ilIliasIniFile;
        }

        if ($ilClientIniFile !== null) {
            $this->gClientIniFile = $ilClientIniFile;
        }

        $this->folder = null;
        $this->mail = null;

        $this->read();
    }

Here is the call graph for this function:

Member Function Documentation

folder()

ilLoggingErrorSettings::folder

(

)

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

References $folder.

Referenced by __construct(), and setFolder().

    {
        return $this->folder;
    }

Here is the caller graph for this function:

getInstance()

static ilLoggingErrorSettings::getInstance ( )

static

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

Referenced by ilLoggerCronCleanErrorFiles\__construct(), ilErrorHandling\defaultHandler(), and ilObjLoggingSettingsGUI\initErrorSettings().

    {
        return new ilLoggingErrorSettings();
    }

Here is the caller graph for this function:

mail()

ilLoggingErrorSettings::mail

(

)

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

References $mail.

Referenced by __construct(), setMail(), and update().

    {
        return $this->mail;
    }

Here is the caller graph for this function:

read()

ilLoggingErrorSettings::read ( )

protected

reads the values from ilias.ini.php

Definition at line 68 of file class.ilLoggingErrorSettings.php.

References setFolder(), and setMail().

Referenced by __construct().

    {
        $this->setFolder($this->ilias_ini->readVariable("log", "error_path"));

        if ($this->gClientIniFile instanceof \ilIniFile) {
            $this->setMail($this->gClientIniFile->readVariable("log", "error_recipient"));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setFolder()

ilLoggingErrorSettings::setFolder (   $folder )

protected

Definition at line 45 of file class.ilLoggingErrorSettings.php.

References $folder, and folder().

Referenced by read().

    {
        $this->folder = $folder;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setMail()

ilLoggingErrorSettings::setMail

(

$mail

)

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

References $mail, and mail().

Referenced by read().

    {
        $this->mail = $mail;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

update()

ilLoggingErrorSettings::update

(

)

writes mail recipient into client.ini.php

Definition at line 80 of file class.ilLoggingErrorSettings.php.

References mail().

    {
        if ($this->gClientIniFile instanceof \ilIniFile) {
            $this->gClientIniFile->addGroup("log");
            $this->gClientIniFile->setVariable("log", "error_recipient", trim($this->mail()));
            $this->gClientIniFile->write();
        }
    }

Here is the call graph for this function:

Field Documentation

$folder

ilLoggingErrorSettings::$folder

protected

Definition at line 11 of file class.ilLoggingErrorSettings.php.

Referenced by folder(), and setFolder().

$mail

ilLoggingErrorSettings::$mail

protected

Definition at line 12 of file class.ilLoggingErrorSettings.php.

Referenced by mail(), and setMail().

---

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

• Services/Logging/classes/error/class.ilLoggingErrorSettings.php