darsyn / ip-doctrine

6.0.1 2025-07-28 08:43 UTC

Requires

• php: >=8.1
• ext-pdo: *
• darsyn/ip: ^5.0|^6.0
• doctrine/dbal: ^4

Requires (Dev)

• phpstan/phpstan: ^2.1.17
• phpstan/phpstan-deprecation-rules: ^2.0.3
• phpunit/phpunit: *

Suggests

• doctrine/dbal: to use IP as a column type

MIT

• Zan Baldwin

• doctrine
• IP

Published on Packagist.org on 2025-07-28 12:38 UTC

README

This library provides Doctrine types for darsyn/ip.

Documentation

Please refer to the darsyn/ip project for complete documentation.

Compatibility

This library has extensive test coverage using PHPUnit on PHP versions: 8.1, 8.2, 8.3 and 8.4.

Static analysis is performed with PHPStan at max level on PHP 8.4, using core, bleeding edge, and deprecation rules.

Types are provided for Ipv4, IPv6, and Multi IP types from the parent darsyn/ip project.

• Versions 5.*.* are for Doctrine DBAL ^2.3 || ^3.0 compatibility (PHP 5.6 and greater).
• Versions 6.*.* are for Doctrine DBAL ^4 (PHP 8.1 and greater).

Querying

Repository methods such as findBy(), findOneBy() and findByIp() read the column type from the entity mapping, so they accept an IP object directly.

The QueryBuilder and DQL do not know the column type. A parameter passed to setParameter() without a type is bound as a plain string. An IP object is then cast to its protocol notation and compared against the raw bytes in the column, which matches nothing and raises no error. Always name the type as the third argument:

<?php
$columnType = 'ip';
$queryBuilder
    ->andWhere('entity.ip = :address')
    ->setParameter('address', $ipObject, $columnType);

'ip' is the name the type was registered under (either Type::addType() or Symfony config).

The type accepts an IP object or a protocol string, and binds the value as binary on every database platform. See the darsyn/ip documentation for details.

Code of Conduct

This project includes and adheres to the Contributor Covenant as a Code of Conduct.

License

Please see the separate licence file included in this repository for a full copy of the MIT licence, which this project is licensed under.

Authors

• Zan Baldwin

If you make a contribution (submit a pull request), don't forget to add your name here!