ilDclInputException Class Reference

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

Inheritance diagram for ilDclInputException:

Collaboration diagram for ilDclInputException:

Public Member Functions
	__construct ($exception_type, $additional_text="")
	getExceptionType ()
	__toString ()
Public Member Functions inherited from ilException
	__construct ($a_message, $a_code=0, Throwable $previous=null)
	A code isn't optional as in build in class Exception. More...

Data Fields
const	TYPE_EXCEPTION = 0
const	LENGTH_EXCEPTION = 1
const	REGEX_EXCEPTION = 2
const	UNIQUE_EXCEPTION = 3
const	NOT_URL = 4
const	NOT_IMAGE = 5
const	WRONG_FILE_TYPE = 6
const	CUSTOM_MESSAGE = 7
const	REGEX_CONFIG_EXCEPTION = 8

Protected Attributes
string	$exception_type
string	$additional_text

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

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

Constructor & Destructor Documentation

__construct()

ilDclInputException::__construct	(		$exception_type,
			$additional_text = ""
	)

Parameters

string

$exception_type

Definition at line 37 of file class.ilDclInputException.php.

References $additional_text, $exception_type, ILIAS\GlobalScreen\Provider\__construct(), and __toString().

    {
        $this->exception_type = $exception_type;
        $this->additional_text = $additional_text;
        parent::__construct($this->__toString(), $exception_type);
    }

Here is the call graph for this function:

Member Function Documentation

__toString()

ilDclInputException::__toString

(

)

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

References $additional_text, $DIC, $lng, and $message.

Referenced by __construct().

                                : string
    {
        global $DIC;
        $lng = $DIC['lng'];

        switch ($this->exception_type) {
            case self::TYPE_EXCEPTION:
                $message = $lng->txt('dcl_wrong_input_type');
                break;
            case self::LENGTH_EXCEPTION:
                $message = $lng->txt('dcl_wrong_length');
                break;
            case self::REGEX_EXCEPTION:
                $message = $lng->txt('dcl_wrong_regex');
                break;
            case self::REGEX_CONFIG_EXCEPTION:
                $message = $lng->txt('dcl_invalid_regex_config');
                break;
            case self::UNIQUE_EXCEPTION:
                $message = $lng->txt('dcl_unique_exception');
                break;
            case self::NOT_URL:
                $message = $lng->txt('dcl_noturl_exception');
                break;
            case self::NOT_IMAGE:
                $message = $lng->txt('dcl_notimage_exception');
                break;
            case self::WRONG_FILE_TYPE:
                $message = $lng->txt('dcl_not_supported_file_type');
                break;
            case self::CUSTOM_MESSAGE:
                return $this->additional_text;
                break;
            default:
                $message = $lng->txt('dcl_unknown_exception');
        }

        if (strlen($this->additional_text) > 0) {
            $message .= " " . $this->additional_text;
        }

        return $message;
    }

Here is the caller graph for this function:

getExceptionType()

ilDclInputException::getExceptionType

(

)

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

References $exception_type.

                                      : string
    {
        return $this->exception_type;
    }

Field Documentation

$additional_text

string ilDclInputException::$additional_text

protected

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

Referenced by __construct(), and __toString().

$exception_type

string ilDclInputException::$exception_type

protected

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

Referenced by __construct(), and getExceptionType().

CUSTOM_MESSAGE

const ilDclInputException::CUSTOM_MESSAGE = 7

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

LENGTH_EXCEPTION

const ilDclInputException::LENGTH_EXCEPTION = 1

Definition at line 22 of file class.ilDclInputException.php.

Referenced by ilDclTextFieldModel\checkRegexAndLength().

NOT_IMAGE

const ilDclInputException::NOT_IMAGE = 5

Definition at line 26 of file class.ilDclInputException.php.

NOT_URL

const ilDclInputException::NOT_URL = 4

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

Referenced by ilDclTextFieldModel\checkValidityOfURLField().

REGEX_CONFIG_EXCEPTION

const ilDclInputException::REGEX_CONFIG_EXCEPTION = 8

Definition at line 29 of file class.ilDclInputException.php.

Referenced by ilDclTextFieldModel\checkRegexAndLength().

REGEX_EXCEPTION

const ilDclInputException::REGEX_EXCEPTION = 2

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

Referenced by ilDclTextFieldModel\checkRegexAndLength().

TYPE_EXCEPTION

const ilDclInputException::TYPE_EXCEPTION = 0

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

Referenced by ilDclNumberFieldModel\checkValidity().

UNIQUE_EXCEPTION

const ilDclInputException::UNIQUE_EXCEPTION = 3

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

Referenced by ilDclDatetimeFieldModel\checkValidity(), ilDclTextFieldModel\checkValidity(), ilDclFileuploadFieldModel\checkValidity(), ilDclBaseFieldModel\checkValidity(), and ilDclTextFieldModel\checkValidityOfURLField().

WRONG_FILE_TYPE

const ilDclInputException::WRONG_FILE_TYPE = 6

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

---

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

• Modules/DataCollection/exceptions/class.ilDclInputException.php