Class Inx_Api_Mail_RenderError

Description

An Inx_Api_Mail_RenderError object describes the details of an error which occurred during the parsing or building of a mailing.

An Inx_Api_Mail_RenderError object describes the details of an error which occurred during the parsing or building of a mailing. Inx_Api_Mail_RenderError offers the following information:

  • Error type: an internal error code
  • Mail part: the internal mail part code
  • Begin line / column: the line and column where the malicious token begins
  • End line / column: the line and column where the malicious token ends.
  • Error messages: the error messages
Inx_Api_Mail_RenderError is mainly used internally but may provide some insight on the error source to API developers. For example, the token position will assist you in identifying syntax errors. The error messages may also be analyzed to identify the error source.

  • version: $Revision: 9479 $ $Date: 2007-12-18 15:43:23 +0200 (An, 18 Grd 2007) $ $Author: aurimas $
  • see: Inx_Api_Mail_ParseException::getError($iIndex)
  • see: Inx_Api_Mail_BuildException::getError()
  • deprecated: As of 1.11.10, Inx_Api_Mail_MailingRenderer has been replaced with Inx_Api_Rendering_GeneralMailingRenderer

Located in /Api/Mail/RenderError.php (line 31)

Inx_Api_Rendering_RenderError
   |
   --Inx_Api_Mail_RenderError
Method Summary
Inx_Api_Mail_RenderError __construct ($iErrorType $iErrorType, $iMailPart $iMailPart, $iBeginLine $iBeginLine, $iEndLine $iEndLine, $iBeginColumn $iBeginColumn, $iEndColumn $iEndColumn, $aMsgArgs $aMsgArgs)
Methods
Constructor __construct (line 45)

Creates an Inx_Api_Mail_RenderError with the given details.

Creates an Inx_Api_Mail_RenderError with the given details.

  • access: public
Inx_Api_Mail_RenderError __construct ($iErrorType $iErrorType, $iMailPart $iMailPart, $iBeginLine $iBeginLine, $iEndLine $iEndLine, $iBeginColumn $iBeginColumn, $iEndColumn $iEndColumn, $aMsgArgs $aMsgArgs)
  • $iErrorType $iErrorType: the internal error code.
  • $iMailPart $iMailPart: the internal mail part code.
  • $iBeginLine $iBeginLine: the line where the malicious token begins.
  • $iEndLine $iEndLine: the line where the malicious token ends.
  • $iBeginColumn $iBeginColumn: the column where the malicious token begins.
  • $iEndColumn $iEndColumn: the column where the malicious token ends.
  • $aMsgArgs $aMsgArgs: the string error messages.

Redefinition of:
Inx_Api_Rendering_RenderError::__construct()
Creates an Inx_Api_Rendering_RenderError with the given details.

Inherited Methods

Inherited From Inx_Api_Rendering_RenderError

Inx_Api_Rendering_RenderError::__construct()
Inx_Api_Rendering_RenderError::getBeginColumn()
Inx_Api_Rendering_RenderError::getBeginLine()
Inx_Api_Rendering_RenderError::getEndColumn()
Inx_Api_Rendering_RenderError::getEndLine()
Inx_Api_Rendering_RenderError::getErrorType()
Inx_Api_Rendering_RenderError::getMailPart()
Inx_Api_Rendering_RenderError::getMsgArgs()

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