Class RuleStore

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

RuleStore uses PathableName, XmlConvertible

Located at rule-classes/RuleStore.php

Methods summary
`public`	# `__construct( mixed $owner, mixed $ruleType, mixed $isPreOrPost = FALSE )`
`public boolean`	# `countDyn_IP_and_Port_SNat( boolean $countDisabledRules = FALSE )` Counts how many NAT rules in this Store are DIPP. If $countDisabledRules=true then it also count disabled rules Counts how many NAT rules in this Store are DIPP. If $countDisabledRules=true then it also count disabled rules Parameters `$countDisabledRules` `boolean` $countDisabledRules Returns `boolean`
`public`	# `load_from_domxml( DOMElement\|null $xml, DOMElement\|null $xmlPost = null )` For developer use only For developer use only Parameters `$xml` `DOMElement\|null` $xml `$xmlPost` `DOMElement\|null` $xmlPost
`public boolean`	# `addRule( SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule\|QoSRule\|DoSRule $rule, boolean $inPost = FALSE )` Parameters `$rule` `SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule\|QoSRule\|DoSRule` $rule `$inPost` `boolean` $inPost Returns `boolean`
`public boolean`	# `API_addRule( SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule\|QoSRule\|DoSRule $rule, boolean $inPost = FALSE )` Parameters `$rule` `SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule\|QoSRule\|DoSRule` $rule `$inPost` `boolean` $inPost Returns `boolean`
`public boolean`	# `inStore( SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule\|QoSRule\|DoSRule $rule )` Parameters `$rule` `SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule\|QoSRule\|DoSRule` $rule Returns `boolean`
`public boolean`	# `moveRuleToPostRulebase( SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule\|QoSRule\|DoSRule $rule )` Parameters `$rule` `SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule\|QoSRule\|DoSRule` $rule Returns `boolean`
`public boolean`	# `API_moveRuleToPostRulebase( SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule\|QoSRule\|DoSRule $rule )` Parameters `$rule` `SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule\|QoSRule\|DoSRule` $rule Returns `boolean`
`public boolean`	# `moveRuleToPreRulebase( SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule\|QoSRule\|DoSRule $rule )` Parameters `$rule` `SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule\|QoSRule\|DoSRule` $rule Returns `boolean`
`public boolean`	# `API_moveRuleToPreRulebase( SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule\|QoSRule\|DoSRule $rule )` Parameters `$rule` `SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule\|QoSRule\|DoSRule` $rule Returns `boolean`
`public boolean`	# `isRuleNameAvailable( string $name, boolean $nested = TRUE )` Check if this name is available (for new rule for example) Check if this name is available (for new rule for example) Parameters `$name` `string` $name `$nested` `boolean` $nested Returns `boolean`
`public string &`	# `getStoreVarName( )` Returns `string`
`public string`	# `findAvailableName( string $base, string $suffix = '', integer\|string $startCount = '' )` Parameters `$base` `string` $base `$suffix` `string` $suffix `$startCount` `integer\|string` $startCount Returns `string`
`public`	# `ruleWasRenamed( SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule\|QoSRule\|DoSRule $rule, string $oldName )` Only used internally when a rule is renamed to check for it unicity and accurate indexing Only used internally when a rule is renamed to check for it unicity and accurate indexing Parameters `$rule` `SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule\|QoSRule\|DoSRule` $rule `$oldName` `string` $oldName
`public Rule\|SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule\|QoSRule\|DoSRule`	# `cloneRule( Rule\|SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule\|QoSRule\|DoSRule $rule, string $newName = null, null\|boolean $inPostRuleBase = null )` Parameters `$rule` `Rule\|SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule\|QoSRule\|DoSRule` $rule `$newName` `string` $newName `$inPostRuleBase` `null\|boolean` $inPostRuleBase Returns `Rule\|SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule\|QoSRule\|DoSRule`
`public NatRule\|SecurityRule`	# `API_cloneRule( SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule\|QoSRule\|DoSRule $rule, string $newName, mixed $inPostRuleBase = null )` Parameters `$rule` `SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule\|QoSRule\|DoSRule` $rule `$newName` `string` $newName `$inPostRuleBase` `mixed` $inPostRuleBase null\|bool Returns `NatRule\|SecurityRule`
`public`	# `moveRuleAfter( SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule\|QoSRule\|DoSRule $ruleToBeMoved, SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule\|QoSRule\|DoSRule $ruleRef, boolean $rewriteXml = TRUE )` this function will move $ruleToBeMoved after $ruleRef. this function will move $ruleToBeMoved after $ruleRef. Parameters `$ruleToBeMoved` `SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule\|QoSRule\|DoSRule` $ruleToBeMoved `$ruleRef` `SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule\|QoSRule\|DoSRule` $ruleRef `$rewriteXml` `boolean` $rewriteXml
`public`	# `API_moveRuleAfter( SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule $ruleToBeMoved, SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule $ruleRef, boolean $rewritexml = TRUE )` Parameters `$ruleToBeMoved` `SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule` $ruleToBeMoved `$ruleRef` `SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule` $ruleRef `$rewritexml` `boolean` $rewritexml
`public`	# `removeAll( )`
`public`	# `moveRuleBefore( SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule $ruleToBeMoved, SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule $ruleRef, boolean $rewriteXml = TRUE )` this function will move $ruleToBeMoved before $ruleRef. this function will move $ruleToBeMoved before $ruleRef. Parameters `$ruleToBeMoved` `SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule` $ruleToBeMoved `$ruleRef` `SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule` $ruleRef `$rewriteXml` `boolean` $rewriteXml
`public`	# `API_moveRuleBefore( SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule $ruleToBeMoved, SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule $ruleRef, boolean $rewritexml = TRUE )` Parameters `$ruleToBeMoved` `SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule` $ruleToBeMoved `$ruleRef` `SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|AuthenticationRule\|PbfRule` $ruleRef `$rewritexml` `boolean` $rewritexml
`public SecurityRule[]\|NatRule[]\|DecryptionRule[]\|AppOverrideRule[]\|CaptivePortalRule[]\|AuthenticationRule[]\|PbfRule[] &`	# `rules( null\|string\|string[] $withFilter = null )` Returns an Array with all Rules inside this store Returns an Array with all Rules inside this store Parameters `$withFilter` `null\|string\|string[]` $withFilter Returns `SecurityRule[]\|NatRule[]\|DecryptionRule[]\|AppOverrideRule[]\|CaptivePortalRule[]\|AuthenticationRule[]\|PbfRule[]`
`public SecurityRule[]\|NatRule[]\|DecryptionRule[]\|AppOverrideRule[]\|CaptivePortalRule[]\|AuthenticationRule[]\|PbfRule[] &`	# `resultingRuleSet( )` Returns an Array with all Rules inside this store Returns an Array with all Rules inside this store Returns `SecurityRule[]\|NatRule[]\|DecryptionRule[]\|AppOverrideRule[]\|CaptivePortalRule[]\|AuthenticationRule[]\|PbfRule[]`
`public SecurityRule[]\|NatRule[]\|DecryptionRule[]\|AppOverrideRule[]\|CaptivePortalRule[]\|AuthenticationRule[]\|PbfRule[] &`	# `resultingPreRuleSet( )` Returns an Array with all Rules inside this store Returns an Array with all Rules inside this store Returns `SecurityRule[]\|NatRule[]\|DecryptionRule[]\|AppOverrideRule[]\|CaptivePortalRule[]\|AuthenticationRule[]\|PbfRule[]`
`public SecurityRule[]\|NatRule[]\|DecryptionRule[]\|AppOverrideRule[]\|CaptivePortalRule[]\|CaptivePortalRule[]\|PbfRule[] &`	# `resultingPostRuleSet( )` Returns an Array with all Rules inside this store Returns an Array with all Rules inside this store Returns `SecurityRule[]\|NatRule[]\|DecryptionRule[]\|AppOverrideRule[]\|CaptivePortalRule[]\|CaptivePortalRule[]\|PbfRule[]`
`public`	# `count( )` Counts the number of rules in this store Counts the number of rules in this store
`public`	# `display( )` Displays all rules inside this store in a more less readable format :) Displays all rules inside this store in a more less readable format :)
`public Rule\|SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|CaptivePortalRule[]\|PbfRule\|QoSRule\|DoSRule`	# `find( string $name )` Look for a rule named $name. Return NULL if not found Look for a rule named $name. Return NULL if not found Parameters `$name` `string` $name Returns `Rule\|SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|CaptivePortalRule[]\|PbfRule\|QoSRule\|DoSRule`
`public SecurityRule`	# `newSecurityRule( string $name, boolean $inPost = FALSE )` Creates a new SecurityRule in this store. It will be placed at the end of the list. Creates a new SecurityRule in this store. It will be placed at the end of the list. Parameters `$name` `string` $name name of the new Rule `$inPost` `boolean` $inPost create it in post or pre (if applicable) Returns `SecurityRule`
`public CaptivePortalRule`	# `newCaptivePortalRule( string $name, boolean $inPost = FALSE )` Creates a new SecurityRule in this store. It will be placed at the end of the list. Creates a new SecurityRule in this store. It will be placed at the end of the list. Parameters `$name` `string` $name name of the new Rule `$inPost` `boolean` $inPost create it in post or pre (if applicable) Returns `CaptivePortalRule`
`public AuthenticationRule`	# `newAuthenticationRule( string $name, boolean $inPost = FALSE )` Creates a new AuthenticationRule in this store. It will be placed at the end of the list. Creates a new AuthenticationRule in this store. It will be placed at the end of the list. Parameters `$name` `string` $name name of the new Rule `$inPost` `boolean` $inPost create it in post or pre (if applicable) Returns `AuthenticationRule`
`public NatRule`	# `newNatRule( String $name, boolean $inPost = FALSE )` Creates a new NatRule in this store. It will be placed at the end of the list. Creates a new NatRule in this store. It will be placed at the end of the list. Parameters `$name` `String` $name name of the new Rule `$inPost` `boolean` $inPost create it in post or pre (if applicable) Returns `NatRule`
`public PBFRule`	# `newPbfRule( String $name, boolean $inPost = FALSE )` Creates a new PBFRule in this store. It will be placed at the end of the list. Creates a new PBFRule in this store. It will be placed at the end of the list. Parameters `$name` `String` $name name of the new Rule `$inPost` `boolean` $inPost create it in post or pre (if applicable) Returns `PBFRule`
`public QoSRule`	# `newQoSRule( String $name, boolean $inPost = FALSE )` Creates a new QoSRule in this store. It will be placed at the end of the list. Creates a new QoSRule in this store. It will be placed at the end of the list. Parameters `$name` `String` $name name of the new Rule `$inPost` `boolean` $inPost create it in post or pre (if applicable) Returns `QoSRule`
`public DoSRule`	# `newDoSRule( String $name, boolean $inPost = FALSE )` Creates a new DoSRule in this store. It will be placed at the end of the list. Creates a new DoSRule in this store. It will be placed at the end of the list. Parameters `$name` `String` $name name of the new Rule `$inPost` `boolean` $inPost create it in post or pre (if applicable) Returns `DoSRule`
`public AppOverrideRule`	# `newAppOverrideRule( String $name, boolean $inPostRulebase = FALSE )` Creates a new AppOverrideRule in this store. It will be placed at the end of the list. Creates a new AppOverrideRule in this store. It will be placed at the end of the list. Parameters `$name` `String` $name name of the new Rule `$inPostRulebase` `boolean` $inPostRulebase create it in post or pre (if applicable) Returns `AppOverrideRule`
`public boolean`	# `remove( mixed $rule, boolean $deleteForever = FALSE )` Removes a rule from this store (must be passed an object, not string/name). Returns TRUE if found. Removes a rule from this store (must be passed an object, not string/name). Returns TRUE if found. Parameters `$rule` `mixed` $rule SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|PbfRule\|QoSRule\|DoSRule `$deleteForever` `boolean` $deleteForever Returns `boolean`
`public boolean`	# `API_remove( mixed $rule, boolean $deleteForever = FALSE )` Removes a rule from this store (must be passed an object, not string/name). Returns TRUE if found. Removes a rule from this store (must be passed an object, not string/name). Returns TRUE if found. Parameters `$rule` `mixed` $rule SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|PbfRule\|QoSRule\|DoSRule `$deleteForever` `boolean` $deleteForever Returns `boolean`
`public`	# `rewriteXML( )` Rewrite XML for this object, useful after a batch editing to save computing time. You should not need to call it by yourself in normal situations Rewrite XML for this object, useful after a batch editing to save computing time. You should not need to call it by yourself in normal situations
`protected`	# `regen_Indexes( )`
`public string`	# `name( )` Returns `string`
`public string &`	# `getXPath( SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|PbfRule\|QoSRule\|DoSRule $contextRule )` Parameters `$contextRule` `SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|PbfRule\|QoSRule\|DoSRule` $contextRule Returns `string` Throws `Exception`
`public Rule[]\|SecurityRule[]\|NatRule[]\|DecryptionRule[]\|AppOverrideRule[]\|CaptivePortalRule[]\|PbfRule[]\|QoSRule\|DoSRule[]\|\|DoSRule[]`	# `preRules( )` Returns `Rule[]\|SecurityRule[]\|NatRule[]\|DecryptionRule[]\|AppOverrideRule[]\|CaptivePortalRule[]\|PbfRule[]\|QoSRule\|DoSRule[]\|\|DoSRule[]`
`public Rule[]\|SecurityRule[]\|NatRule[]\|DecryptionRule[]\|AppOverrideRule[]\|CaptivePortalRule[]\|PbfRule[]\|QoSRule\|DoSRule[]\|\|DoSRule[]`	# `postRules( )` Returns `Rule[]\|SecurityRule[]\|NatRule[]\|DecryptionRule[]\|AppOverrideRule[]\|CaptivePortalRule[]\|PbfRule[]\|QoSRule\|DoSRule[]\|\|DoSRule[]`
`public boolean`	# `ruleIsPreRule( Rule $rule )` Parameters `$rule` `mixed` $rule Returns `boolean` Throws `Exception`
`public boolean`	# `ruleIsPostRule( mixed $rule )` Parameters `$rule` `mixed` $rule Returns `boolean` Throws `Exception`
`public integer`	# `countPreRules( )` Returns `integer` Throws `Exception`
`public integer`	# `countPostRules( )` Returns `integer` Throws `Exception`
`public integer`	# `getRulePosition( string\|Rule\|SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|PbfRule\|QoSRule\|DoSRule $rule )` Parameters `$rule` `string\|Rule\|SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|PbfRule\|QoSRule\|DoSRule` $rule Returns `integer`
`public null\|Rule\|SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|PbfRule\|QoSRule\|DoSRule`	# `getRuleOnTop( null\|boolean $lookInPreRules = TRUE )` Parameters `$lookInPreRules` `null\|boolean` $lookInPreRules Returns `null\|Rule\|SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|PbfRule\|QoSRule\|DoSRule` null if not found
`public null\|Rule\|SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|PbfRule\|QoSRule\|DoSRule`	# `getRuleAtBottom( null\|boolean $lookInPreRules = TRUE )` Parameters `$lookInPreRules` `null\|boolean` $lookInPreRules Returns `null\|Rule\|SecurityRule\|NatRule\|DecryptionRule\|AppOverrideRule\|CaptivePortalRule\|PbfRule\|QoSRule\|DoSRule` null if not found
`public`	# `createXmlRoot( )`
`public`	# `createPostXmlRoot( )`

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

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

Properties summary
`protected Rule[]\|SecurityRule[]\|NatRule[]\|DecryptionRule[]\|AppOverrideRule[]\|CaptivePortalRule[]\|PbfRule[]\|QoSRule\|DoSRule[]\|\|DoSRule[]`	`$_rules`	`array()`	#
`protected Rule[]\|SecurityRule[]\|NatRule[]\|DecryptionRule[]\|AppOverrideRule[]\|CaptivePortalRule[]\|PbfRule[]\|QoSRule\|DoSRule[]\|\|DoSRule[]`	`$_postRules`	`array()`	#
`public VirtualSystem\|DeviceGroup\|PanoramaConf\|PANConf\|FawkesConf\|Container\|DeviceCloud`	`$owner`	`null`	#
`public string`	`$name`	`'temporaryname'`	#
`public string[]\|DOMElement`	`$postRulesRoot`	`null`	#
`protected string`	`$type`	`'needsomethinghere'`	#
`protected mixed`	`$fastMemToIndex`	`null`	#
`protected mixed`	`$fastNameToIndex`	`null`	#
`protected mixed`	`$fastMemToIndex_forPost`	`null`	#
`protected mixed`	`$fastNameToIndex_forPost`	`null`	#
`public NetworkPropertiesContainer\|null`	`$_networkStore`	`null`	#
`public integer`	`$version`		#
`protected boolean`	`$isPreOrPost`	`FALSE`	#

Properties used from XmlConvertible
`$xmlroot`

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

Namespaces

Classes

Interfaces

Traits

Functions

Class RuleStore

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Throws

Returns

Returns

Parameters

Returns

Throws

Parameters

Returns

Throws

Returns

Throws

Returns

Throws