Class Inx_Api_TriggerMail_ParseException

Description

A Inx_Api_TriggerMail_ParseException is thrown when the parsing of a trigger mailing fails. such a failure usually is a syntax error. associated with the exception.

A Inx_Api_TriggerMail_ParseException is thrown when the parsing of a trigger mailing fails. The reason for such a failure usually is a syntax error. For a deeper insight on the error, consult the RenderErrors associated with the exception.

  • author: chge, 09.07.2012
  • see: com.inxmail.xpro.api.triggermail.RenderError
  • see: parse(int, long, int)
  • see: parse(int, int)
  • deprecated: As of 1.11.10, Inx_Api_TriggerMail_TriggerMailingRenderer has been replaced with Inx_Api_Rendering_GeneralMailingRenderer
  • since: API 1.10.0

Located in /Api/TriggerMail/ParseException.php (line 20)

Exception
   |
   --Inx_Api_Rendering_ParseException
      |
      --Inx_Api_TriggerMail_ParseException
Variable Summary
mixed $errors
Method Summary
Inx_Api_TriggerMail_ParseException __construct ( $errors)
the getError (index $iIndex)
the getErrorCount ()
Variables
mixed $errors (line 23)

Contains detail information about the error.

Contains detail information about the error.

  • access: protected

Redefinition of:
Inx_Api_Rendering_ParseException::$errors
Methods
Constructor __construct (line 30)

Creates a Inx_Api_TriggerMail_ParseException with the given render errors.

Creates a Inx_Api_TriggerMail_ParseException with the given render errors.

  • access: public
Inx_Api_TriggerMail_ParseException __construct ( $errors)
  • errors $errors: the render errors which occurred during the parsing.

Redefinition of:
Inx_Api_Rendering_ParseException::__construct()
Creates an Inx_Api_Rendering_ParseException with the given render errors.
getError (line 42)

Returns detail information about the error by returning the render error with the given index.

Returns detail information about the error by returning the render error with the given index.

  • return: render error with the given index.
  • access: public
the getError (index $iIndex)
  • index $iIndex: the index of the render error to be returned.

Redefinition of:
Inx_Api_Rendering_ParseException::getError()
Returns the error with the given index.
getErrorCount (line 52)

Returns the number of render errors associated with this Inx_Api_TriggerMail_ParseException.

Returns the number of render errors associated with this Inx_Api_TriggerMail_ParseException.

  • return: number of render errors.
  • access: public
the getErrorCount ()

Redefinition of:
Inx_Api_Rendering_ParseException::getErrorCount()
Returns the number of render errors associated with this Inx_Api_Rendering_ParseException.

Inherited Methods

Inherited From Inx_Api_Rendering_ParseException

Inx_Api_Rendering_ParseException::__construct()
Inx_Api_Rendering_ParseException::getError()
Inx_Api_Rendering_ParseException::getErrorCount()

Documentation generated on Thu, 17 Sep 2015 14:27:27 +0200 by phpDocumentor 1.3.2