Overview

Namespaces

  • None
  • PHP

Classes

  • Address
  • AddressGroup
  • AddressRuleContainer
  • AddressStore
  • AggregateEthernetIfStore
  • AggregateEthernetInterface
  • App
  • AppOverrideRule
  • AppRuleContainer
  • AppStore
  • AuthenticationRule
  • CaptivePortalRule
  • cidr
  • Container
  • CsvParser
  • CustomSecurityProfileURL
  • DecryptionProfile
  • DecryptionRule
  • DeviceCloud
  • DeviceGroup
  • DH
  • DoSRule
  • ErrorReporter
  • EthernetIfStore
  • EthernetInterface
  • ExpeditionTaskReporter
  • FawkesConf
  • FileTaskReporter
  • HipObjectsProfile
  • HipProfilesProfile
  • IkeCryptoProfil
  • IkeCryptoProfileStore
  • IKEGateway
  • IKEGatewayStore
  • InterfaceContainer
  • IP4Map
  • IPSecCryptoProfil
  • IPSecCryptoProfileStore
  • IPsecTunnel
  • IPsecTunnelStore
  • LoopbackIfStore
  • LoopbackInterface
  • ManagedDevice
  • ManagedDeviceStore
  • NatRule
  • NetworkPropertiesContainer
  • ObjRuleContainer
  • ObjStore
  • PanAPIConnector
  • PANConf
  • PanoramaConf
  • PbfRule
  • PH
  • PredefinedSecurityProfileURL
  • QoSRule
  • RQuery
  • Rule
  • RuleStore
  • RuleWithUserID
  • Schedule
  • ScheduleStore
  • SecurityProfile
  • SecurityProfileAntiSpyware
  • SecurityProfileAntiVirus
  • SecurityProfileDNSSecurity
  • SecurityProfileFileBlocking
  • SecurityProfileGroup
  • SecurityProfileGroupStore
  • SecurityProfileStore
  • SecurityProfileURL
  • SecurityProfileVirusAndWildfire
  • SecurityProfileVulnerability
  • SecurityProfileWildfire
  • SecurityRule
  • Service
  • ServiceDstPortMapping
  • ServiceGroup
  • ServiceRuleContainer
  • ServiceSrcPortMapping
  • ServiceStore
  • StaticRoute
  • Tag
  • TagRuleContainer
  • TagStore
  • Template
  • TemplateStack
  • TmpInterface
  • TmpInterfaceStore
  • TunnelIfStore
  • TunnelInterface
  • UrlCategoryRuleContainer
  • VirtualRouter
  • VirtualRouterContainer
  • VirtualRouterStore
  • VirtualSystem
  • VirtualWire
  • VirtualWireStore
  • VlanIfStore
  • VlanInterface
  • Zone
  • ZoneRuleContainer
  • ZoneStore

Interfaces

  • TaskReporter

Traits

  • AddressCommon
  • centralAddressStore
  • centralAddressStoreUser
  • centralServiceStore
  • centralServiceStoreUser
  • InterfaceType
  • NegatableRule
  • ObjectWithDescription
  • PanSubHelperTrait
  • PathableName
  • ReferenceableObject
  • RulewithLogging
  • ServiceCommon
  • XmlConvertible

Functions

  • __CmpObjMemID
  • __CmpObjName
  • array_diff_no_cast
  • array_to_devicequery
  • array_unique_no_cast
  • cloneArray
  • convert
  • derr
  • findConnector
  • findConnectorOrDie
  • getDirContents
  • insertAfter
  • lastIndex
  • mdeb
  • mwarning
  • my_shutdown
  • myAutoloader
  • myErrorHandler
  • printn
  • removeElement
  • sortArrayByStartValue
  • yesNoBool
  • Overview
  • Namespace
  • Class
  • Tree

Class ServiceRuleContainer

Class ServiceRuleContainer

ObjRuleContainer uses PathableName, XmlConvertible
Extended by ServiceRuleContainer
Located at container-classes/ServiceRuleContainer.php
Methods summary
public
# __construct( mixed $owner )
public boolean
# add( Service|ServiceGroup $Obj, boolean $rewriteXml = TRUE )

Parameters

$Obj
Service|ServiceGroup
$Obj
$rewriteXml
boolean
$rewriteXml

Returns

boolean
public boolean
# API_add( Service|ServiceGroup $Obj, boolean $rewritexml = TRUE )

Parameters

$Obj
Service|ServiceGroup
$Obj
$rewritexml
boolean
$rewritexml

Returns

boolean
public
# isApplicationDefault( )
public boolean
# remove( Service|ServiceGroup $Obj, boolean $rewriteXml = TRUE, boolean $forceAny = FALSE )

Parameters

$Obj
Service|ServiceGroup
$Obj
$rewriteXml
boolean
$rewriteXml
$forceAny
boolean
$forceAny

Returns

boolean
True if Zone was found and removed. False if not found.

Overrides

ObjRuleContainer::remove()
public boolean
# API_remove( Service|ServiceGroup $Obj, boolean $rewriteXml = TRUE, boolean $forceAny = FALSE )

Parameters

$Obj
Service|ServiceGroup
$Obj
$rewriteXml
boolean
$rewriteXml
$forceAny
boolean
$forceAny

Returns

boolean
public
# setAny( )
public
# setApplicationDefault( )
public boolean
# has( Service|ServiceGroup|string $object, mixed $caseSensitive = TRUE )

Parameters

$object
Service|ServiceGroup|string
$object can be Service|ServiceGroup object or object name (string)
$caseSensitive

Returns

boolean

Overrides

ObjRuleContainer::has()
public Service[]|ServiceGroup[]
# members( )

return an array with all objects

return an array with all objects

Returns

Service[]|ServiceGroup[]
public Service[]|ServiceGroup[]
# all( )

return an array with all objects

return an array with all objects

Returns

Service[]|ServiceGroup[]
public
# rewriteXML( )
public
# merge( ServiceRuleContainer $other )

Merge this set of objects with another one (in paramater). If one of them is 'any' then the result will be 'any'.

Merge this set of objects with another one (in paramater). If one of them is 'any' then the result will be 'any'.

Parameters

$other
ServiceRuleContainer
$other
public boolean
# includesContainer( ServiceRuleContainer $other, mixed $anyIsAcceptable = TRUE )

To determine if a container has all the zones from another container. Very useful when looking to compare similar rules.

To determine if a container has all the zones from another container. Very useful when looking to compare similar rules.

Parameters

$other
mixed
$other
$anyIsAcceptable
mixed
$anyIsAcceptable

Returns

boolean
true if Zones from $other are all in this store
public
# API_setAny( )
public boolean
# API_setApplicationDefault( )

Returns

boolean
true if not already App Default
public boolean
# equals( ServiceRuleContainer $other )

Parameters

$other
ServiceRuleContainer
$other

Returns

boolean

Overrides

ObjRuleContainer::equals()
public string &
# getXPath( )

Returns

string
public boolean
# isAny( )

Returns

boolean
public boolean
# hasObjectRecursive( Service|ServiceGroup $object, boolean $anyIsAcceptable = FALSE )

Parameters

$object
Service|ServiceGroup
$anyIsAcceptable
boolean
$anyIsAcceptable

Returns

boolean
public boolean
# hasNamedObjectRecursive( string $objectName )

Parameters

$objectName
string
$objectName

Returns

boolean
public boolean
# includesStoreExpanded( ServiceRuleContainer $other, boolean $anyIsAcceptable = TRUE )

To determine if a store has all the Service from another store, it will expand ServiceGroups instead of looking for them directly. Very useful when looking to compare similar rules.

To determine if a store has all the Service from another store, it will expand ServiceGroups instead of looking for them directly. Very useful when looking to compare similar rules.

Parameters

$other
ServiceRuleContainer
$other
$anyIsAcceptable
boolean
$anyIsAcceptable if any of these objects is Any the it will return false

Returns

boolean
true if Service objects from $other are all in this store
public Service[]|ServiceGroup[] &
# membersExpanded( mixed $keepGroupsInList = FALSE )

Returns

Service[]|ServiceGroup[]
public
# toString_inline( )

Overrides

ObjRuleContainer::toString_inline()
public
# generateFastHashComp( mixed $force = FALSE )

Overrides

ObjRuleContainer::generateFastHashComp()
public boolean
# hasValue( string $value, array $check_recursive = FALSE )

Parameters

$value
string
$value
$check_recursive
array
$objects

Returns

boolean
Methods inherited from ObjRuleContainer
API_replaceReferencedObject(), __destruct(), count(), display(), displayMembersDiff(), equals_fasterHash(), getAll(), getFastHashComp(), getItemAtPosition(), getMembersDiff(), hasObjectRegex(), name(), referencedObjectRenamed(), removeAll(), replaceReferencedObject(), setName()
Methods used from PathableName
(), (), ()
Methods used from XmlConvertible
(), (), (), (), ()
Magic methods summary
public mixed
# displayMembersDiff( ServiceRuleContainer $otherObject = , mixed $indent = 0, mixed $toString = FALSE )

Parameters

$otherObject
ServiceRuleContainer
$otherObject
$indent
mixed
$indent
$toString
mixed
$toString

Returns

mixed
Properties summary
public null|ServiceStore $parentCentralStore null
#
Properties inherited from ObjRuleContainer
$name, $o, $owner
Properties used from XmlConvertible
$xmlroot
Magic properties summary
public Rule|SecurityRule|NatRule $owner
#
Magic properties inherited from ObjRuleContainer
$fasthashcomp
Magic properties used from PathableName
$name
PAN-OS-PHP API documentation generated by ApiGen 2.8.0