PHP – Rob Allen's DevNotes

Changelog generator for GitHub milestones

For many years now, I've been using Matthew Weier O'Phinney's changelog_generator script to generate an easy-to-read list of changes for a given milestone. Time has moved on; the Laminas project now uses Laminas Automatic Releases and Matthew hasn't updated his script since 2013. Since PHP 8, warnings have started appear, so it's clear updates were required. While I fully intend to see if I can use Automatic Releases on some projects, I have others where… continue reading.

Posted on 18 August 2021 in PHP Leave a comment

Setting HTTP status code based on Exception in Slim 4

One thing that's quite convenient is to be able to throw an exception with a valid HTTP code set and have that code sent to the client. For example, you may have:

throw new \RuntimeException("Not Found", 404);

1	throw new \RuntimeException("Not Found", 404);

With the standard Slim 4 error handler, this response is sent to the client:

$ curl -i -H "Accept:application/json" http://localhost:8888
HTTP/1.1 500 Internal Server Error
Host: localhost:8888
Content-type: application/json

{
    "message": "Slim Application Error"
}

1

2

3

4

5

6

7

8

$ curl -i -H "Accept:application/json" http://localhost:8888

HTTP/1.1 500 Internal Server Error

Host: localhost:8888

Content-type: application/json

{

"message": "Slim Application Error"

}

Ideally we want the status code to be 404. Option 1: Use an HttpException The simplest solution is to use one of Slim's HttpException classes:

use Slim\Exception\HttpNotFoundException;

...

throw new HttpNotFoundException($request);

1

2

3

4

5

use Slim\Exception\HttpNotFoundException;

...

throw new HttpNotFoundException($request);

This… continue reading.

Posted on 19 July 2021 in PHP, Slim Framework, Slim Framework 4 Leave a comment

Dependency injection in Serverless PHP with Bref

When writing PHP for AWS Lambda, Bref is the way to do it. One thing I like about Bref is that you can use PSR-15 Request Handlers to respond to API Gateway HTTP events as documented in the API Gateway HTTP events section of the Bref docs. The request handler is the same as used in PSR-7 micro-frameworks like Slim or Mezzio and can be thought of as a controller action. As such, it's really… continue reading.

Posted on 9 March 2021 in AWS Lambda, PHP Leave a comment

Free ticket to The Online PHP Conference!

I'm very happy to be speaking at The Online PHP Conference this year. As you can guess from the title, this is an online event so is easily accessible right from your desk. thePHP.cc have very kindly made available a couple of tickets to me, so you could attend for free.

Posted on 6 January 2021 in Conferences, PHP

Installing PHP extensions without pecl in PHP 8 Docker images

UPDATE: Since this was published, PR 1087 has been raised and merged with restores pecl to the Docker PHP 8 images. I discovered recently that pecl is no longer shipped in the PHP Docker images for PHP 8. This appears to be related to the deprecation of –with-pear in PHP core as noted in issue 1029. Consider this Dockerfile: FROM php:8.0.0RC5-cli-buster RUN pecl install mongodb && docker-php-ext-enable mongodb If you build, you'll discover the pecl… continue reading.

Posted on 24 November 2020 in PHP View all 3 comments

Step-debugging linked composer dependencies with PhpStorm

One project I'm working on has multiple separate parts in different git repositories that are brought into the main project using linked composer directories. I needed to get step debugging working in PhpStorm and this is the approach I took.

Posted on 7 October 2020 in PHP Leave a comment

Recursive PHP lint

There are many scripts that recursively execute php -l on a set of files or directories. This is mine:

#!/usr/bin/env bash
set -o nounset

# Recursively call `php -l` over the specified directories/files

if [ -z "$1" ] ; then
    printf 'Usage: %s <directory-or-file> ...\n' "$(basename "$0")"
    exit 1
fi

ERROR=false
SAVEIFS=$IFS
IFS=$'\n'
while test $# -gt 0; do
    CURRENT=${1%/}
    shift

    if [ ! -f $CURRENT ] && [ ! -d $CURRENT ] ; then
        echo "$CURRENT cannot be found"
        ERROR=true
        continue
    fi

    for FILE in $(find $CURRENT -type f -name "*.php") ; do
        OUTPUT=$(php -l "$FILE" 2> /dev/null)

        # Remove blank lines from the `php -l` output
        OUTPUT=$(echo -e "$OUTPUT" | awk 'NF')

        if [ "$OUTPUT" != "No syntax errors detected in $FILE" ] ; then
            echo -e "$FILE:"
            echo -e "  ${OUTPUT//$'\n'/\\n  }\n"
            ERROR=true
        fi
    done
done

IFS=$SAVEIFS

if [ "$ERROR" = true ] ; then
    exit 1
fi

echo "No syntax errors found."
exit 0

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

#!/usr/bin/env bash

set -o nounset

# Recursively call `php -l` over the specified directories/files

if [ -z "$1" ] ; then

printf 'Usage: %s <directory-or-file> ...\n' "$(basename "$0")"

exit 1

fi

ERROR=false

SAVEIFS=$IFS

IFS=$'\n'

while test $# -gt 0; do

CURRENT=${1%/}

shift

if [ ! -f $CURRENT ] && [ ! -d $CURRENT ] ; then

echo "$CURRENT cannot be found"

ERROR=true

continue

fi

for FILE in $(find $CURRENT -type f -name "*.php") ; do

OUTPUT=$(php -l "$FILE" 2> /dev/null)

# Remove blank lines from the `php -l` output

OUTPUT=$(echo -e "$OUTPUT" | awk 'NF')

if [ "$OUTPUT" != "No syntax errors detected in $FILE" ] ; then

echo -e "$FILE:"

echo -e " ${OUTPUT//$'\n'/\\n }\n"

ERROR=true

fi

done

IFS=$SAVEIFS

if [ "$ERROR" = true ] ; then

exit 1

fi

echo "No syntax errors found."

exit 0

I store it in ~/bin and usually run it like this:

$ cd project
$ phplint .
No syntax errors found.

1

2

3

$ cd project

$ phplint .

No syntax errors found.

There are a few interesting bash tricks that I picked up when I wrote this. Firstly, you need to set IFS to break on new line rather than space otherwise the find command doesn't work with spaces in file names. I also discovered… continue reading.

Posted on 13 August 2020 in Development, PHP View all 2 comments

Validating default PHP session ID values

I recently needed to validate the value created by PHP for its session ID. After a bit of research, I realised that there are two interesting php.ini config settings that relate to this value: session.sid_length is the number of characters in the ID session.sid_bits_per_character controls the set of characters used. From the manual: The possible values are '4' (0-9, a-f), '5' (0-9, a-v), and '6' (0-9, a-z, A-Z, "-", ","). Therefore, to validate the session… continue reading.

Posted on 13 February 2020 in PHP View all 7 comments

Routing in Slim 4

Routing in Slim 4 works pretty much exactly the same as in Slim 3. They are used to map a URL that the browser requests to a specific handler that executes the code for that particular page or API endpoint. You can also attach middleware that will only be run when that route is matched. The route in the slim4-starter looks like this:

$app->get('/[{name}]', HomePageHandler::class);

1	$app->get('/[{name}]', HomePageHandler::class);

It is made up of the method, the pattern and the… continue reading.

Posted on 18 December 2019 in PHP, Slim Framework 4 View all 3 comments

Changing an SQL Server primary key in Doctrine Migrations

I recently came across a rather weird quirk when trying to change a primary key in Sql Server using Doctrine Migrations: you need to use two migrations to get it to work. This is incredibly minor and I'm only writing it up as it confused me for a while so I thought that I'd document so that I'll find this article if I run across it again in the future! This is the migration:

final class Version20191023125629 extends AbstractMigration
{
    public function up(Schema $schema) : void
    {
        $table = $schema->getTable('page_category');
        $table->dropPrimaryKey();
        $table->setPrimaryKey(['page_uuid', 'category_id']);
    }

    public function down(Schema $schema) : void
    {
        $table = $schema->getTable('page_category');
        $table->dropPrimaryKey();
        $table->setPrimaryKey(['page_id', 'category_id']);
    }
}

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

final class Version20191023125629 extends AbstractMigration

{

public function up(Schema $schema) : void

{

$table = $schema->getTable('page_category');

$table->dropPrimaryKey();

$table->setPrimaryKey(['page_uuid', 'category_id']);

}

public function down(Schema $schema) : void

{

$table = $schema->getTable('page_category');

$table->dropPrimaryKey();

$table->setPrimaryKey(['page_id', 'category_id']);

}

Posted on 20 November 2019 in PHP Leave a comment

Category: PHP