Class yii\apidoc\helpers\BrokenLinkException

Inheritanceyii\apidoc\helpers\BrokenLinkException » yii\base\Exception » Exception
Available since version2.1.3
Source Code https://github.com/yiisoft/yii2-apidoc/blob/master/helpers/BrokenLinkException.php

BrokenLinkException represents a broken API link.

Property Details

Hide inherited properties

$context public property
public $context = null
$object public property
public $object = null

Method Details

Hide inherited methods

__construct() public method

Constructor.

public __construct( string $object, yii\apidoc\models\TypeDoc|null $context ): mixed
$object string
$context yii\apidoc\models\TypeDoc|null

                public function __construct(public $object, public $context)
{
    $message = 'broken link to ' . $this->object . (($this->context !== null) ? ' in ' . $this->context->name : '');
    parent::__construct($message);
}

            
getName() public method
public getName( ): string
return string

The user-friendly name of this exception

                public function getName()
{
    return 'Broken Link';
}