Class Address

Address uses AddressCommon, PathableName, XmlConvertible, ObjectWithDescription

Located at object-classes/Address.php

Methods summary
`public`	# `__construct( string $name, AddressStore $owner, boolean $fromXmlTemplate = FALSE )` you should not need this one for normal use you should not need this one for normal use Parameters `$name` `string` $name `$owner` `AddressStore` $owner `$fromXmlTemplate` `boolean` $fromXmlTemplate
`public null\|string`	# `value( )` Returns `null\|string`
`public boolean`	# `setValue( string $newValue, boolean $rewriteXml = TRUE )` Parameters `$newValue` `string` $newValue `$rewriteXml` `boolean` $rewriteXml Returns `boolean` Throws `Exception`
`public boolean`	# `setType( mixed $newType, boolean $rewritexml = TRUE )` Parameters `$newType` `mixed` $newType string `$rewritexml` `boolean` $rewritexml Returns `boolean` true if successful
`public boolean`	# `API_setType( mixed $newType )` Parameters `$newType` `mixed` $newType string Returns `boolean` true if successful
`public boolean`	# `API_setValue( string $newValue )` Parameters `$newValue` `string` $newValue Returns `boolean`
`public boolean`	# `API_editValue( string $newValue )` Parameters `$newValue` `string` $newValue Returns `boolean`
`public`	# `rewriteXML( )`
`public`	# `setName( string $newName )` change the name of this object change the name of this object Parameters `$newName` `string` $newName
`public`	# `API_setName( string $newName )` Parameters `$newName` `string` $newName
`public string &`	# `getXPath( )` Returns `string`
`public string`	# `type( )` Returns `string` ie: 'ip-netmask' 'ip-range'
`public`	# `isAddress( )`
`public`	# `isTmpAddr( )`
`public`	# `isType_ipNetmask( )`
`public`	# `isType_ipRange( )`
`public`	# `isType_FQDN( )`
`public`	# `isType_TMP( )`
`public`	# `isType_ipWildcard( )`
`public boolean`	# `equals( mixed $otherObject )` Parameters `$otherObject` `mixed` $otherObject Address\|AddressGroup Returns `boolean`
`public`	# `sameValue( Address $otherObject )`
`public IP4Map`	# `getIP4Mapping( )` Return an array['start']= startip and ['end']= endip Return an array['start']= startip and ['end']= endip Returns `IP4Map`
`public integer`	# `includedInIP4Network( mixed $network )` return 0 if not match, 1 if this object is fully included in $network, 2 if this object is partially matched by $ref. return 0 if not match, 1 if this object is fully included in $network, 2 if this object is partially matched by $ref. Parameters `$network` `mixed` $network string\|IP4Map ie: 192.168.0.2/24, 192.168.0.2,192.168.0.2-192.168.0.4 Returns `integer`
`public integer`	# `includesIP4Network( mixed $network )` return 0 if not match, 1 if $network is fully included in this object, 2 if $network is partially matched by this object. return 0 if not match, 1 if $network is fully included in this object, 2 if $network is partially matched by this object. Parameters `$network` `mixed` $network string\|IP4Map ie: 192.168.0.2/24, 192.168.0.2,192.168.0.2-192.168.0.4 Returns `integer`
`public`	# `removeReference( mixed $object )`
`public`	# `getNetworkMask( )`
`public boolean\|string`	# `getNetworkValue( )` Returns `boolean\|string`
`public`	# `nameIsValidRuleIPEntry( )`

Methods used from AddressCommon
`(), (), (), (), (), (), (), (), ()`

Methods used from ReferenceableObject
`(), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), removeReference()(as super_removeReference())`

Methods used from PathableName
`(), (), ()`

Methods used from XmlConvertible
`(), (), (), (), ()`

Methods used from ObjectWithDescription
`(), (), (), (), ()`

Constants summary
`integer`	`TypeTmp`	`0`	#
`integer`	`TypeIpNetmask`	`1`	#
`integer`	`TypeIpRange`	`2`	#
`integer`	`TypeFQDN`	`3`	#
`integer`	`TypeDynamic`	`4`	#
`integer`	`TypeIpWildcard`	`5`	#

Properties summary
`protected string\|null`	`$value`		#
`public AddressStore\|null`	`$owner`		#
`public TagRuleContainer`	`$tags`		#
`protected integer`	`$type`	`Address::TypeTmp`	#
`protected static string`	`$templatexml`	`'<entry name="temporarynamechangeme"><ip-netmask>tempvaluechangeme</ip-netmask></entry>'`	#

Properties used from XmlConvertible
`$xmlroot`

Properties used from ObjectWithDescription
`$_description`

Magic properties summary
`public mixed`	`$_ip4Map`	# IP4Map cached ip start and end value for fast optimization IP4Map cached ip start and end value for fast optimization

Magic properties used from AddressCommon
`$owner`

Magic properties used from PathableName
`$name`

Magic properties used from ObjectWithDescription
`$xmlroot`

Namespaces

Classes

Interfaces

Traits

Functions

Class Address

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns