sunchaser/doctrine-pgsql-ip

Doctrine type handlers for PostgreSQL's inet and cidr

Maintainers

Details

github.com/sunchaserinfo/doctrine-pgsql-ip

Source

Issues

Installs: 27 689

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 2

Forks: 1

Open Issues: 0

3.0.0 2024-04-30 06:57 UTC

Requires

ISC 2685d31994658e82bc257743a1b394bf181afd06

  • Christian Archer <sunchaser.woop@sunchaser.info>

doctrinepostgresqlip addresscidrinet

This package is auto-updated.

Last update: 2024-11-30 08:07:39 UTC

README

This library adds support for cidr and inet types of PostgreSQL in Doctrine using the rlanvin/php-ip library.

Installation

composer require sunchaser/doctrine-pgsql-ip

Usage

  1. Register types in Doctrine

    <?php

use Doctrine\DBAL\Types\Type;
use SunChaser\Doctrine\PgSql\InetType;
use SunChaser\Doctrine\PgSql\CidrType;

Type::addType(InetType::NAME, InetType::class);
Type::addType(CidrType::NAME, CidrType::class);

  2. Add type handling for schema operations

    <?php

use Doctrine\DBAL\Connection;
use SunChaser\Doctrine\PgSql\InetType;
use SunChaser\Doctrine\PgSql\CidrType;

/** @var Connection $conn */
$conn->getDatabasePlatform()->registerDoctrineTypeMapping(InetType::PG_TYPE, InetType::NAME);
$conn->getDatabasePlatform()->registerDoctrineTypeMapping(CidrType::PG_TYPE, CidrType::NAME);

inet accepts and retrieves both \PhpIP\IP for individual addresses and \PhpIP\IPBlock for network masks. Please check the type when retrieving the data.

cidr accepts and retrieves only \PhpIP\IPBlock.

Upgrade

Changes in 3.0:

  • Requirements were bumped to PHP 8.1 and Doctrine DBAL 4.0

Changes in 2.0:

  • leth/ip-address was replaced with rlanvin/php-ip
  • Requirements were bumped to PHP 8.0 and Doctrine DBAL 3.0