gordonbanderson / freetextsearch

src/Task/CreateIndexTask.php

<?php declare(strict_types = 1);

namespace Suilven\FreeTextSearch\Task;

use League\CLImate\CLImate;
use SilverStripe\Control\Director;
use SilverStripe\Dev\BuildTask;
use SilverStripe\Security\Permission;
use SilverStripe\Security\Security;
use Suilven\FreeTextSearch\Factory\IndexCreatorFactory;

class CreateIndexTask extends BuildTask
{

    protected $title = 'Create Index';

    protected $description = 'Create an index of a given name';

    protected $enabled = true;

    /** @var string */
    private static $segment = 'create-index';

The private property $segment is not used, and could be removed.

    /**
     * Implement this method in the task subclass to
     * execute via the TaskRunner
     *
     * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
     * @phpcsSuppress SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingAnyTypeHint
     * @param \SilverStripe\Control\HTTPRequest $request
     * @return \SilverStripe\Control\HTTPResponse|void
     */
    public function run($request)
    {
        $climate = new CLImate();

        // check this script is being run by admin
        // @phpstan-ignore-next-line
        $canAccess = (Director::isDev() || Director::is_cli() || Permission::check("ADMIN"));

        // for testing purposes
        $fail = $request->getVar('fail');
        if (!\is_null($fail)) {
            $canAccess = false;
        }

        if (!$canAccess) {
            return Security::permissionFailure(null, 'Permission denied');

The expression return SilverStripe\Security\Security::permissionFailure(null, 'Permission denied') returns the type SilverStripe\Control\HTTPResponse which is incompatible with the return type mandated by SilverStripe\Dev\BuildTask::run() of void.

        }

        $name = $request->getVar('index');
        $climate->info('NAME: ' . $name);

        $factory = new IndexCreatorFactory();
        $indexCreator = $factory->getIndexCreator();

        $indexCreator->createIndex($name);

It seems like $name can also be of type null; however, parameter $indexName of Suilven\FreeTextSearch\Interfaces\IndexCreator::createIndex() does only seem to accept string, maybe add an additional type check?

    }
}