LifeType 1.2.4 : Vue détaillée de pipelineresult.class.php

(pas de description)

Poids:	140 lignes (4 kb)
Inclus ou requis:	0 fois
Référencé:	3 fois
Nécessite:	0 fichiers

Définit 1 class

PipelineResult:: (10 méthodes):
  PipelineResult()
  isValid()
  setValid()
  getErrorCode()
  setErrorCode()
  getErrorMessage()
  setErrorMessage()
  hasView()
  setView()
  getView()

Classe: PipelineResult - X-Ref

\ingroup Security

this object is passed from PipelineFilter objects to the Pipeline, and
carries information about what the outcome of the processing
was. If negative (the method PipelineResult::isValid() returns false), then
the processing will be stopped and no more filters will be executed. Control will
be returned to the calling class which will decide what to do.

PipelineResult( $valid = true, $errorCode = 0, $errorMessage = "" ) X-Ref

Constructor of this type of object

param: valid By default, all results are positive. If not, please specify otherwise
param: errorCode Which error code to return. Error codes depend on the filter and might
param: errorMessage Error message that should be returned, if any.

isValid() X-Ref

Returns wether the pipeline failed or succeeded

return: A boolean value, true if successful or false otherwise

setValid( $valid ) X-Ref

Sets whether this is a valid result, or if processing will be stopped here

param: valid Whether the processing was successful (valid) or not

getErrorCode() X-Ref

Extended error code

return: An error code carrying extended information. The value of this

setErrorCode( $errorCode ) X-Ref

Sets the extended error code.

param: errorCode the new error code

getErrorMessage() X-Ref

An optional error message

return: An string describing the error, if any

setErrorMessage( $errorMessage ) X-Ref

Sets the error message.

param: errorMessage A string representing the new error message

hasView() X-Ref

Whether this result object has a custom view or not

return: True if there is a custom view object that should be shown instead of the

setView( $view ) X-Ref

Returns a custom view that can be used instead of the default
ErrorView

param: view A valid View, or a class extending from the base View
return: nothing

getView() X-Ref

returns the custom view, if any

return: A valid View, or a class extending from the base View

Code source de LifeType 1.2.4

/class/security/ -> pipelineresult.class.php (sommaire)

Définit 1 class

Généré le : Mon Nov 26 21:04:15 2007	par Balluche grâce à PHPXref 0.7