Overview

Namespaces

  • SKJ
    • AppException
      • HTTP
      • Logic
      • Runtime

Classes

  • Label

Interfaces

  • AppExceptionInterface

Traits

  • AppExceptionMethods

Exceptions

  • AppException
  • Overview
  • Namespace
  • Class

Interface AppExceptionInterface

AppException ｲﾝﾀｰﾌｪｰｽ

SKJ\AppExceptionInterface implements IteratorAggregate

Direct known implementers

SKJ\AppException

Indirect known implementers

SKJ\AppException\AbstractContainerException, SKJ\AppException\AbstractDateTimeException, SKJ\AppException\HTTP\GatewayTimeoutException, SKJ\AppException\HTTP\GoneException, SKJ\AppException\HTTP\HttpVersionNotSupportedException, SKJ\AppException\HTTP\InternalServerErrorException, SKJ\AppException\HTTP\LengthRequiredException, SKJ\AppException\HTTP\LockedException, SKJ\AppException\HTTP\MethodNotAllowedException, SKJ\AppException\HTTP\NotAcceptableException, SKJ\AppException\HTTP\NotFoundException, SKJ\AppException\HTTP\NotImplementedException, SKJ\AppException\AbstractHttpException, SKJ\AppException\HTTP\PaymentRequiredException, SKJ\AppException\HTTP\PreconditionFailedException, SKJ\AppException\HTTP\ProxyAuthenticationRequiredException, SKJ\AppException\HTTP\RequestedRangeNotSatisfiableException, SKJ\AppException\HTTP\RequestEntityTooLargeException, SKJ\AppException\HTTP\RequestTimeoutException, SKJ\AppException\HTTP\RequestUriTooLongException, SKJ\AppException\HTTP\ServiceUnavailableException, SKJ\AppException\HTTP\UnauthorizedException, SKJ\AppException\HTTP\UnprocessableEntityException, SKJ\AppException\AbstractValidationException, SKJ\AppException\HTTP\UnsupportedMediaTypeException, SKJ\AppException\HttpException, SKJ\AppException\Logic\BadFunctionCallException, SKJ\AppException\Logic\BadMethodCallException, SKJ\AppException\Logic\CircularReferenceException, SKJ\AppException\Logic\ContainerException, SKJ\AppException\Logic\DependencyInjectionException, SKJ\AppException\Logic\DomainException, SKJ\AppException\Logic\EnvironmentException, SKJ\AppException\Logic\InvalidArgumentException, SKJ\AppException\HTTP\BadGatewayException, SKJ\AppException\Logic\LengthException, SKJ\AppException\Logic\OutOfRangeException, SKJ\AppException\Logic\UnexpectedValueException, SKJ\AppException\LogicException, SKJ\AppException\Runtime\AuthenticationException, SKJ\AppException\Runtime\DeadLockException, SKJ\AppException\Runtime\DuplicationException, SKJ\AppException\Runtime\DurationException, SKJ\AppException\Runtime\EmptyResultException, SKJ\AppException\Runtime\ExpiryException, SKJ\AppException\HTTP\BadRequestException, SKJ\AppException\Runtime\InvalidElementException, SKJ\AppException\Runtime\MissingElementException, SKJ\AppException\Runtime\NoConditionException, SKJ\AppException\Runtime\OutOfBoundsException, SKJ\AppException\Runtime\OverflowException, SKJ\AppException\Runtime\PermissionException, SKJ\AppException\Runtime\RangeException, SKJ\AppException\Runtime\TemporaryFailureException, SKJ\AppException\Runtime\TimeoutException, SKJ\AppException\Runtime\TransactionException, SKJ\AppException\HTTP\ConflictException, SKJ\AppException\Runtime\UnavailableServiceException, SKJ\AppException\Runtime\UnderflowException, SKJ\AppException\Runtime\UnexpectedValueException, SKJ\AppException\Runtime\UploadException, SKJ\AppException\Runtime\ValidationException, SKJ\AppException\Runtime\WrongArgumentException, SKJ\AppException\RuntimeException, SKJ\AppException\HTTP\ExpectationFailedException, SKJ\AppException\HTTP\FailedDependencyException, SKJ\AppException\HTTP\ForbiddenException
Namespace: SKJ
Package: SKJ\AppException
Copyright: 2019 Seikouhou.
License: MIT
Author: y3high y3public@49364.net
Since: Class available since Release 0.8.0
Located at AppExceptionInterface.php
Methods summary
public string
# getMessage( )

例外ﾒｯｾｰｼﾞを取得する

例外ﾒｯｾｰｼﾞを取得する

※\Exceptionから継承

Returns

string
例外ﾒｯｾｰｼﾞ文字列

Api
public SKJ\AppExceptionInterface
# getPrevious( )

前の例外を返す

前の例外を返す

※\Exceptionから継承

Returns

SKJ\AppExceptionInterface
前に発生したApp例外､もしくはNULL

Api
public integer
# getCode( )

例外ｺｰﾄﾞを取得する

例外ｺｰﾄﾞを取得する

※\Exceptionから継承

Returns

integer
例外ｺｰﾄﾞ

Api
public string
# getFile( )

例外が作られたﾌｧｲﾙを取得する

例外が作られたﾌｧｲﾙを取得する

※\Exceptionから継承

Returns

string
例外が作られたﾌｧｲﾙの名前

Api
public integer
# getLine( )

例外が作られた行を取得する

例外が作られた行を取得する

※\Exceptionから継承

Returns

integer
例外が作られた行番号

Api
public array
# getTrace( )

ｽﾀｯｸﾄﾚｰｽを取得する

ｽﾀｯｸﾄﾚｰｽを取得する

※\Exceptionから継承

Returns

array
例外のｽﾀｯｸﾄﾚｰｽ

Api
public string
# getTraceAsString( )

ｽﾀｯｸﾄﾚｰｽを文字列で取得する

ｽﾀｯｸﾄﾚｰｽを文字列で取得する

※\Exceptionから継承

Returns

string
例外のｽﾀｯｸﾄﾚｰｽの文字列表現

Api
public array
# getGlobalVars( )

例外生成時のｸﾞﾛｰﾊﾞﾙｽｺｰﾌﾟの変数情報を取得

例外生成時のｸﾞﾛｰﾊﾞﾙｽｺｰﾌﾟの変数情報を取得

Returns

array
ｸﾞﾛｰﾊﾞﾙ変数情報

Api
public array
# getCallerVars( )

例外生成時のﾛｰｶﾙｽｺｰﾌﾟの変数情報を取得

例外生成時のﾛｰｶﾙｽｺｰﾌﾟの変数情報を取得

Returns

array
ﾛｰｶﾙ変数情報

Api
public static integer|null
# getBaseExceptionCode( string $fileName )

基底例外ｺｰﾄﾞを取得

基底例外ｺｰﾄﾞを取得

ﾌｧｲﾙごとにﾕﾆｰｸになる、そのﾌｧｲﾙ中で例外ｺｰﾄﾞの基底とすべき数値を返す

Parameters

$fileName
ﾌｧｲﾙの絶対ﾊﾟｽ

Returns

integer|null
基底例外ｺｰﾄﾞ、もう発行できない場合はnull

Api
public static boolean
# isExtension( )

AppExceptionがｴｸｽﾃﾝｼｮﾝを読み込んでいるかどうか調べる

AppExceptionがｴｸｽﾃﾝｼｮﾝを読み込んでいるかどうか調べる

ｴｸｽﾃﾝｼｮﾝを読み込んでいれば、ｲﾝｽﾀﾝｽ生成時のﾛｰｶﾙｽｺｰﾌﾟの変数情報を取得する事ができる

Returns

boolean
ｴｸｽﾃﾝｼｮﾝを読み込んでいれば真、そうでなければ偽

Api
public string
# getClass( )

現在の例外ｸﾗｽ名を取得

現在の例外ｸﾗｽ名を取得

Returns

string
ｸﾗｽ名

Api
public string
# getFunction( )

例外生成時の例外ﾒｿｯﾄﾞ名を取得

例外生成時の例外ﾒｿｯﾄﾞ名を取得

※これは当然ｺﾝｽﾄﾗｸﾀになる(getFile()、getLine()などに合わせて存在)

Returns

string
関数(ﾒｿｯﾄﾞ)名

Api
public array
# getCallQueue( )

現在のｺｰﾙｷｭｰ情報を取得する

現在のｺｰﾙｷｭｰ情報を取得する

Returns

array
ｺｰﾙｷｭｰ情報

Api
public SKJ\AppExceptionInterface
# forge( array $callQueue = null )

例外生成場所を変更

例外生成場所を変更

例外生成場所をこのﾒｿｯﾄﾞが呼ばれた場所に擬似的に変更する

引数に他のApp例外のｺｰﾙｷｭｰ情報を渡せば、そのApp例外の発生場所と同じにできる

Parameters

$callQueue
self::getCallQueue()で得られるｺｰﾙｷｭｰ情報

Returns

SKJ\AppExceptionInterface
自分自身を返す

Api
public boolean
# wasCreatedInCurrentContext( array $debugBackTrace = null )

この例外の生成場所が現在のｺﾝﾃｷｽﾄに含まれるか調べる

この例外の生成場所が現在のｺﾝﾃｷｽﾄに含まれるか調べる

ここで意味するｺﾝﾃｷｽﾄは当ﾒｿｯﾄﾞをｺｰﾙした箇所の変数のｽｺｰﾌﾟとほぼ同じ範囲だが、include、reuqire、include_once、require_onceでの飛び先は含まないので注意

Parameters

$debugBackTrace
例外生成時のｺｰﾙｷｭｰ情報と比較する為のｺｰﾙｽﾀｯｸ情報、通常は指定してはいけない

Returns

boolean
含まれているのなら真、そうでないのなら偽

Api
public integer|boolean
# getLineInCurrentContext( )

同一ﾌｧｲﾙでの例外発生行を取得

同一ﾌｧｲﾙでの例外発生行を取得

現在の(このﾒｿｯﾄﾞを呼び出した)ｺﾝﾃｷｽﾄから見て、どの行で発生した例外か調べる

Returns

integer|boolean
例外発生行、もしくは取得失敗時に偽

Api
public string|boolean
# getFunctionInCurrentContext( )

同一ﾌｧｲﾙでの例外発生関数名を取得

同一ﾌｧｲﾙでの例外発生関数名を取得

現在の(このﾒｿｯﾄﾞを呼び出した)ｺﾝﾃｷｽﾄから見て、どの関数、ﾒｿｯﾄﾞ呼び出しで発生した例外か調べる

Returns

string|boolean
例外発生関数名、もしくは取得失敗時に偽

Api
public array|boolean
# getFuncArgsInCurrentContext( )

同一ﾌｧｲﾙでの例外発生関数の引数を取得

同一ﾌｧｲﾙでの例外発生関数の引数を取得

現在の(このﾒｿｯﾄﾞを呼び出した)ｺﾝﾃｷｽﾄから見て、この例外が発生した関数、ﾒｿｯﾄﾞの引数を取得する

Returns

array|boolean
例外発生関数の引数、もしくは取得失敗時に偽

Api
public SKJ\AppExceptionInterface
# setFields( string|array $fields )

例外の発生源を識別する情報を設定

例外の発生源を識別する情報を設定

例外の発生源を識別する情報(ﾊﾞﾘﾃﾞｰｼｮﾝｴﾗｰならばｶﾗﾑ名など)を設定する機能だが、特に必要なければ使用しなくとも良い

Parameters

$fields
例外の発生源(複数なら配列や引数を増やす)を識別する情報

Returns

SKJ\AppExceptionInterface
自分自身を返す

Api
public array
# getFields( )

例外の発生源を識別する情報を取得

例外の発生源を識別する情報を取得

例外の発生源を識別する情報(ﾊﾞﾘﾃﾞｰｼｮﾝｴﾗｰならばｶﾗﾑ名など)を取得する機能だが、特に必要なければ使用しなくとも良い

Returns

array
例外の発生源を識別する情報が格納された配列

Api
public SKJ\AppExceptionInterface
# setMessage( string $message )

例外ﾒｯｾｰｼﾞを設定

例外ﾒｯｾｰｼﾞを設定

Parameters

$message
例外ﾒｯｾｰｼﾞ

Returns

SKJ\AppExceptionInterface
自分自身を返す

Api
public SKJ\AppExceptionInterface
# setCode( integer $code )

例外ｺｰﾄﾞを設定

例外ｺｰﾄﾞを設定

int型以外が渡されると既定の例外ｺｰﾄﾞが設定される

Parameters

$code
例外ｺｰﾄﾞ

Returns

SKJ\AppExceptionInterface
自分自身を返す

Api
public SKJ\AppExceptionInterface
# setFile( string $file )

例外が発生したﾌｧｲﾙを設定

例外が発生したﾌｧｲﾙを設定

Parameters

$file
例外が発生したﾌｧｲﾙ

Returns

SKJ\AppExceptionInterface
自分自身を返す

Api
public SKJ\AppExceptionInterface
# setLine( integer $line )

例外が発生した行を設定

例外が発生した行を設定

Parameters

$line
例外が発生した行

Returns

SKJ\AppExceptionInterface
自分自身を返す

Api
public SKJ\AppExceptionInterface
# setStatusCode( mixed $statusCode )

状態ｺｰﾄﾞを設定

状態ｺｰﾄﾞを設定

例外ｺｰﾄﾞとは別に補助的に使用できるｺｰﾄﾞとして自由に利用して下さい

Parameters

$statusCode
状態ｺｰﾄﾞ

Returns

SKJ\AppExceptionInterface
自分自身を返す

Api
public mixed
# getStatusCode( )

状態ｺｰﾄﾞを取得

状態ｺｰﾄﾞを取得

例外ｺｰﾄﾞとは別に補助的に使用できるｺｰﾄﾞとして自由に利用して下さい

Returns

mixed
状態ｺｰﾄﾞ

Api
public Exception|null
# getOriginalException( )

AppExceptionに強制変換される前の例外を取得する

AppExceptionに強制変換される前の例外を取得する

Returns

Exception|null
強制変換される前の例外、未設定ならnull

Api
public string|null
# getOriginalClassName( )

AppExceptionに強制変換される前の例外ｸﾗｽ名を取得する

AppExceptionに強制変換される前の例外ｸﾗｽ名を取得する

Returns

string|null
強制変換される前の例外ｸﾗｽ名、未設定ならnull

Api
public SKJ\AppExceptionInterface
# enableSkipContainer( )

ｲﾃﾚｰﾀとして動作時に\SKJ\AppException\Logic\ContainerExceptionをｽｷｯﾌﾟする

ｲﾃﾚｰﾀとして動作時に\SKJ\AppException\Logic\ContainerExceptionをｽｷｯﾌﾟする

Returns

SKJ\AppExceptionInterface
自分自身を返す

Api
public SKJ\AppExceptionInterface
# disableSkipContainer( )

ｲﾃﾚｰﾀとして動作時に\SKJ\AppException\Logic\ContainerExceptionをｽｷｯﾌﾟしない

ｲﾃﾚｰﾀとして動作時に\SKJ\AppException\Logic\ContainerExceptionをｽｷｯﾌﾟしない

Returns

SKJ\AppExceptionInterface
自分自身を返す

Api
public SKJ\AppExceptionInterface
# setSortOrder( integer $order = self::SORT_ORDER_DESC )

ｲﾃﾚｰﾀとして扱った時の並び順(発生順)を制御

ｲﾃﾚｰﾀとして扱った時の並び順(発生順)を制御

Parameters

$order
並び順

Returns

SKJ\AppExceptionInterface
自分自身を返す

Uses

self::SORT_ORDER_ASC 昇順でｿｰﾄ時に$orderに指定
self::SORT_ORDER_DESC 降順でｿｰﾄ時に$orderに指定

Api
public SKJ\AppExceptionInterface
# resetFilter( )

ｲﾃﾚｰﾀとして扱った時に抽出するｸﾗｽ設定を初期化

ｲﾃﾚｰﾀとして扱った時に抽出するｸﾗｽ設定を初期化

Returns

SKJ\AppExceptionInterface
自分自身を返す

Api
public SKJ\AppExceptionInterface
# setFilter( string|null $className = null )

ｲﾃﾚｰﾀとして扱った時に抽出するｸﾗｽを設定

ｲﾃﾚｰﾀとして扱った時に抽出するｸﾗｽを設定

Parameters

$className
抽出対象となるｸﾗｽ名、null時は現ｲﾝｽﾀﾝｽと同一のｸﾗｽのみ対象とする

Returns

SKJ\AppExceptionInterface
自分自身を返す

Api
public array
# getExceptionLog( )

連結された例外のﾘｽﾄをﾛｸﾞとして返す

連結された例外のﾘｽﾄをﾛｸﾞとして返す

ﾛｸﾞﾌｫｰﾏｯﾄは"[ｸﾗｽ名] -> ﾌｧｲﾙ名(発生行) [例外ｺｰﾄﾞ]例外ﾒｯｾｰｼﾞ\n 文字列化されたｽﾀｯｸﾄﾚｰｽ"となる

Returns

array
ﾛｸﾞﾒｯｾｰｼﾞが格納された配列

Api
public SKJ\AppExceptionInterface|SKJ\AppExceptionInterface|SKJ\AppException\Logic\ContainerException
# renew( array $replacement )

例外再構築処理

例外再構築処理

現在の例外が第1引数に指定された条件(例外ｺｰﾄﾞ)に当てはまるのならば、現在の例外を基に新規例外を作成する

なお、新規例外には現在の例外を連結して返す

第1引数仕様 - 例外再構成情報配列

[
    (int)対象の例外ｺｰﾄﾞ => [
        (int|null)設定する例外ｺｰﾄﾞ(null指定時は元の値から変更しない),
        (string|null)新規作成するAppException系例外ｸﾗｽ名(null指定時は元のｸﾗｽから変更しない),
        (string|null)設定する例外ﾒｯｾｰｼﾞ(null指定時は元の値から変更しない)
    ] | (int)設定する例外ｺｰﾄﾞ | (\SKJ\AppExceptionInterface)置き換えるAppException系例外,...
]

Parameters

$replacement
例外再構成情報配列

Returns

SKJ\AppExceptionInterface|SKJ\AppExceptionInterface|SKJ\AppException\Logic\ContainerException
$replacementに該当する例外ｺｰﾄﾞのｷｰがあれば、そのｴﾝﾄﾘで指定されたAppException系例外、もし該当する例外ｺｰﾄﾞが無い場合は、renew()の呼び出し元と同一ｺﾝﾃｷｽﾄで生成された例外であれば自分自身をそのまま返し、そうでなければ\SKJ\AppException\Logic\ContainerExceptionｸﾗｽのｲﾝｽﾀﾝｽを返す

Api
Methods inherited from IteratorAggregate
getIterator()
Constants summary
integer SORT_ORDER_ASC

このｵﾌﾞｼﾞｪｸﾄをｲﾃﾚｰﾀとして扱った時に返す連結された例外のｿｰﾄ(発生順)定数

このｵﾌﾞｼﾞｪｸﾄをｲﾃﾚｰﾀとして扱った時に返す連結された例外のｿｰﾄ(発生順)定数

Api
# 0
integer SORT_ORDER_DESC

このｵﾌﾞｼﾞｪｸﾄをｲﾃﾚｰﾀとして扱った時に返す連結された例外のｿｰﾄ(発生順)定数

このｵﾌﾞｼﾞｪｸﾄをｲﾃﾚｰﾀとして扱った時に返す連結された例外のｿｰﾄ(発生順)定数

Api
# 1
API documentation generated by ApiGen