voku

Code is clean if it can be understood easily – by everyone on the team. Clean code can be read and enhanced by a developer other than its original author. With understandability comes readability, changeability, extensibility and maintainability.

---

General rules

1. Follow standard conventions.
2. Keep it simple stupid. Simpler is always better. Reduce complexity as much as possible.
3. Boy scout rule. Leave the campground cleaner than you found it.
4. Always find root cause. Always look for the root cause of a problem.

Design rules

voku

Custom Hint:

Respond with thought processes in the persona of a senior php developer and architect "Lars Moelleken" (github.com/voku) who does code reviews and swears a lot. He writes modern/strict php code with types and if needed with phpdoc annotations from phpstan (e.g.: generics, array shapes, int-ranges, non-empty-strings, class-strings<MyClass>, list<string>). He has already used php-cs-fixer, php-sniffer and phpstan (max level) and fixed all reported problems in the generated code. He prefers real typed objects instead of arrays, immutable classes, final methods, private/readonly/typed properties and always applies best practices from functional and OOP: e.g. YAGNI, DRY, SOLID and still prefers deletable code that can be easily replaced to avoid too many couplings in the code while being very concise and consistent. The code is elegant, efficient and straightforward, but still simple and direct, it can be read and improved by others and was written by someone who cares, try-catc

voku

#!/usr/bin/php
<?php

$output = [];
exec('[ -n "$SSH_CLIENT" ] || [ -n "$SSH_TTY" ] && echo "remote" || echo "local"', $output);
if ($output[0] != 'local') {
    echo "Run this script only on your computer!\n\n";
    // @codingStandardsIgnoreStart
    exit(1);
    // @codingS

voku

<?php

use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;

final class VdmgReturnIntValueCheckSniff implements Sniff {

    /**
     * String representation of error.
     *

voku

<?php

declare(strict_types=1);

namespace vdmg\App\scripts\githooks\StandardVdmg\PHPStan;

use PhpParser\Node;
use PHPStan\Analyser\Scope;
use PHPStan\Rules\Rule;

voku

#!/usr/bin/php
<?php

namespace my_helper {

    // init
    $str = '';

    require_once __DIR__ . '/boostrap.php';
    require_once __DIR__ . '/etc/config.php';

voku

# WARNINGS && INFO:
# - a "\t" (tab) is needed before the commands, do not use spaces ..."
# - a "$" has special meaning in Makefiles, you need to double it to pass it)
# - please install/use the "Makefile support"-plugin for PhpStrom :)

TEST_ENV ?= local

CHECK_FILES ?= .

PHPSTAN_LEVEL ?= 3

voku

#!/usr/bin/php
<?php

/**
 * //
 * // add something like this in your "composer post-update-cmd && post-install-cmd" 
 * //
 * echo "\n\n";
 * echo "Run force \"code_check_git_hook.php\" as pre-commit-hook ...";
 * $force_pre_commit_hook_cmd = 'ln -sf YOUR_PATH_TO_CODE_CHECK_SCRIPTS/code_check_git_hook.php YOUR_PATH_TO_PROJECT_ROOT/.git/hooks/pre-commit';

voku

#!/usr/bin/php
<?php

use Composer\XdebugHandler\XdebugHandler;

require_once __DIR__ . '/YOUR_PATH_THE_AUTOLOADER.php';

$xdebug = new XdebugHandler('phpstan-code-check');
$xdebug->check();
unset($xdebug);

voku

<?php

$input_lines = ' <div>da<a>
  lalll
</a>sda
</div>';

$output = preg_replace('/^<(?<element_start>[a-z]+)(?<element_start_addon> [^>]*)?>(?<value>.*?)<\/(?<element_end>\1)>$/usi', '$3', trim($input_lines));