Documentation

PhoneNumber extends Message
in package

An object representing a phone number, suitable as an API wire format.

This representation:

  • should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123"
  • is not designed for efficient storage
  • may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an i18n.phonenumbers.PhoneNumber object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s):
  • https://github.com/google/libphonenumber

Generated from protobuf message google.type.PhoneNumber

Table of Contents

Properties

$extension  : mixed
The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here.
$kind  : mixed

Methods

__construct()  : mixed
Constructor.
getE164Number()  : string
The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123".
getExtension()  : string
The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here.
getKind()  : string
getShortCode()  : ShortCode|null
A short code.
hasE164Number()  : mixed
hasShortCode()  : mixed
setE164Number()  : $this
The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123".
setExtension()  : $this
The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here.
setShortCode()  : $this
A short code.

Properties

$extension

The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here.

protected mixed $extension = ''

Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future.

Generated from protobuf field string extension = 3 [json_name = "extension"];

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = NULL ]) : mixed
Parameters
$data : array<string|int, mixed> = NULL

{ Optional. Data for populating the Message object.

@type string $e164_number
      The phone number, represented as a leading plus sign ('+'), followed by a
      phone number that uses a relaxed ITU E.164 format consisting of the
      country calling code (1 to 3 digits) and the subscriber number, with no
      additional spaces or formatting, e.g.:
       - correct: "+15552220123"
       - incorrect: "+1 (555) 222-01234 x123".
      The ITU E.164 format limits the latter to 12 digits, but in practice not
      all countries respect that, so we relax that restriction here.
      National-only numbers are not allowed.
      References:
       - https://www.itu.int/rec/T-REC-E.164-201011-I
       - https://en.wikipedia.org/wiki/E.164.
       - https://en.wikipedia.org/wiki/List_of_country_calling_codes
@type \Google\Type\PhoneNumber\ShortCode $short_code
      A short code.
      Reference(s):
       - https://en.wikipedia.org/wiki/Short_code
@type string $extension
      The phone number's extension. The extension is not standardized in ITU
      recommendations, except for being defined as a series of numbers with a
      maximum length of 40 digits. Other than digits, some other dialing
      characters such as ',' (indicating a wait) or '#' may be stored here.
      Note that no regions currently use extensions with short codes, so this
      field is normally only set in conjunction with an E.164 number. It is held
      separately from the E.164 number to allow for short code extensions in the
      future.

}

getE164Number()

The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123".

public getE164Number() : string

The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References:

  • https://www.itu.int/rec/T-REC-E.164-201011-I
  • https://en.wikipedia.org/wiki/E.164.
  • https://en.wikipedia.org/wiki/List_of_country_calling_codes

Generated from protobuf field string e164_number = 1 [json_name = "e164Number"];

Return values
string

getExtension()

The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here.

public getExtension() : string

Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future.

Generated from protobuf field string extension = 3 [json_name = "extension"];

Return values
string

getKind()

public getKind() : string
Return values
string

getShortCode()

A short code.

public getShortCode() : ShortCode|null

Reference(s):

  • https://en.wikipedia.org/wiki/Short_code

Generated from protobuf field .google.type.PhoneNumber.ShortCode short_code = 2 [json_name = "shortCode"];

Return values
ShortCode|null

setE164Number()

The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123".

public setE164Number(string $var) : $this

The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References:

  • https://www.itu.int/rec/T-REC-E.164-201011-I
  • https://en.wikipedia.org/wiki/E.164.
  • https://en.wikipedia.org/wiki/List_of_country_calling_codes

Generated from protobuf field string e164_number = 1 [json_name = "e164Number"];

Parameters
$var : string
Return values
$this

setExtension()

The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here.

public setExtension(string $var) : $this

Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future.

Generated from protobuf field string extension = 3 [json_name = "extension"];

Parameters
$var : string
Return values
$this

setShortCode()

A short code.

public setShortCode(ShortCode $var) : $this

Reference(s):

  • https://en.wikipedia.org/wiki/Short_code

Generated from protobuf field .google.type.PhoneNumber.ShortCode short_code = 2 [json_name = "shortCode"];

Parameters
$var : ShortCode
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results