Download the PHP package rasuvaeff/yii3-turnstile without Composer

On this page you can find all versions of the php package rasuvaeff/yii3-turnstile. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of rasuvaeff/yii3-turnstile

Informations about the package yii3-turnstile

rasuvaeff/yii3-turnstile

Stable Version Total Downloads Build Static analysis Psalm level PHP Русская версия

Cloudflare Turnstile CAPTCHA widget and server-side validator for Yii3.

Provides a Turnstile widget for rendering the challenge in a form and a TurnstileRule / TurnstileRuleHandler pair for server-side verification through the Yii validator pipeline. HTTP calls go through any PSR-18 client.

Using an AI coding assistant? llms.txt contains a compact API reference you can share with the model. Contributors: see AGENTS.md.

Requirements

Requirement Version
PHP ^8.3
A PSR-18 HTTP client + PSR-17 factories any implementation
yiisoft/widget ^2.2
yiisoft/html ^3.13 || ^4.0
yiisoft/validator ^2.5
yiisoft/translator ^3.0
yiisoft/request-provider ^1.3

Installation

You also need a PSR-18 client and PSR-17 factories if your project doesn't already ship one:

DI configuration

Since v1.0.3 the package ships config/bootstrap.php via config-plugin. On every application boot it populates TurnstileRegistry with the handler dependencies, so TurnstileRuleHandler works even with the default SimpleRuleHandlerContainer — no extra DI config required.

If your app already uses RuleHandlerContainer for other reasons, keep it; this package is compatible with both resolvers.

Usage

1. Render the widget in a form

Output:

2. Validate server-side with a validator rule

Field name mapping with Yii3 FormModel

Cloudflare's widget submits the token as cf-turnstile-response (with hyphens) by default. PHP does not normalize hyphens in POST keys, so set withResponseFieldName() to a PHP-compatible name that matches your model property:

The rule sends the token to Cloudflare's siteverify endpoint and reports success/failure through the standard Yii validator Result.

3. Dependency injection (Yii3)

The package ships config/params.php and config/di.php compatible with yiisoft/config. Override params in your application config:

The DI config registers a CategorySource tagged as translation.categorySource. When yiisoft/translator-message-php is installed, it reads message files from messages/<locale>/yii3-turnstile.php. Without it, message IDs are returned as-is.

4. Translations

The package includes Russian translations out of the box:

Locale File
ru messages/ru/yii3-turnstile.php

To add more languages, create messages/<locale>/yii3-turnstile.php:

Components

Turnstile (widget)

Renders the Cloudflare Turnstile HTML + script tag. Extends Yiisoft\Widget\Widget.

Method Description
withSiteKey(string $siteKey): self Cloudflare site key (required).
withTheme(TurnstileTheme $theme): self Auto, Light, or Dark. Default: Auto.
withSize(TurnstileSize $size): self Normal, Compact, Flexible, or Invisible. Default: Normal.
withResponseFieldName(string $name): self Name of the hidden input field. Default: cf-turnstile-response.
withJsApiUrl(string $url): self Override the script URL. Default: Cloudflare CDN.
render(): string Returns the HTML string. Throws if siteKey is not set.

TurnstileConfig

Immutable configuration DTO.

TurnstileClient

Sends the token verification POST to Cloudflare. Requires PSR-18 + PSR-17.

idempotencyKey is an optional UUID that lets you safely re-verify the same token (Cloudflare returns the original result instead of an error); it is only sent when provided. verifyWithSecret() is used by the rule handler when a per-rule secret override is set.

VerificationResult

DTO returned by TurnstileClient::verify().

TurnstileRule / TurnstileRuleHandler

A RuleInterface for the Yii validator. The handler receives TurnstileClient from DI and calls verify() with the token value. When sendRemoteIp is set, the handler reads the client IP from the current request via yiisoft/request-provider (RequestProviderInterface::get(), REMOTE_ADDR server param); if no request is set the IP is simply omitted. Supports skipOnEmpty, skipOnError, and when via standard validator traits.

Method Description
getHandler(): string Returns TurnstileRuleHandler::class.
getMessage(): string Error message on failure.
getSecret(): ?string Override secret (uses DI config if null).
getSendRemoteIp(): bool Whether to forward client IP.

Enums

Enum Values
TurnstileTheme `A
t}o,Light,Dark`
TurnstileSize Normal, Compact, Flexible, Invisible

Security

Examples

See examples/ for runnable scripts.

Script Shows Needs server?
widget.php Rendering the Turnstile widget no
verify.php Server-side token verification no

Development

No PHP/Composer on the host — run in Docker via the composer:2 image:

Or with Make:

CI runs composer build on PHP 8.3, 8.4, and 8.5.

License

BSD-3-Clause

All versions of yii3-turnstile with dependencies

PHP Build Version
Package Version
Requires php Version 8.3 - 8.5
psr/http-client Version ^1.0
psr/http-factory Version ^1.0
psr/http-message Version ^1.0 || ^2.0
yiisoft/html Version ^3.13 || ^4.0
yiisoft/request-provider Version ^1.3
yiisoft/translator Version ^3.0
yiisoft/validator Version ^2.5
yiisoft/widget Version ^2.2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package rasuvaeff/yii3-turnstile contains the following files

Loading the files please wait ...