Modernise code

[mrliptontea]

• Precursor to PLT-951
  • Modernise codebase with PHPStan, PHP CS Fixer, and Rector
  • Drop PHP 7.3
  • Use PHP 7.4 features
  • Strict types where possible
  • Resolve todo: use ObjectId->getTimestamp()

Used rector.php

<?php

declare(strict_types=1);

use Rector\CodeQuality\Rector\Empty_\SimplifyEmptyCheckOnEmptyArrayRector;
use Rector\CodeQuality\Rector\Identical\FlipTypeControlToUseExclusiveTypeRector;
use Rector\CodingStyle\Rector\Catch_\CatchExceptionNameMatchingTypeRector;
use Rector\CodingStyle\Rector\ClassMethod\MakeInheritedMethodVisibilitySameAsParentRector;
use Rector\CodingStyle\Rector\PostInc\PostIncDecToPreIncDecRector;
use Rector\Config\RectorConfig;
use Rector\Naming\Rector\Assign\RenameVariableToMatchMethodCallReturnTypeRector;
use Rector\Naming\Rector\Class_\RenamePropertyToMatchTypeRector;
use Rector\Naming\Rector\ClassMethod\RenameParamToMatchTypeRector;
use Rector\Naming\Rector\ClassMethod\RenameVariableToMatchNewTypeRector;
use Rector\Naming\Rector\Foreach_\RenameForeachValueVariableToMatchExprVariableRector;
use Rector\Privatization\Rector\Class_\FinalizeTestCaseClassRector;
use Rector\Strict\Rector\Empty_\DisallowedEmptyRuleFixerRector;
use Rector\TypeDeclaration\Rector\ClassMethod\ParamTypeByMethodCallTypeRector;
use Rector\TypeDeclarationDocblocks\Rector\Class_\AddReturnDocblockDataProviderRector;
use Rector\TypeDeclarationDocblocks\Rector\ClassMethod\AddParamArrayDocblockFromDimFetchAccessRector;
use Rector\TypeDeclarationDocblocks\Rector\ClassMethod\DocblockReturnArrayFromDirectArrayInstanceRector;

return RectorConfig::configure()
    ->withPaths([
        __DIR__ . '/scripts',
        __DIR__ . '/src',
        __DIR__ . '/test',
    ])
    ->withBootstrapFiles([
        __DIR__ . '/src/tripod.inc.php',
    ])
    ->withPhpSets(php74: true)
    ->withPreparedSets(
        deadCode: true,
        codeQuality: true,
        codingStyle: true,
        typeDeclarations: true,
        typeDeclarationDocblocks: true,
        privatization: true,
        naming: true,
        instanceOf: true,
        earlyReturn: true,
        rectorPreset: true,
        phpunitCodeQuality: true,
    )
    ->withSkip([
        AddReturnDocblockDataProviderRector::class,
        CatchExceptionNameMatchingTypeRector::class,
        DisallowedEmptyRuleFixerRector::class,
        FinalizeTestCaseClassRector::class,
        MakeInheritedMethodVisibilitySameAsParentRector::class,
        ParamTypeByMethodCallTypeRector::class,
        PostIncDecToPreIncDecRector::class,
        RenameForeachValueVariableToMatchExprVariableRector::class,
        RenameParamToMatchTypeRector::class,
        RenamePropertyToMatchTypeRector::class,
        RenameVariableToMatchMethodCallReturnTypeRector::class,
        RenameVariableToMatchNewTypeRector::class,
        SimplifyEmptyCheckOnEmptyArrayRector::class,
        FlipTypeControlToUseExclusiveTypeRector::class,
        AddParamArrayDocblockFromDimFetchAccessRector::class,
        DocblockReturnArrayFromDirectArrayInstanceRector::class,
    ])
;

[astilla]

I'd long since forgotten and existed in PHP...!

[astilla]

Why does the docblock type it as a TriplePredicate but in the function it types it as a string ?

[mrliptontea]

Types like TriplePredicate, ObjectValue are PHPStan type aliases, defined here:

tripod-php/src/classes/ExtendedGraph.php

Lines 12 to 17 in 2adc875

	* @phpstan-type ObjectResource string
	* @phpstan-type ObjectLiteral string|int|float|bool
	* @phpstan-type ObjectType 'bnode'|'uri'|'literal'
	* @phpstan-type ObjectValue ObjectResource|ObjectLiteral
	* @phpstan-type TripleSubject string
	* @phpstan-type TriplePredicate string

(though language servers in PHPStorm, Intelephense in VSCode, etc. also interpret them and provide completions based on them)

I'm using TriplePredicate for consistency, even though it translates to just string. This helps make a better sense of what's inside the object, which is especially visible here:

tripod-php/src/classes/ExtendedGraph.php

Line 19 in 2adc875

* @phpstan-type TripleGraph array<TripleSubject, array<TriplePredicate, TripleObject[]>>

I think this enhances the reading experience as you can quickly find where predicates are referenced, such as here:

tripod-php/src/classes/ExtendedGraph.php

Lines 954 to 956 in 2adc875

	* @return TriplePredicate[] list of property URIs
	*/
	public function get_subject_properties(string $s, bool $distinct = true): array

So you know it's not just an array being returned, it's an array of predicates.

[astilla]

Same question as above, but TripleSubject vs. string

[mrliptontea]

See above

[astilla]

Woop woop

[astilla]

Well...it's massive... 🤣
Looks like some good automated updates.
I've left a couple of questions I wasn't sure about a difference in typing between docblock and function param definition.
Other than than it looks sane but being so big I've somewhat skimmed it.