Overview

Packages

  • ClipIt
    • clipit
      • api
    • urjc
      • backend
  • Elgg
    • Core
      • Access
      • Authentication
      • Cache
      • Caches
      • Core
      • DataMode
        • Site
      • DataModel
        • Annotations
        • Entities
        • Extender
        • File
        • Importable
        • Loggable
        • Notable
        • Object
        • User
      • DataStorage
      • Exception
      • Exceptions
        • Stub
      • FileStore
        • Disk
      • Groups
      • Helpers
      • HMAC
      • Memcache
      • Metadata
      • Navigation
      • ODD
      • Output
      • Plugins
        • Settings
      • Sessions
      • SocialModel
        • Friendable
        • Locatable
      • WebServicesAPI
      • Widgets
      • XML
      • XMLRPC
    • Exceptions
      • Stub
  • None
  • PHP

Classes

  • ErrorResult
  • GenericResult
  • SuccessResult
  • Overview
  • Package
  • Class
  • Tree

Class ErrorResult

ErrorResult The error result class.

GenericResult
Extended by ErrorResult
Package: Elgg\Core\WebServicesAPI
Located at ErrorResult.php
Methods summary
public
# __construct( string $message, integer $code = "", Exception $exception = NULL )

A new error result

A new error result

Parameters

$message
string
$message Message
$code
integer
$code Error Code
$exception
Exception
$exception Exception object
public static ErrorResult
# getInstance( string $message, integer $code = "", Exception $exception = NULL )

Get a new instance of the ErrorResult.

Get a new instance of the ErrorResult.

Parameters

$message
string
$message Message
$code
integer
$code Code
$exception
Exception
$exception Optional exception for generating a stack trace.

Returns

ErrorResult
Methods inherited from GenericResult
export(), getResult(), getStatusCode(), getStatusMessage(), setResult(), setStatusCode()
Properties summary
public static integer $RESULT_FAIL -1
#
public static integer $RESULT_FAIL_APIKEY_DISABLED -30
#
public static integer $RESULT_FAIL_APIKEY_INACTIVE -31
#
public static integer $RESULT_FAIL_APIKEY_INVALID -32
#
public static integer $RESULT_FAIL_AUTHTOKEN -20
#
API documentation generated by ApiGen 2.8.0