Class Inx_Api_Mail_ParseException

Description

An Inx_Api_Mail_ParseException is thrown when the parsing of a mailing fails.

An Inx_Api_Mail_ParseException is thrown when the parsing of a 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.

  • version: $Revision: 9479 $ $Date: 2007-12-18 15:43:23 +0200 (An, 18 Grd 2007) $ $Author: aurimas $
  • see: Inx_Api_Mail_MailingRenderer::parse( $iRecipientId, $iPreferredMailType=null )
  • see: Inx_Api_Mail_RenderError
  • deprecated: As of 1.11.10, Inx_Api_Mail_MailingRenderer has been replaced with Inx_Api_Rendering_GeneralMailingRenderer

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

Exception
   |
   --Inx_Api_Rendering_ParseException
      |
      --Inx_Api_Mail_ParseException
Variable Summary
array() $aErrors
Method Summary
Inx_Api_Mail_ParseException __construct (array $aErrors)
int getErrorCount ()
Variables
array() $aErrors = array() (line 26)

Contains detail information about the error.

Contains detail information about the error.

  • var: of Inx_Api_Mail_RenderError objects
  • access: protected

Inherited Variables

Inherited from Inx_Api_Rendering_ParseException

Inx_Api_Rendering_ParseException::$errors
Methods
Constructor __construct (line 33)

Creates an Inx_Api_Mail_ParseException with the given render errors.

Creates an Inx_Api_Mail_ParseException with the given render errors.

  • access: public
Inx_Api_Mail_ParseException __construct (array $aErrors)
  • array $aErrors: 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 45)

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: the render error with the given index.
  • access: public
Inx_Api_Mail_RenderError getError (int $iIndex)
  • int $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 55)

Returns the number of render errors associated with this Inx_Api_Mail_ParseException.

Returns the number of render errors associated with this Inx_Api_Mail_ParseException.

  • return: the number of render errors.
  • access: public
int 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