Class Inx_Api_Rendering_RenderError

Description

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

  • 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_Rendering_RenderError is mainly used internally but may provide some insight on the error source to API developers. also be analyzed to identify the error source.

An Inx_Api_Rendering_RenderError object describes the details of an error which occurred during the parsing or building of a mailing. Inx_Api_Rendering_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_Rendering_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.

Located in /Api/Rendering/RenderError.php (line 27)


	
			
Direct descendents
Class Description
Inx_Api_Mail_RenderError An Inx_Api_Mail_RenderError object describes the details of an error which occurred during the parsing or building of a mailing.
Inx_Api_TriggerMail_RenderError A Inx_Api_TriggerMail_RenderError object describes the details of an error which occurred during the parsing or building of a trigger mailing.
Method Summary
Inx_Api_Rendering_RenderError __construct (int $iErrorType, int $iMailPart, int $iBeginLine, int $iEndLine, int $iBeginColumn, int $iEndColumn, array() $aMsgArgs)
int getBeginLine ()
int getEndColumn ()
int getEndLine ()
int getErrorType ()
int getMailPart ()
array() getMsgArgs ()
Methods
Constructor __construct (line 48)

Creates an Inx_Api_Rendering_RenderError with the given details.

Creates an Inx_Api_Rendering_RenderError with the given details.

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

Redefined in descendants as:
getBeginColumn (line 104)

Returns the column where the malicious token begins.

Returns the column where the malicious token begins.

  • return: the column where the malicious token begins.
  • access: public
int getBeginColumn ()
getBeginLine (line 84)

Returns the line where the malicious token begins.

Returns the line where the malicious token begins.

  • return: the line where the malicious token begins.
  • access: public
int getBeginLine ()
getEndColumn (line 114)

Returns the column where the malicious token ends.

Returns the column where the malicious token ends.

  • return: the column where the malicious token ends.
  • access: public
int getEndColumn ()
getEndLine (line 94)

Returns the line where the malicious token ends.

Returns the line where the malicious token ends.

  • return: the line where the malicious token ends.
  • access: public
int getEndLine ()
getErrorType (line 64)

Returns the internal error code.

Returns the internal error code.

  • return: the internal error code.
  • access: public
int getErrorType ()
getMailPart (line 74)

Returns the internal mail part code.

Returns the internal mail part code.

  • return: the internal mail part code.
  • access: public
int getMailPart ()
getMsgArgs (line 124)

Returns the error messages.

Returns the error messages.

  • return: of string the error messages.
  • access: public
array() getMsgArgs ()

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