HumHub Documentation (unofficial)

CaptchaAction extends Action
in package

Application

CaptchaAction renders a CAPTCHA image.

CaptchaAction is used together with [[Captcha]] and [[\yii\captcha\CaptchaValidator]] to provide the CAPTCHA feature.

By configuring the properties of CaptchaAction, you may customize the appearance of the generated CAPTCHA images, such as the font color, the background color, etc.

Note that CaptchaAction requires either GD2 extension or ImageMagick PHP extension.

Using CAPTCHA involves the following steps:

Override [[\yii\web\Controller::actions()]] and register an action of class CaptchaAction with ID 'captcha'
In the form model, declare an attribute to store user-entered verification code, and declare the attribute to be validated by the 'captcha' validator.
In the controller view, insert a [[Captcha]] widget in the form.

Constants

REFRESH_GET_VAR = 'refresh': The name of the GET parameter indicating whether the CAPTCHA image should be regenerated.

Properties

$backColor : int
$behaviors : array<string|int, Behavior>
$controller : Controller|Controller|Controller
$fixedVerifyCode : string|null
$fontFile : string
$foreColor : int
$height : int
$id : string
$imageLibrary : string|null
$maxLength : int
$minLength : int
$offset : int
$padding : int
$testLimit : int
$transparent : bool
$uniqueId : string
$verifyCode : string
$width : int
$_behaviors : array<string|int, Behavior>|null
$_events : array<string|int, mixed>
$_eventWildcards : array<string|int, mixed>

Methods

__call() : mixed: Calls the named method which is not a class method.
__clone() : mixed: This method is called after the object is created by cloning an existing one.
__construct() : mixed: Constructor.
__get() : mixed: Returns the value of a component property.
__isset() : bool: Checks if a property is set, i.e. defined and not null.
__set() : mixed: Sets the value of a component property.
__unset() : mixed: Sets a component property to be null.
attachBehavior() : Behavior: Attaches a behavior to this component.
attachBehaviors() : mixed: Attaches a list of behaviors to the component.
behaviors() : array<string|int, mixed>: Returns a list of behaviors that this component should behave as.
canGetProperty() : bool: Returns a value indicating whether a property can be read.
canSetProperty() : bool: Returns a value indicating whether a property can be set.
className() : string: Returns the fully qualified name of this class.
detachBehavior() : Behavior|null: Detaches a behavior from the component.
detachBehaviors() : mixed: Detaches all behaviors from the component.
ensureBehaviors() : mixed: Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.
generateValidationHash() : string: Generates a hash code that can be used for client-side validation.
getBehavior() : Behavior|null: Returns the named behavior object.
getBehaviors() : array<string|int, Behavior>: Returns all behaviors attached to this component.
getUniqueId() : string: Returns the unique ID of this action among the whole application.
getVerifyCode() : string: Gets the verification code.
hasEventHandlers() : bool: Returns a value indicating whether there is any handler attached to the named event.
hasMethod() : bool: Returns a value indicating whether a method is defined.
hasProperty() : bool: Returns a value indicating whether a property is defined for this component.
init() : mixed: Initializes the action.
off() : bool: Detaches an existing event handler from this component.
on() : mixed: Attaches an event handler to an event.
run() : mixed: Runs the action.
runWithParams() : mixed: Runs this action with the specified parameters.
trigger() : mixed: Triggers an event.
validate() : bool: Validates the input to see if it matches the generated code.
afterRun() : mixed: This method is called right after `run()` is executed.
beforeRun() : bool: This method is called right before `run()` is executed.
generateVerifyCode() : string: Generates a new verification code.
getSessionKey() : string: Returns the session variable name used to store verification code.
renderImage() : string: Renders the CAPTCHA image.
renderImageByGD() : string: Renders the CAPTCHA image based on the code using GD library.
renderImageByImagick() : string: Renders the CAPTCHA image based on the code using ImageMagick library.
setHttpHeaders() : mixed: Sets the HTTP headers needed by image response.
attachBehaviorInternal() : Behavior: Attaches a behavior to this component.

REFRESH_GET_VAR

The name of the GET parameter indicating whether the CAPTCHA image should be regenerated.


    public
        mixed
    REFRESH_GET_VAR
    = 'refresh'

$backColor


    public
        int
    $backColor
     = 0xffffff

the background color. For example, 0x55FF00. Defaults to 0xFFFFFF, meaning white color.

$behaviors read-only


    public
        array<string|int, Behavior>
    $behaviors

List of behaviors attached to this component.

$controller


    public
        Controller|Controller|Controller
    $controller

the controller that owns this action

$fixedVerifyCode


    public
        string|null
    $fixedVerifyCode

the fixed verification code. When this property is set, [[getVerifyCode()]] will always return the value of this property. This is mainly used in automated tests where we want to be able to reproduce the same verification code each time we run the tests. If not set, it means the verification code will be randomly generated.

$fontFile


    public
        string
    $fontFile
     = '@yii/captcha/SpicyRice.ttf'

the TrueType font file. This can be either a file path or path alias.

$foreColor


    public
        int
    $foreColor
     = 0x2040a0

the font color. For example, 0x55FF00. Defaults to 0x2040A0 (blue color).

$height


    public
        int
    $height
     = 50

the height of the generated CAPTCHA image. Defaults to 50.

$id


    public
        string
    $id

ID of the action

$imageLibrary


    public
        string|null
    $imageLibrary

the rendering library to use. Currently supported only 'gd' and 'imagick'. If not set, library will be determined automatically.

$maxLength


    public
        int
    $maxLength
     = 7

the maximum length for randomly generated word. Defaults to 7.

$minLength


    public
        int
    $minLength
     = 6

the minimum length for randomly generated word. Defaults to 6.

$offset


    public
        int
    $offset
     = -2

the offset between characters. Defaults to -2. You can adjust this property in order to decrease or increase the readability of the captcha.

$padding


    public
        int
    $padding
     = 2

padding around the text. Defaults to 2.

$testLimit


    public
        int
    $testLimit
     = 3

how many times should the same CAPTCHA be displayed. Defaults to 3. A value less than or equal to 0 means the test is unlimited (available since version 1.1.2).

$transparent


    public
        bool
    $transparent
     = false

whether to use transparent background. Defaults to false.

$uniqueId read-only


    public
        string
    $uniqueId

The unique ID of this action among the whole application.

$verifyCode read-only


    public
        string
    $verifyCode

The verification code.

$width


    public
        int
    $width
     = 120

the width of the generated CAPTCHA image. Defaults to 120.

$_behaviors


    private
        array<string|int, Behavior>|null
    $_behaviors

the attached behaviors (behavior name => behavior). This is null when not initialized.

$_events


    private
        array<string|int, mixed>
    $_events
     = []

the attached event handlers (event name => handlers)

$_eventWildcards


    private
        array<string|int, mixed>
    $_eventWildcards
     = []

the event handlers attached for wildcard patterns (event name wildcard => handlers)

__call()

Calls the named method which is not a class method.


    public
                    __call(string $name, array<string|int, mixed> $params) : mixed

This method will check if any attached behavior has the named method and will execute it if available.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

Parameters

$name : string: the method name
$params : array<string|int, mixed>: method parameters

Return values

mixed —

the method return value

__clone()

This method is called after the object is created by cloning an existing one.


    public
                    __clone() : mixed

It removes all behaviors because they are attached to the old object.

__construct()

Constructor.


    public
                    __construct(string $id, Controller $controller[, array<string|int, mixed> $config = [] ]) : mixed

Parameters

$id : string: the ID of this action
$controller : Controller: the controller that owns this action
$config : array<string|int, mixed> = []: name-value pairs that will be used to initialize the object properties

__get()

Returns the value of a component property.


    public
                    __get(string $name) : mixed

This method will check in the following order and act accordingly:

a property defined by a getter: return the getter result
a property of a behavior: return the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $component->property;.

Parameters

$name : string: the property name

Return values

mixed —

the property value or the value of a behavior's property

__isset()

Checks if a property is set, i.e. defined and not null.


    public
                    __isset(string $name) : bool

This method will check in the following order and act accordingly:

a property defined by a setter: return whether the property is set
a property of a behavior: return whether the property is set
return false for non existing properties

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($component->property).

Parameters

$name : string: the property name or the event name

Return values

bool —

whether the named property is set

__set()

Sets the value of a component property.


    public
                    __set(string $name, mixed $value) : mixed

This method will check in the following order and act accordingly:

a property defined by a setter: set the property value
an event in the format of "on xyz": attach the handler to the event "xyz"
a behavior in the format of "as xyz": attach the behavior named as "xyz"
a property of a behavior: set the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $component->property = $value;.

Parameters

$name : string: the property name or the event name
$value : mixed: the property value

__unset()

Sets a component property to be null.


    public
                    __unset(string $name) : mixed

This method will check in the following order and act accordingly:

a property defined by a setter: set the property value to be null
a property of a behavior: set the property value to be null

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($component->property).

Parameters

$name : string: the property name

attachBehavior()

Attaches a behavior to this component.


    public
                    attachBehavior(string $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

This method will create the behavior object based on the given configuration. After that, the behavior object will be attached to this component by calling the [[Behavior::attach()]] method.

Parameters

$name : string

the name of the behavior.

$behavior : string|array<string|int, mixed>|Behavior

the behavior configuration. This can be one of the following:

a [[Behavior]] object
a string specifying the behavior class
an object configuration array that will be passed to [[Yii::createObject()]] to create the behavior object.

Return values

Behavior —

the behavior object

attachBehaviors()

Attaches a list of behaviors to the component.


    public
                    attachBehaviors(array<string|int, mixed> $behaviors) : mixed

Each behavior is indexed by its name and should be a [[Behavior]] object, a string specifying the behavior class, or an configuration array for creating the behavior.

Parameters

$behaviors : array<string|int, mixed>: list of behaviors to be attached to the component

behaviors()

Returns a list of behaviors that this component should behave as.


    public
                    behaviors() : array<string|int, mixed>

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

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

Note that a behavior class must extend from [[Behavior]]. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using [[getBehavior()]] or be detached using [[detachBehavior()]]. Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

Return values

array<string|int, mixed> —

the behavior configurations.

canGetProperty()

Returns a value indicating whether a property can be read.


    public
                    canGetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property can be read if:

the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);
an attached behavior has a readable property of the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property can be read

canSetProperty()

Returns a value indicating whether a property can be set.


    public
                    canSetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property can be written if:

the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);
an attached behavior has a writable property of the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property can be written

className()

Returns the fully qualified name of this class.


    public
            static        className() : string

Return values

string —

the fully qualified name of this class.

detachBehavior()

Detaches a behavior from the component.


    public
                    detachBehavior(string $name) : Behavior|null

The behavior's [[Behavior::detach()]] method will be invoked.

Parameters

$name : string: the behavior's name.

Return values

Behavior|null —

the detached behavior. Null if the behavior does not exist.

detachBehaviors()

Detaches all behaviors from the component.


    public
                    detachBehaviors() : mixed

ensureBehaviors()

Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.


    public
                    ensureBehaviors() : mixed

generateValidationHash()

Generates a hash code that can be used for client-side validation.


    public
                    generateValidationHash(string $code) : string

Parameters

$code : string: the CAPTCHA code

Return values

string —

a hash code generated from the CAPTCHA code

getBehavior()

Returns the named behavior object.


    public
                    getBehavior(string $name) : Behavior|null

Parameters

$name : string: the behavior name

Return values

Behavior|null —

the behavior object, or null if the behavior does not exist

getBehaviors()

Returns all behaviors attached to this component.


    public
                    getBehaviors() : array<string|int, Behavior>

Return values

array<string|int, Behavior> —

list of behaviors attached to this component

getUniqueId()

Returns the unique ID of this action among the whole application.


    public
                    getUniqueId() : string

Return values

string —

the unique ID of this action among the whole application.

getVerifyCode()

Gets the verification code.


    public
                    getVerifyCode([bool $regenerate = false ]) : string

Parameters

$regenerate : bool = false: whether the verification code should be regenerated.

Return values

string —

the verification code.

hasEventHandlers()

Returns a value indicating whether there is any handler attached to the named event.


    public
                    hasEventHandlers(string $name) : bool

Parameters

$name : string: the event name

Return values

bool —

whether there is any handler attached to the event.

hasMethod()

Returns a value indicating whether a method is defined.


    public
                    hasMethod(string $name[, bool $checkBehaviors = true ]) : bool

A method is defined if:

the class has a method with the specified name
an attached behavior has a method with the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkBehaviors : bool = true: whether to treat behaviors' methods as methods of this component

Return values

bool —

whether the method is defined

hasProperty()

Returns a value indicating whether a property is defined for this component.


    public
                    hasProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property is defined if:

the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);
an attached behavior has a property of the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property is defined

init()

Initializes the action.


    public
                    init() : mixed

off()

Detaches an existing event handler from this component.


    public
                    off(string $name[, callable|null $handler = null ]) : bool

This method is the opposite of [[on()]].

Note: in case wildcard pattern is passed for event name, only the handlers registered with this wildcard will be removed, while handlers registered with plain names matching this wildcard will remain.

Parameters

$name : string: event name
$handler : callable|null = null: the event handler to be removed. If it is null, all handlers attached to the named event will be removed.

Return values

bool —

if a handler is found and detached

on()

Attaches an event handler to an event.


    public
                    on(string $name, callable $handler[, mixed $data = null ][, bool $append = true ]) : mixed

The event handler must be a valid PHP callback. The following are some examples:

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

The event handler must be defined with the following signature,

function ($event)

where $event is an [[Event]] object which includes parameters associated with the event.

Since 2.0.14 you can specify event name as a wildcard pattern:

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

Parameters

$name : string: the event name
$handler : callable: the event handler
$data : mixed = null: the data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via [[Event::data]].
$append : bool = true: whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list.

run()

Runs the action.


    public
                    run() : mixed

runWithParams()

Runs this action with the specified parameters.


    public
                    runWithParams(array<string|int, mixed> $params) : mixed

This method is mainly invoked by the controller.

Parameters

$params : array<string|int, mixed>: the parameters to be bound to the action's run() method.

Return values

mixed —

the result of the action

trigger()

Triggers an event.


    public
                    trigger(string $name[, Event|null $event = null ]) : mixed

This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.

Parameters

$name : string: the event name
$event : Event|null = null: the event instance. If not set, a default [[Event]] object will be created.

validate()

Validates the input to see if it matches the generated code.


    public
                    validate(string $input, bool $caseSensitive) : bool

Parameters

$input : string: user input
$caseSensitive : bool: whether the comparison should be case-sensitive

Return values

bool —

whether the input is valid

afterRun()

This method is called right after `run()` is executed.


    protected
                    afterRun() : mixed

You may override this method to do post-processing work for the action run.

beforeRun()

This method is called right before `run()` is executed.


    protected
                    beforeRun() : bool

You may override this method to do preparation work for the action run. If the method returns false, it will cancel the action.

Return values

bool —

whether to run the action.

generateVerifyCode()

Generates a new verification code.


    protected
                    generateVerifyCode() : string

Return values

string —

the generated verification code

getSessionKey()

Returns the session variable name used to store verification code.


    protected
                    getSessionKey() : string

Return values

string —

the session variable name

renderImage()

Renders the CAPTCHA image.


    protected
                    renderImage(string $code) : string

Parameters

$code : string: the verification code

Return values

string —

image contents

renderImageByGD()

Renders the CAPTCHA image based on the code using GD library.


    protected
                    renderImageByGD(string $code) : string

Parameters

$code : string: the verification code

Return values

string —

image contents in PNG format.

renderImageByImagick()

Renders the CAPTCHA image based on the code using ImageMagick library.


    protected
                    renderImageByImagick(string $code) : string

Parameters

$code : string: the verification code

Return values

string —

image contents in PNG format.

setHttpHeaders()

Sets the HTTP headers needed by image response.


    protected
                    setHttpHeaders() : mixed

attachBehaviorInternal()

Attaches a behavior to this component.


    private
                    attachBehaviorInternal(string|int $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

Parameters

$name : string|int: the name of the behavior. If this is an integer, it means the behavior is an anonymous one. Otherwise, the behavior is a named one and any existing behavior with the same name will be detached first.
$behavior : string|array<string|int, mixed>|Behavior: the behavior to be attached

Return values

Behavior —

the attached behavior.

CaptchaAction extends Action in package Application

Tags

Table of Contents

Constants

Properties

Methods

Constants

REFRESH_GET_VAR

Properties

$backColor

$behaviors read-only

$controller

$fixedVerifyCode

$fontFile

$foreColor

$height

$id

$imageLibrary

Tags

$maxLength

$minLength

$offset

$padding

$testLimit

$transparent

$uniqueId read-only

$verifyCode read-only

$width

$_behaviors

$_events

$_eventWildcards

Tags

Methods

__call()

Parameters

Tags

Return values

__clone()

__construct()

Parameters

__get()

Parameters

Tags

Return values

__isset()

Parameters

Tags

Return values

__set()

Parameters

Tags

__unset()

Parameters

Tags

attachBehavior()

Parameters

Tags

Return values

attachBehaviors()

Parameters

Tags

behaviors()

Return values

canGetProperty()

Parameters

Tags

Return values

canSetProperty()

Parameters

Tags

Return values

className()

Tags

CaptchaAction extends Action
in package

Application