snicco/no-robots-middleware

Maintainers

Details

github.com/snicco/no-robots-middleware

Source

Installs: 3 369

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

v2.0.0-beta.9 2024-09-07 14:27 UTC

Requires

Requires (Dev)

Conflicts

LGPL-3.0-only c1cd0a015bed0637edfb23ff10722de83a856e40

  • Calvin Alkan <calvin.woop@snicco.de>

This package is auto-updated.

Last update: 2024-12-07 14:58:01 UTC

README

codecov Psalm Type-Coverage Psalm level PhpMetrics - Static Analysis PHP-Versions

This middleware for the snicco/http-routing component allows you to discourage search-engines from indexing the current request path by using the X-Robots-Tag header.

Installation

composer require snicco/no-robots-middleware

Usage

This middleware can be added globally, in a group or on a per-route basis. Choose what works best for you.

use Snicco\Middleware\NoRobots\NoRobots;

// Disallows robots entirely (noindex,no archive,nofollow)
$configurator->get('route1', '/route1', SomeController::class)
              ->middleware(NoRobots::class);

// noindex, no archive, nofollow header is not added because its set to false.
$configurator->get('route1', '/route1', SomeController::class)
              ->middleware(NoRobots::class. ':true,false,true');

Contributing

This repository is a read-only split of the development repo of the Snicco project.

This is how you can contribute.

Reporting issues and sending pull requests

Please report issues in the Snicco monorepo.

Security

If you discover a security vulnerability, please follow our disclosure procedure.