Skip to content

Latest commit

 

History

History
318 lines (230 loc) · 8.36 KB

07-types.md

File metadata and controls

318 lines (230 loc) · 8.36 KB
Raw

Type Methods

The type methods return a boolean value depending on whether the IP address is a certain type.

Detecting Embedding Strategies

Embedded?

Whether the IP is an IPv4 address embedded into an IPv6 address, according to the embedding strategy used when creating the IP object.

<?php
use Darsyn\IP\Version\Multi as IP;

$ip = IP::factory('::ffff:7f00:1');
$ip->isEmbedded(); // bool(true)

If you would like to detect if the IP is an IPv4-embedded IPv6 address, according to RFC 4291 section 2.5.5, please use the following conditional statement:

<?php
use Darsyn\IP\Strategy\Derived;
use Darsyn\IP\Version\Multi as IP;

$ip = IP::factory('127.0.0.1', new Derived);
$rfc4291 = $ip->isMapped() || $ip->isCompatible(); // bool(false)

Mapped

Whether the IP is an IPv4-mapped IPv6 address (eg, ::ffff:7f00:1), according to RFC 4291 section 2.5.5.2. The IPv4 class will always return bool(false) for this method.

<?php
use Darsyn\IP\Version\Multi as IP;

$ip = IP::factory('::ffff:7f00:1');
$ip->isMapped(); // bool(true)

Derived

Whether the IP is a 6to4-derived IPv6 address (eg, 2002:7f00:1::), according to RFC 3056. The IPv4 class will always return bool(false) for this method.

<?php
use Darsyn\IP\Version\Multi as IP;

$ip = IP::factory('2002:7f00:1::');
$ip->isDerived(); // bool(true)

Compatible

Whether the IP is an IPv4-compatible IPv6 address (eg, ::7f00:1), according to RFC 4291 section 2.5.5.1. The IPv4 class will always return bool(false) for this method.

IPv4-compatible IPv6 addresses are deprecated in the RFC.

<?php
use Darsyn\IP\Version\Multi as IP;

$ip = IP::factory('::7f00:1');
$ip->isCompatible(); // bool(true)

Detecting Address Types

Link Local

Whether the IP is reserved for link-local usage, according to RFC 3927 (IPv4) or RFC 4291 section 2.4 (IPv6).

<?php
use Darsyn\IP\Version\Multi as IP;

$ip = IP::factory('127.0.0.1');
$ip->isLinkLocal(); // bool(false)

Loopback

Whether the IP is a loopback address, according to RFC 1122 section 3.2.1.3 (IPv4) or RFC 4291 section 2.5.3 (IPv6).

<?php
use Darsyn\IP\Version\Multi as IP;

$ip = IP::factory('127.0.0.1');
$ip->isLoopback(); // bool(true)

Multicast

Whether the IP is a multicast address, according to RFC 5771 (IPv4) or RFC 4291 section 2.7 (IPv6).

<?php
use Darsyn\IP\Version\Multi as IP;

$ip = IP::factory('127.0.0.1');
$ip->isMulticast(); // bool(false)

Private Use

Whether the IP is for private use, according to RFC 1918 section 3 (IPv4) or RFC 4193 (IPv6).

<?php
use Darsyn\IP\Version\Multi as IP;

$ip = IP::factory('127.0.0.1');
$ip->isPrivateUse(); // bool(false)

Unspecified

Whether the IP is unspecified, according to RFC 5735 (IPv4) or RFC 2373 section 2.5.2 (IPv6).

<?php
use Darsyn\IP\Version\Multi as IP;

$ip = IP::factory('127.0.0.1');
$ip->isUnspecified(); // bool(false)

Benchmarking

Whether the IP is reserved for network devices benchmarking, according to RFC 2544 corrected in errata 423 (IPv4) or RFC 5180 corrected in errata 1752 (IPv6).

<?php
use Darsyn\IP\Version\Multi as IP;

$ip = IP::factory('127.0.0.1');
$ip->isBenchmarking(); // bool(false)

Documentation

Whether the IP is in range designated for documentation, according to RFC 5737 (IPv4) or RFC 3849 (IPv6).

<?php
use Darsyn\IP\Version\Multi as IP;

$ip = IP::factory('127.0.0.1');
$ip->isDocumentation(); // bool(false)

Public Use (Global)

Whether the IP appears to be publicly/globally routable (please refer to the following:

<?php
use Darsyn\IP\Version\Multi as IP;

$ip = IP::factory('127.0.0.1');
$ip->isPublicUse(); // bool(false)

IPv4 Specific

These methods will throw a WrongVersionException if called from Multi on an IPv6 address (non IPv4-embedded).

Broadcast

Whether the IP is a broadcast address, according to RFC 919.

<?php
use Darsyn\IP\Version\IPv4;

IPv4::factory('127.0.0.1')->isBroadcast(); // bool(false)
IPv4::factory('255.255.255.255')->isBroadcast(); // bool(true)

Reserved for Future Use

Whether the IP is reserved for future use, according to RFC 1112.

<?php
use Darsyn\IP\Version\IPv4;

IPv4::factory('127.0.0.1')->isFutureReserved(); // bool(false)
IPv4::factory('255.34.85.169')->isFutureReserved(); // bool(true)

Shared

Whether the IP is part of the Shared Address Space, according to RFC 6598.

<?php
use Darsyn\IP\Version\IPv4;

IPv4::factory('100.128.179.30')->isShared(); // bool(false)
IPv4::factory('100.127.43.2')->isShared(); // bool(true)

IPv6 Specific

Multicast Scope

The specific scope of the multicast address (returns null if not a multicast address). The following constants are available on Darsyn\IP\Version\Version6Interface:

  • MULTICAST_INTERFACE_LOCAL
  • MULTICAST_LINK_LOCAL
  • MULTICAST_REALM_LOCAL
  • MULTICAST_ADMIN_LOCAL
  • MULTICAST_SITE_LOCAL
  • MULTICAST_ORGANIZATION_LOCAL
  • MULTICAST_GLOBAL
<?php
use Darsyn\IP\Version\IPv6;

$isOrganizationLocal = IPv6::factory('ff08:1:6e6f:cbb::980e:3816')->getMulticastScope() === IPv6::MULTICAST_ORGANIZATION_LOCAL; // bool(true)

Unique Local

Whether the IP is a unique local address, according to RFC 4193.

<?php
use Darsyn\IP\Version\IPv6;

IPv6::factory('b638:cc70:716:c4d4:f69c:4ee3:6c65:a0b2')->isUniqueLocal(); // bool(false)
IPv6::factory('fdff:ffff::')->isUniqueLocal(); // bool(true)

Unicast

Whether the IP is a unicast address, according to RFC 4291 (any IPv6 address that is not a multicast address is unicast, and vice-versa).

<?php
use Darsyn\IP\Version\IPv6;

IPv6::factory('ff08::')->isUnicast(); // bool(false)
IPv6::factory('::ffff:1:0')->isUnicast(); // bool(true)

Unicast Global

Whether the IP is a globally routable unicast address, according to RFC 4291 section 2.5.4.

<?php
use Darsyn\IP\Version\IPv6;

IPv6::factory('2001:db8:85a3::8a2e:370:7334')->isUnicastGlobal(); // bool(false)
IPv6::factory('140c:12f1:6e6f:c0bb:980e:3816:3e52:1193')->isUnicastGlobal(); // bool(true)