The Port component

Default API

The Port class represents the URI Port component. Apart from the package common API, the class exposes an additional toInt method which returns the component value as an integer or null if the component is not defined.

<?php

use League\Uri\Components\Port;

$port = Port::new(443);
$port->value();                //returns '443'
$port->toInt();                //returns 443
echo $port;                    //displays '443'
echo $port->toString();        //displays '443'
echo $port->getUriComponent(); //displays ':443'

$nullPort = Port::new();
$nullPort->value();                //returns null
$nullPort->toInt();                //returns null
echo $nullPort;                    //displays ''
echo $nullPort->toString();        //displays ''
echo $nullPort->getUriComponent(); //displays ''

The object cannot be modified, you are required to instantiate a new object.

The delimiter : is not part of the component value and must not be added.

If the submitted value is not valid a League\Uri\Exceptions\SyntaxError exception is thrown.

Port Information

Available since 7.6.0

Port::defaultSchemes() and Port::defaultScheme() methods returns the schemes using the current port as its default.

Port::new('80')->defaultSchemes(); // return [Schemes::new('http'), Schemes::new('ws')]
Port::new('1234')->defaultSchemes(); // return []
Port::new('433')->defaultScheme(); // return Schemes::new('https')
Port::new('1234')->defaultScheme(); // return null