0 关注者

类 yii\captcha\CaptchaAction

继承关系yii\captcha\CaptchaAction » yii\base\Action » yii\base\Component » yii\base\BaseObject
实现接口yii\base\Configurable
可用版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/captcha/CaptchaAction.php

CaptchaAction 渲染验证码图片。

CaptchaAction 与 yii\captcha\Captchayii\captcha\CaptchaValidator 一起使用,以提供 CAPTCHA 功能。

通过配置 CaptchaAction 的属性,您可以自定义生成的验证码图片的外观,例如字体颜色、背景颜色等。

请注意,CaptchaAction 需要 GD2 扩展或 ImageMagick PHP 扩展。

使用 CAPTCHA 包括以下步骤

  1. 重写 yii\web\Controller::actions() 并注册一个类为 CaptchaAction 且 ID 为 'captcha' 的操作。
  2. 在表单模型中,声明一个属性来存储用户输入的验证码,并声明该属性由 'captcha' 验证器进行验证。
  3. 在控制器视图中,在表单中插入 yii\captcha\Captcha 小部件。

公共属性

隐藏继承的属性

属性 类型 描述 定义于
$backColor integer 背景颜色。 yii\captcha\CaptchaAction
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component
$controller yii\base\Controller|yii\web\Controller|yii\console\Controller 拥有此操作的控制器。 yii\base\Action
$fixedVerifyCode string|null 固定的验证码。 yii\captcha\CaptchaAction
$fontFile string TrueType 字体文件。 yii\captcha\CaptchaAction
$foreColor integer 字体颜色。 yii\captcha\CaptchaAction
$height integer 生成的验证码图片的高度。 yii\captcha\CaptchaAction
$id string 操作的 ID yii\base\Action
$imageLibrary string|null 要使用的渲染库。 yii\captcha\CaptchaAction
$maxLength integer 随机生成的单词的最大长度。 yii\captcha\CaptchaAction
$minLength integer 随机生成的单词的最小长度。 yii\captcha\CaptchaAction
$offset integer 字符之间的偏移量。 yii\captcha\CaptchaAction
$padding integer 文本周围的填充。 yii\captcha\CaptchaAction
$testLimit integer 应显示相同验证码的次数。 yii\captcha\CaptchaAction
$transparent boolean 是否使用透明背景。 yii\captcha\CaptchaAction
$uniqueId string 此操作在整个应用程序中的唯一 ID。 yii\base\Action
$verifyCode string 验证码。 yii\captcha\CaptchaAction
$width integer 生成的验证码图片的宽度。 yii\captcha\CaptchaAction

公共方法

隐藏继承的方法

方法 描述 定义于
__call() 调用不是类方法的命名方法。 yii\base\Component
__clone() 此方法在通过克隆现有对象创建对象后被调用。 yii\base\Component
__construct() 构造函数。 yii\base\Action
__get() 返回组件属性的值。 yii\base\Component
__isset() 检查属性是否已设置,即定义且不为 null。 yii\base\Component
__set() 设置组件属性的值。 yii\base\Component
__unset() 将组件属性设置为 null。 yii\base\Component
attachBehavior() 将行为附加到此组件。 yii\base\Component
attachBehaviors() 将行为列表附加到组件。 yii\base\Component
behaviors() 返回此组件应表现为的行为列表。 yii\base\Component
canGetProperty() 返回一个值,指示是否可以读取属性。 yii\base\Component
canSetProperty() 返回一个值,指示是否可以设置属性。 yii\base\Component
className() 返回此类的完全限定名称。 yii\base\BaseObject
detachBehavior() 从组件分离行为。 yii\base\Component
detachBehaviors() 从组件分离所有行为。 yii\base\Component
ensureBehaviors() 确保在 behaviors() 中声明的行为已附加到此组件。 yii\base\Component
generateValidationHash() 生成可用于客户端验证的哈希代码。 yii\captcha\CaptchaAction
getBehavior() 返回命名的行为对象。 yii\base\Component
getBehaviors() 返回附加到此组件的所有行为。 yii\base\Component
getUniqueId() 返回此操作在整个应用程序中的唯一 ID。 yii\base\Action
getVerifyCode() 获取验证码。 yii\captcha\CaptchaAction
hasEventHandlers() 返回一个值,指示是否有任何处理程序附加到命名的事件。 yii\base\Component
hasMethod() 返回一个值,指示方法是否已定义。 yii\base\Component
hasProperty() 返回一个值,指示此组件是否定义了属性。 yii\base\Component
init() 初始化操作。 yii\captcha\CaptchaAction
off() 从此组件分离现有的事件处理程序。 yii\base\Component
on() 将事件处理程序附加到事件。 yii\base\Component
run() 运行操作。 yii\captcha\CaptchaAction
runWithParams() 使用指定的参数运行此操作。 yii\base\Action
trigger() 触发事件。 yii\base\Component
validate() 验证输入以查看它是否与生成的代码匹配。 yii\captcha\CaptchaAction

受保护的方法

隐藏继承的方法

方法 描述 定义于
afterRun() 此方法在 run() 执行后立即调用。 yii\base\Action
beforeRun() 此方法在 run() 执行前立即调用。 yii\base\Action
generateVerifyCode() 生成新的验证码。 yii\captcha\CaptchaAction
getSessionKey() 返回用于存储验证码的会话变量名称。 yii\captcha\CaptchaAction
renderImage() 渲染验证码图片。 yii\captcha\CaptchaAction
renderImageByGD() 使用 GD 库基于代码渲染验证码图片。 yii\captcha\CaptchaAction
renderImageByImagick() 使用 ImageMagick 库基于代码渲染验证码图片。 yii\captcha\CaptchaAction
setHttpHeaders() 设置图像响应所需的 HTTP 标头。 yii\captcha\CaptchaAction

常量

隐藏继承的常量

常量 描述 定义于
REFRESH_GET_VAR 'refresh' 指示是否应重新生成验证码图片的 GET 参数的名称。 yii\captcha\CaptchaAction

属性详情

隐藏继承的属性

$backColor 公共属性

背景颜色。例如,0x55FF00。默认为 0xFFFFFF,表示白色。

public integer $backColor 0xffffff
$fixedVerifyCode 公共属性

固定的验证码。当设置此属性时,getVerifyCode() 将始终返回此属性的值。这主要用于自动化测试,在其中我们希望每次运行测试时都能重现相同的验证码。如果未设置,则表示验证码将随机生成。

$fontFile 公共属性

TrueType 字体文件。这可以是文件路径或路径别名

public string $fontFile '@yii/captcha/SpicyRice.ttf'
$foreColor 公共属性

字体颜色。例如,0x55FF00。默认为 0x2040A0(蓝色)。

public integer $foreColor 0x2040a0
$height 公共属性

生成的验证码图片的高度。默认为 50。

public integer $height 50
$imageLibrary 公共属性 (自版本 2.0.7 起可用)

要使用的渲染库。目前仅支持“gd”和“imagick”。如果未设置,则将自动确定库。

public string|null $imageLibrary null
$maxLength 公共属性

随机生成的单词的最大长度。默认为 7。

public integer $maxLength 7
$minLength 公共属性

随机生成的单词的最小长度。默认为 6。

public integer $minLength 6
$offset 公共属性

字符之间的偏移量。默认为 -2。您可以调整此属性以降低或提高验证码的可读性。

public integer $offset = -2
$padding 公共属性

文本周围的填充。默认为 2。

public integer $padding 2
$testLimit 公共属性

应显示相同验证码的次数。默认为 3。小于或等于 0 的值表示测试是无限的(自版本 1.1.2 起可用)。

public integer $testLimit 3
$transparent 公共属性

是否使用透明背景。默认为 false。

public boolean $transparent false
$verifyCode 公共属性

验证码。

public string $verifyCode null
$width 公共属性

生成的验证码图片的宽度。默认为 120。

public integer $width 120

方法详情

隐藏继承的方法

__call() 公共方法

定义于: yii\base\Component::__call()

调用不是类方法的命名方法。

此方法将检查任何附加的行为是否具有指定的方法,如果可用,则执行它。

不要直接调用此方法,因为它是一个 PHP 魔术方法,当调用未知方法时会隐式调用它。

public mixed __call ( $name, $params )
$name string

方法名

$params 数组

方法参数

返回值 混合

方法返回值

抛出 yii\base\UnknownMethodException

调用未知方法时

                public function __call($name, $params)
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $object) {
        if ($object->hasMethod($name)) {
            return call_user_func_array([$object, $name], $params);
        }
    }
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

            
__clone() 公共方法

定义于: yii\base\Component::__clone()

此方法在通过克隆现有对象创建对象后被调用。

它会移除所有行为,因为它们附加到了旧对象上。

public void __clone ( )

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}

            
__construct() 公共方法

定义于: yii\base\Action::__construct()

构造函数。

public void __construct ( $id, $controller, $config = [] )
$id string

此操作的 ID

$controller yii\base\Controller

拥有此操作的控制器。

$config 数组

将用于初始化对象属性的名称-值对

                public function __construct($id, $controller, $config = [])
{
    $this->id = $id;
    $this->controller = $controller;
    parent::__construct($config);
}

            
__get() 公共方法

定义于: yii\base\Component::__get()

返回组件属性的值。

此方法将按以下顺序检查并相应地执行

  • 由 getter 定义的属性:返回 getter 的结果
  • 行为的属性:返回行为属性的值

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 $value = $component->property; 时会隐式调用。

另请参阅 __set()

public mixed __get ( $name )
$name string

属性名称

返回值 混合

属性值或行为属性的值

抛出 yii\base\UnknownPropertyException

如果未定义属性

抛出 yii\base\InvalidCallException

如果属性是只写属性。

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        // read property, e.g. getName()
        return $this->$getter();
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name;
        }
    }
    if (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}

            
__isset() 公共方法

定义于: yii\base\Component::__isset()

检查属性是否已设置,即定义且不为 null。

此方法将按以下顺序检查并相应地执行

  • 由 setter 定义的属性:返回属性是否已设置
  • 行为的属性:返回属性是否已设置
  • 对于不存在的属性,返回 false

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 isset($component->property) 时会隐式调用。

另请参阅 https://php.ac.cn/manual/en/function.isset.php

public boolean __isset ( $name )
$name string

属性名称或事件名称

返回值 boolean

命名的属性是否已设置

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name !== null;
        }
    }
    return false;
}

            
__set() 公共方法

定义于: yii\base\Component::__set()

设置组件属性的值。

此方法将按以下顺序检查并相应地执行

  • 由 setter 定义的属性:设置属性值
  • 格式为“on xyz”的事件:将处理程序附加到事件“xyz”
  • 格式为“as xyz”的行为:附加名为“xyz”的行为
  • 行为的属性:设置行为属性的值

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 $component->property = $value; 时会隐式调用。

另请参阅 __get()

public void __set ( $name, $value )
$name string

属性名称或事件名称

$value 混合

属性值

抛出 yii\base\UnknownPropertyException

如果未定义属性

抛出 yii\base\InvalidCallException

如果属性是只读属性。

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        // set property
        $this->$setter($value);
        return;
    } elseif (strncmp($name, 'on ', 3) === 0) {
        // on event: attach event handler
        $this->on(trim(substr($name, 3)), $value);
        return;
    } elseif (strncmp($name, 'as ', 3) === 0) {
        // as behavior: attach behavior
        $name = trim(substr($name, 3));
        $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = $value;
            return;
        }
    }
    if (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}

            
__unset() 公共方法

定义于: yii\base\Component::__unset()

将组件属性设置为 null。

此方法将按以下顺序检查并相应地执行

  • 由 setter 定义的属性:将属性值设置为 null
  • 行为的属性:将属性值设置为 null

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 unset($component->property) 时会隐式调用。

另请参阅 https://php.ac.cn/manual/en/function.unset.php

public void __unset ( $name )
$name string

属性名称

抛出 yii\base\InvalidCallException

如果属性是只读属性。

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = null;
            return;
        }
    }
    throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}

            
afterRun() 受保护方法

定义于: yii\base\Action::afterRun()

此方法在 run() 执行后立即调用。

您可以覆盖此方法来对操作运行执行后处理工作。

protected void afterRun ( )

                protected function afterRun()
{
}

            
attachBehavior() 公共方法

定义于: yii\base\Component::attachBehavior()

将行为附加到此组件。

此方法将根据给定的配置创建行为对象。之后,行为对象将通过调用 yii\base\Behavior::attach() 方法附加到此组件。

另请参阅 detachBehavior()

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name string

行为的名称。

$behavior string|array|yii\base\Behavior

行为配置。可以是以下之一:

返回值 yii\base\Behavior

行为对象

                public function attachBehavior($name, $behavior)
{
    $this->ensureBehaviors();
    return $this->attachBehaviorInternal($name, $behavior);
}

            
attachBehaviors() 公共方法

定义于: yii\base\Component::attachBehaviors()

将行为列表附加到组件。

每个行为都由其名称索引,并且应为 yii\base\Behavior 对象、指定行为类的字符串或用于创建行为的配置数组。

另请参阅 attachBehavior()

public void attachBehaviors ( $behaviors )
$behaviors 数组

要附加到组件的行为列表

                public function attachBehaviors($behaviors)
{
    $this->ensureBehaviors();
    foreach ($behaviors as $name => $behavior) {
        $this->attachBehaviorInternal($name, $behavior);
    }
}

            
beforeRun() 受保护方法

定义于: yii\base\Action::beforeRun()

此方法在 run() 执行前立即调用。

您可以覆盖此方法来为操作运行执行准备工作。如果此方法返回 false,它将取消操作。

protected boolean beforeRun ( )
返回值 boolean

是否运行操作。

                protected function beforeRun()
{
    return true;
}

            
behaviors() 公共方法

定义于: yii\base\Component::behaviors()

返回此组件应表现为的行为列表。

子类可以重写此方法来指定它们希望表现出的行为。

此方法的返回值应为一个行为对象或配置数组,以行为名称作为索引。行为配置可以是指定行为类的字符串,也可以是以下结构的数组

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

请注意,行为类必须扩展自 yii\base\Behavior。行为可以使用名称或匿名方式附加。当使用名称作为数组键时,可以使用此名称,稍后可以使用 getBehavior() 获取行为,或使用 detachBehavior() 分离行为。匿名行为无法检索或分离。

在此方法中声明的行为将自动附加到组件(按需)。

public array behaviors ( )
返回值 数组

行为配置。

                public function behaviors()
{
    return [];
}

            
canGetProperty() 公共方法

定义于: yii\base\Component::canGetProperty()

返回一个值,指示是否可以读取属性。

如果属性可以读取,则

  • 类具有与指定名称关联的 getter 方法(在这种情况下,属性名称不区分大小写);
  • 类具有与指定名称相同的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的可读属性(当 $checkBehaviors 为 true 时)。

另请参阅 canSetProperty()

public boolean canGetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

是否将行为的属性视为此组件的属性

返回值 boolean

属性是否可读

                public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
canSetProperty() 公共方法

定义于: yii\base\Component::canSetProperty()

返回一个值,指示是否可以设置属性。

如果属性可以写入,则

  • 类具有与指定名称关联的 setter 方法(在这种情况下,属性名称不区分大小写);
  • 类具有与指定名称相同的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的可写属性(当 $checkBehaviors 为 true 时)。

另请参阅 canGetProperty()

public boolean canSetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

是否将行为的属性视为此组件的属性

返回值 boolean

属性是否可写

                public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
className() 公共静态方法
自 2.0.14 版起已弃用。在 PHP >=5.5 中,请改用 ::class

定义于: yii\base\BaseObject::className()

返回此类的完全限定名称。

public static string className ( )
返回值 string

此类的完全限定名称。

                public static function className()
{
    return get_called_class();
}

            
detachBehavior() 公共方法

定义于: yii\base\Component::detachBehavior()

从组件分离行为。

将调用行为的 yii\base\Behavior::detach() 方法。

public yii\base\Behavior|null detachBehavior ( $name )
$name string

行为的名称。

返回值 yii\base\Behavior|null

分离的行为。如果行为不存在,则为 null。

                public function detachBehavior($name)
{
    $this->ensureBehaviors();
    if (isset($this->_behaviors[$name])) {
        $behavior = $this->_behaviors[$name];
        unset($this->_behaviors[$name]);
        $behavior->detach();
        return $behavior;
    }
    return null;
}

            
detachBehaviors() 公共方法

定义于: yii\base\Component::detachBehaviors()

从组件分离所有行为。

public void detachBehaviors ( )

                public function detachBehaviors()
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $name => $behavior) {
        $this->detachBehavior($name);
    }
}

            
ensureBehaviors() 公共方法

定义于: yii\base\Component::ensureBehaviors()

确保在 behaviors() 中声明的行为已附加到此组件。

public void ensureBehaviors ( )

                public function ensureBehaviors()
{
    if ($this->_behaviors === null) {
        $this->_behaviors = [];
        foreach ($this->behaviors() as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }
}

            
generateValidationHash() 公共方法

生成可用于客户端验证的哈希代码。

public string generateValidationHash ( $code )
$code string

验证码

返回值 string

从验证码生成的哈希代码

                public function generateValidationHash($code)
{
    for ($h = 0, $i = strlen($code) - 1; $i >= 0; --$i) {
        $h += ord($code[$i]) << $i;
    }
    return $h;
}

            
generateVerifyCode() 受保护方法

生成新的验证码。

protected string generateVerifyCode ( )
返回值 string

生成的验证码

                protected function generateVerifyCode()
{
    if ($this->minLength > $this->maxLength) {
        $this->maxLength = $this->minLength;
    }
    if ($this->minLength < 3) {
        $this->minLength = 3;
    }
    if ($this->maxLength > 20) {
        $this->maxLength = 20;
    }
    $length = random_int($this->minLength, $this->maxLength);
    $letters = 'bcdfghjklmnpqrstvwxyz';
    $vowels = 'aeiou';
    $code = '';
    for ($i = 0; $i < $length; ++$i) {
        if ($i % 2 && random_int(0, 10) > 2 || !($i % 2) && random_int(0, 10) > 9) {
            $code .= $vowels[random_int(0, 4)];
        } else {
            $code .= $letters[random_int(0, 20)];
        }
    }
    return $code;
}

            
getBehavior() 公共方法

定义于: yii\base\Component::getBehavior()

返回命名的行为对象。

public yii\base\Behavior|null getBehavior ( $name )
$name string

行为名称

返回值 yii\base\Behavior|null

行为对象,如果行为不存在,则为 null

                public function getBehavior($name)
{
    $this->ensureBehaviors();
    return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}

            
getBehaviors() 公共方法

定义于: yii\base\Component::getBehaviors()

返回附加到此组件的所有行为。

public yii\base\Behavior[] getBehaviors ( )
返回值 yii\base\Behavior[]

附加到此组件的行为列表

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}

            
getSessionKey() 受保护方法

返回用于存储验证码的会话变量名称。

protected string getSessionKey ( )
返回值 string

会话变量名称

                protected function getSessionKey()
{
    return '__captcha/' . $this->getUniqueId();
}

            
getUniqueId() 公共方法

定义于: yii\base\Action::getUniqueId()

返回此操作在整个应用程序中的唯一 ID。

public string getUniqueId ( )
返回值 string

此操作在整个应用程序中的唯一 ID。

                public function getUniqueId()
{
    return $this->controller->getUniqueId() . '/' . $this->id;
}

            
getVerifyCode() 公共方法

获取验证码。

public string getVerifyCode ( $regenerate false )
$regenerate boolean

是否应该重新生成验证码。

返回值 string

验证码。

                public function getVerifyCode($regenerate = false)
{
    if ($this->fixedVerifyCode !== null) {
        return $this->fixedVerifyCode;
    }
    $session = Yii::$app->getSession();
    $session->open();
    $name = $this->getSessionKey();
    if ($session[$name] === null || $regenerate) {
        $session[$name] = $this->generateVerifyCode();
        $session[$name . 'count'] = 1;
    }
    return $session[$name];
}

            
hasEventHandlers() 公共方法

定义于: yii\base\Component::hasEventHandlers()

返回一个值,指示是否有任何处理程序附加到命名的事件。

public boolean hasEventHandlers ( $name )
$name string

事件名称

返回值 boolean

是否有任何处理程序附加到事件。

                public function hasEventHandlers($name)
{
    $this->ensureBehaviors();
    if (!empty($this->_events[$name])) {
        return true;
    }
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
            return true;
        }
    }
    return Event::hasHandlers($this, $name);
}

            
hasMethod() 公共方法

定义于: yii\base\Component::hasMethod()

返回一个值,指示方法是否已定义。

如果定义了方法

  • 该类具有指定名称的方法
  • 附加的行为具有给定名称的方法(当$checkBehaviors为真时)。
public boolean hasMethod ( $name, $checkBehaviors true )
$name string

属性名称

$checkBehaviors boolean

是否将行为的方法视为此组件的方法

返回值 boolean

方法是否已定义

                public function hasMethod($name, $checkBehaviors = true)
{
    if (method_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->hasMethod($name)) {
                return true;
            }
        }
    }
    return false;
}

            
hasProperty() 公共方法

定义于: yii\base\Component::hasProperty()

返回一个值,指示此组件是否定义了属性。

如果定义了属性

  • 该类具有与指定名称关联的 getter 或 setter 方法(在这种情况下,属性名称不区分大小写);
  • 类具有与指定名称相同的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的属性(当$checkBehaviors为真时)。

另请参阅

public boolean hasProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

是否将行为的属性视为此组件的属性

返回值 boolean

属性是否已定义

                public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
    return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}

            
init() 公共方法

初始化操作。

public void init ( )
抛出 yii\base\InvalidConfigException

如果字体文件不存在。

                public function init()
{
    $this->fontFile = Yii::getAlias($this->fontFile);
    if (!is_file($this->fontFile)) {
        throw new InvalidConfigException("The font file does not exist: {$this->fontFile}");
    }
}

            
off() 公共方法

定义于: yii\base\Component::off()

从此组件分离现有的事件处理程序。

此方法与 on() 相反。

注意:如果为事件名称传递了通配符模式,则只会删除使用此通配符注册的处理程序,而使用与该通配符匹配的普通名称注册的处理程序将保留。

另请参阅 on()

public boolean off ( $name, $handler null )
$name string

事件名称

$handler callable|null

要移除的事件处理程序。如果为 null,则将移除附加到指定事件的所有处理程序。

返回值 boolean

如果找到并分离了处理程序

                public function off($name, $handler = null)
{
    $this->ensureBehaviors();
    if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
        return false;
    }
    if ($handler === null) {
        unset($this->_events[$name], $this->_eventWildcards[$name]);
        return true;
    }
    $removed = false;
    // plain event names
    if (isset($this->_events[$name])) {
        foreach ($this->_events[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_events[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_events[$name] = array_values($this->_events[$name]);
            return true;
        }
    }
    // wildcard event names
    if (isset($this->_eventWildcards[$name])) {
        foreach ($this->_eventWildcards[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_eventWildcards[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
            // remove empty wildcards to save future redundant regex checks:
            if (empty($this->_eventWildcards[$name])) {
                unset($this->_eventWildcards[$name]);
            }
        }
    }
    return $removed;
}

            
on() 公共方法

定义于: yii\base\Component::on()

将事件处理程序附加到事件。

事件处理程序必须是有效的 PHP 回调。以下是一些示例

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

事件处理程序必须使用以下签名定义,

function ($event)

其中$eventyii\base\Event 对象,其中包含与事件关联的参数。

从 2.0.14 开始,您可以将事件名称指定为通配符模式

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

另请参阅 off()

public void on ( $name, $handler, $data null, $append true )
$name string

事件名称

$handler callable

事件处理程序

$data 混合

触发事件时传递给事件处理程序的数据。当调用事件处理程序时,可以通过 yii\base\Event::$data 访问此数据。

$append boolean

是否将新的事件处理程序附加到现有处理程序列表的末尾。如果为 false,则新的处理程序将插入到现有处理程序列表的开头。

                public function on($name, $handler, $data = null, $append = true)
{
    $this->ensureBehaviors();
    if (strpos($name, '*') !== false) {
        if ($append || empty($this->_eventWildcards[$name])) {
            $this->_eventWildcards[$name][] = [$handler, $data];
        } else {
            array_unshift($this->_eventWildcards[$name], [$handler, $data]);
        }
        return;
    }
    if ($append || empty($this->_events[$name])) {
        $this->_events[$name][] = [$handler, $data];
    } else {
        array_unshift($this->_events[$name], [$handler, $data]);
    }
}

            
renderImage() 受保护方法

渲染验证码图片。

protected string renderImage ( $code )
$code string

验证码

返回值 string

图像内容

抛出 yii\base\InvalidConfigException

如果 imageLibrary 不受支持

                protected function renderImage($code)
{
    if (isset($this->imageLibrary)) {
        $imageLibrary = $this->imageLibrary;
    } else {
        $imageLibrary = Captcha::checkRequirements();
    }
    if ($imageLibrary === 'gd') {
        return $this->renderImageByGD($code);
    } elseif ($imageLibrary === 'imagick') {
        return $this->renderImageByImagick($code);
    }
    throw new InvalidConfigException("Defined library '{$imageLibrary}' is not supported");
}

            
renderImageByGD() 受保护方法

使用 GD 库基于代码渲染验证码图片。

protected string renderImageByGD ( $code )
$code string

验证码

返回值 string

PNG 格式的图像内容。

                protected function renderImageByGD($code)
{
    $image = imagecreatetruecolor($this->width, $this->height);
    $backColor = imagecolorallocate(
        $image,
        (int) ($this->backColor % 0x1000000 / 0x10000),
        (int) ($this->backColor % 0x10000 / 0x100),
        $this->backColor % 0x100
    );
    imagefilledrectangle($image, 0, 0, $this->width - 1, $this->height - 1, $backColor);
    imagecolordeallocate($image, $backColor);
    if ($this->transparent) {
        imagecolortransparent($image, $backColor);
    }
    $foreColor = imagecolorallocate(
        $image,
        (int) ($this->foreColor % 0x1000000 / 0x10000),
        (int) ($this->foreColor % 0x10000 / 0x100),
        $this->foreColor % 0x100
    );
    $length = strlen($code);
    $box = imagettfbbox(30, 0, $this->fontFile, $code);
    $w = $box[4] - $box[0] + $this->offset * ($length - 1);
    $h = $box[1] - $box[5];
    $scale = min(($this->width - $this->padding * 2) / $w, ($this->height - $this->padding * 2) / $h);
    $x = 10;
    $y = round($this->height * 27 / 40);
    for ($i = 0; $i < $length; ++$i) {
        $fontSize = (int) (random_int(26, 32) * $scale * 0.8);
        $angle = random_int(-10, 10);
        $letter = $code[$i];
        $box = imagettftext($image, $fontSize, $angle, $x, $y, $foreColor, $this->fontFile, $letter);
        $x = $box[2] + $this->offset;
    }
    imagecolordeallocate($image, $foreColor);
    ob_start();
    imagepng($image);
    imagedestroy($image);
    return ob_get_clean();
}

            
renderImageByImagick() 受保护方法

使用 ImageMagick 库基于代码渲染验证码图片。

protected string renderImageByImagick ( $code )
$code string

验证码

返回值 string

PNG 格式的图像内容。

                protected function renderImageByImagick($code)
{
    $backColor = $this->transparent ? new \ImagickPixel('transparent') : new \ImagickPixel('#' . str_pad(dechex($this->backColor), 6, 0, STR_PAD_LEFT));
    $foreColor = new \ImagickPixel('#' . str_pad(dechex($this->foreColor), 6, 0, STR_PAD_LEFT));
    $image = new \Imagick();
    $image->newImage($this->width, $this->height, $backColor);
    $draw = new \ImagickDraw();
    $draw->setFont($this->fontFile);
    $draw->setFontSize(30);
    $fontMetrics = $image->queryFontMetrics($draw, $code);
    $length = strlen($code);
    $w = (int) $fontMetrics['textWidth'] - 8 + $this->offset * ($length - 1);
    $h = (int) $fontMetrics['textHeight'] - 8;
    $scale = min(($this->width - $this->padding * 2) / $w, ($this->height - $this->padding * 2) / $h);
    $x = 10;
    $y = round($this->height * 27 / 40);
    for ($i = 0; $i < $length; ++$i) {
        $draw = new \ImagickDraw();
        $draw->setFont($this->fontFile);
        $draw->setFontSize((int) (random_int(26, 32) * $scale * 0.8));
        $draw->setFillColor($foreColor);
        $image->annotateImage($draw, $x, $y, random_int(-10, 10), $code[$i]);
        $fontMetrics = $image->queryFontMetrics($draw, $code[$i]);
        $x += (int) $fontMetrics['textWidth'] + $this->offset;
    }
    $image->setImageFormat('png');
    return $image->getImageBlob();
}

            
run() 公共方法

运行操作。

public void run ( )

                public function run()
{
    if (Yii::$app->request->getQueryParam(self::REFRESH_GET_VAR) !== null) {
        // AJAX request for regenerating code
        $code = $this->getVerifyCode(true);
        Yii::$app->response->format = Response::FORMAT_JSON;
        return [
            'hash1' => $this->generateValidationHash($code),
            'hash2' => $this->generateValidationHash(strtolower($code)),
            // we add a random 'v' parameter so that FireFox can refresh the image
            // when src attribute of image tag is changed
            'url' => Url::to([$this->id, 'v' => uniqid('', true)]),
        ];
    }
    $this->setHttpHeaders();
    Yii::$app->response->format = Response::FORMAT_RAW;
    return $this->renderImage($this->getVerifyCode());
}

            
runWithParams() 公共方法

定义于: yii\base\Action::runWithParams()

使用指定的参数运行此操作。

此方法主要由控制器调用。

public 混合 runWithParams ( $params )
$params 数组

要绑定到操作的 run() 方法的参数。

返回值 混合

操作的结果

抛出 yii\base\InvalidConfigException

如果操作类没有 run() 方法

                public function runWithParams($params)
{
    if (!method_exists($this, 'run')) {
        throw new InvalidConfigException(get_class($this) . ' must define a "run()" method.');
    }
    $args = $this->controller->bindActionParams($this, $params);
    Yii::debug('Running action: ' . get_class($this) . '::run(), invoked by ' . get_class($this->controller), __METHOD__);
    if (Yii::$app->requestedParams === null) {
        Yii::$app->requestedParams = $args;
    }
    if ($this->beforeRun()) {
        $result = call_user_func_array([$this, 'run'], $args);
        $this->afterRun();
        return $result;
    }
    return null;
}

            
setHttpHeaders() 受保护方法

设置图像响应所需的 HTTP 标头。

protected void setHttpHeaders ( )

                protected function setHttpHeaders()
{
    Yii::$app->getResponse()->getHeaders()
        ->set('Pragma', 'public')
        ->set('Expires', '0')
        ->set('Cache-Control', 'must-revalidate, post-check=0, pre-check=0')
        ->set('Content-Transfer-Encoding', 'binary')
        ->set('Content-type', 'image/png');
}

            
trigger() 公共方法

定义于: yii\base\Component::trigger()

触发事件。

此方法表示事件的发生。它调用事件的所有附加处理程序,包括类级处理程序。

public void trigger ( $name, yii\base\Event $event null )
$name string

事件名称

$event yii\base\Event|null

事件实例。如果未设置,将创建一个默认的 yii\base\Event 对象。

                public function trigger($name, Event $event = null)
{
    $this->ensureBehaviors();
    $eventHandlers = [];
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (StringHelper::matchWildcard($wildcard, $name)) {
            $eventHandlers[] = $handlers;
        }
    }
    if (!empty($this->_events[$name])) {
        $eventHandlers[] = $this->_events[$name];
    }
    if (!empty($eventHandlers)) {
        $eventHandlers = call_user_func_array('array_merge', $eventHandlers);
        if ($event === null) {
            $event = new Event();
        }
        if ($event->sender === null) {
            $event->sender = $this;
        }
        $event->handled = false;
        $event->name = $name;
        foreach ($eventHandlers as $handler) {
            $event->data = $handler[1];
            call_user_func($handler[0], $event);
            // stop further handling if the event is handled
            if ($event->handled) {
                return;
            }
        }
    }
    // invoke class-level attached handlers
    Event::trigger($this, $name, $event);
}

            
validate() 公共方法

验证输入以查看它是否与生成的代码匹配。

public 布尔值 validate ( $input, $caseSensitive )
$input string

用户输入

$caseSensitive boolean

比较是否区分大小写

返回值 boolean

输入是否有效

                public function validate($input, $caseSensitive)
{
    $code = $this->getVerifyCode();
    $valid = $caseSensitive ? ($input === $code) : strcasecmp($input, $code) === 0;
    $session = Yii::$app->getSession();
    $session->open();
    $name = $this->getSessionKey() . 'count';
    $session[$name] += 1;
    if ($valid || $session[$name] > $this->testLimit && $this->testLimit > 0) {
        $this->getVerifyCode(true);
    }
    return $valid;
}