# Class AddressGroup

© 2019 Palo Alto Networks, Inc. All rights reserved.

Licensed under SCRIPT SOFTWARE AGREEMENT, Palo Alto Networks, Inc., at https://www.paloaltonetworks.com/legal/script-software-license-1-0.pdf

  AddressGroup uses PathableName, XmlConvertible, AddressCommon, ObjectWithDescription

Located at object-classes/AddressGroup.php

Methods summary
`public` | # `__construct( string $name, `AddressStore`|null $owner, boolean $fromTemplateXml = FALSE )` Constructor for AddressGroup. There is little chance that you will ever need that. Look at AddressStore if you want to create an AddressGroup Constructor for AddressGroup. There is little chance that you will ever need that. Look at AddressStore if you want to create an AddressGroup #### Parameters $name `string` $name $owner ``AddressStore`|null` $owner $fromTemplateXml `boolean` $fromTemplateXml
`public` | # `isDynamic( )`
`public` | # `xml_convert_to_v6( )`
`public` | # `setName( string $newName )` #### Parameters $newName `string` $newName
`public boolean` | # `addMember( `Address`|`AddressGroup` $newObject, boolean $rewriteXml = TRUE )` Add a member to this group, it must be passed as an object Add a member to this group, it must be passed as an object #### Parameters $newObject ``Address`|`AddressGroup`` $newObject Object to be added $rewriteXml `boolean` $rewriteXml #### Returns `boolean`
`public boolean` | # `API_addMember( `Address`|`AddressGroup` $newObject )` Add a member to this group, it must be passed as an object Add a member to this group, it must be passed as an object #### Parameters $newObject ``Address`|`AddressGroup`` $newObject Object to be added #### Returns `boolean`
`public boolean` | # `removeMember( `Address`|`AddressGroup` $objectToRemove, boolean $rewriteXml = TRUE )` Removes a member from this group Removes a member from this group #### Parameters $objectToRemove ``Address`|`AddressGroup`` $objectToRemove Object to be removed $rewriteXml `boolean` $rewriteXml #### Returns `boolean`
`public boolean` | # `API_removeMember( `Address`|`AddressGroup` $objectToRemove )` Removes a member from this group Removes a member from this group #### Parameters $objectToRemove ``Address`|`AddressGroup`` $objectToRemove Object to be removed #### Returns `boolean`
`public boolean` | # `tagMember( boolean $newTag, mixed $rewriteXml = TRUE )` tag a member with its group membership name tag a member with its group membership name #### Parameters $newTag `boolean` $rewriteXml $rewriteXml #### Returns `boolean`
`public boolean` | # `API_tagMember( boolean $newTag, mixed $rewriteXml = TRUE )` tag a member with its group membership name tag a member with its group membership name #### Parameters $newTag `boolean` $rewriteXml $rewriteXml #### Returns `boolean`
`public boolean` | # `tagRuleandGroupMember( boolean $rule, mixed $prefix, mixed $rewriteXml = TRUE )` tag a member with its group membership name tag a member with its group membership name #### Parameters $rule `boolean` $rewriteXml $prefix $rewriteXml #### Returns `boolean`
`public boolean` | # `API_tagRuleandGroupMember( boolean $rule, mixed $prefix, mixed $rewriteXml = TRUE )` tag a member with its group membership name tag a member with its group membership name #### Parameters $rule `boolean` $rewriteXml $prefix $rewriteXml #### Returns `boolean`
`public` | # `removeAll( mixed $rewriteXml = TRUE )` Clear this Group from all its members Clear this Group from all its members
`public boolean` | # `replaceReferencedObject( `Address`|`AddressGroup` $old, `Address`|`AddressGroup`|null $new )` #### Parameters $old ``Address`|`AddressGroup`` $old $new ``Address`|`AddressGroup`|null` $new #### Returns `boolean`
`public` | # `API_replaceReferencedObject( mixed $old, mixed $new )`
`public boolean` | # `has( mixed $obj )` #### Parameters $obj `mixed` $obj Address|AddressGroup #### Returns `boolean`
`public` | # `rewriteXML( )` Rewrite XML for this object, useful after a batch editing to save computing time Rewrite XML for this object, useful after a batch editing to save computing time
`public integer` | # `count( )` Counts how many members in this group Counts how many members in this group #### Returns `integer`
`public `Address[]`|`AddressGroup[]`` | # `members( )` returns the member list as an Array of objects (mix of Address, AddressGroups, Regions..) returns the member list as an Array of objects (mix of Address, AddressGroups, Regions..) #### Returns ``Address[]`|`AddressGroup[]``
`public` | # `API_setName( string $newName )` #### Parameters $newName `string` $newName
`public string &` | # `getXPath( )` #### Returns `string`
`public` | # `isGroup( )`
`public` | # `hasFQDN( )`
`public boolean` | # `equals( `Address`|`AddressGroup` $otherObject )` #### Parameters $otherObject ``Address`|`AddressGroup`` $otherObject #### Returns `boolean`
`public boolean` | # `sameValue( `AddressGroup` $otherObject )` Return true if other object is also a group and has same object name ( value in not taken in account, only object name !! ) Return true if other object is also a group and has same object name ( value in not taken in account, only object name !! ) #### Parameters $otherObject ``AddressGroup`` $otherObject #### Returns `boolean`
`public &` | # `getValueDiff( `AddressGroup` $otherObject )`
`public` | # `displayValueDiff( `AddressGroup` $otherObject, mixed $indent = 0, mixed $toString = FALSE )`
`public `Address[]`|`AddressGroup[]` &` | # `expand( boolean $keepGroupsInList = FALSE )` #### Parameters $keepGroupsInList `boolean` $keepGroupsInList keep groups in the the list on top of just expanding them #### Returns ``Address[]`|`AddressGroup[]`` list of all member objects, if some of them are groups, they are exploded and their members inserted
`public boolean` | # `hasObjectRecursive( `Address`|`AddressGroup` $object )` #### Parameters $object ``Address`|`AddressGroup`` $object #### Returns `boolean`
`public` | # `API_delete( )`
`public integer` | # `includedInIP4Network( string|`IP4Map` $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 `string|`IP4Map`` $network 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 `IP4Map`` | # `getIP4Mapping( )` #### Returns ``IP4Map``
`public` | # `getFullMapping( )`
`public` | # `hasGroupinGroup( )`
`public` | # `getGroupNamerecursive( mixed $group_name_array )`
`public` | # `replaceByMembersAndDelete( mixed $padding = "", mixed $isAPI = FALSE, mixed $rewriteXml = TRUE, mixed $forceAny = FALSE )`

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

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

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

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

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

Properties summary
`public `AddressStore`|null` | $owner | `null` | #
`public `TagRuleContainer`` | $tags | `` | #
`public mixed` | $filter | `` | #
`protected static string` | $templatexml | `'<entry name="**temporarynamechangeme**"></entry>'` | #
`protected static string` | $templatexml_v6 | `'<entry name="**temporarynamechangeme**"><static></static></entry>'` | #
`protected static mixed` | $templatexmlroot | `null` | #

Properties used from XmlConvertible
`$xmlroot`

Properties used from ObjectWithDescription
`$_description`

Magic properties used from PathableName
`$name, $owner`

Magic properties used from ObjectWithDescription
`$xmlroot`