Class Rule

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

Rule uses PathableName, centralServiceStoreUser, centralAddressStoreUser, ObjectWithDescription, XmlConvertible

Direct known subclasses

AppOverrideRule, CaptivePortalRule, NatRule, RuleWithUserID

Indirect known subclasses

AuthenticationRule, DecryptionRule, DoSRule, PbfRule, QoSRule, SecurityRule

Located at rule-classes/Rule.php

Methods summary
`public string`	# `name( )` Returns name of this rule Returns name of this rule Returns `string`
`public string`	# `uuid( )` Returns uuid of this rule Returns uuid of this rule Returns `string`
`public boolean`	# `isDisabled( )` Returns `boolean`
`public boolean`	# `isEnabled( )` Returns `boolean`
`protected`	# `load_from( )` For developer use only For developer use only
`protected`	# `load_to( )` For developer use only For developer use only
`protected`	# `load_source( )` For developer use only For developer use only
`protected`	# `load_destination( )` For developer use only For developer use only
`protected`	# `load_common_from_domxml( )` For developer use only For developer use only
`public boolean`	# `target_setAny( )` Returns `boolean` TRUE if an update was made
`public boolean`	# `API_target_setAny( )` Returns `boolean` TRUE if an update was made
`public boolean`	# `target_addDevice( string $serialNumber, null\|string $vsys = null )` Parameters `$serialNumber` `string` $serialNumber `$vsys` `null\|string` $vsys Returns `boolean` TRUE if a change was made
`public boolean`	# `API_target_addDevice( string $serialNumber, null\|string $vsys )` Parameters `$serialNumber` `string` $serialNumber `$vsys` `null\|string` $vsys Returns `boolean` TRUE if a change was made
`public boolean`	# `target_removeDevice( string $serialNumber, null\|string $vsys = null )` Parameters `$serialNumber` `string` $serialNumber `$vsys` `null\|string` $vsys Returns `boolean` TRUE if a change was made
`public boolean`	# `API_target_removeDevice( string $serialNumber, null\|string $vsys )` Parameters `$serialNumber` `string` $serialNumber `$vsys` `null\|string` $vsys Returns `boolean` TRUE if a change was made
`public`	# `target_rewriteXML( )`
`public boolean`	# `target_negateSet( mixed $TRUEorFALSE )` Returns `boolean` TRUE if an update was made Var bool $TRUEorFALSE
`public`	# `target_isNegated( )`
`public boolean`	# `API_target_negateSet( mixed $TRUEorFALSE )` Returns `boolean` TRUE if an update was made Var bool $TRUEorFALSE
`public`	# `targets( )`
`public`	# `targets_toString( )`
`public`	# `target_isAny( )`
`public boolean`	# `target_hasDeviceAndVsys( string $deviceSerial, string\|null $vsys = null )` Parameters `$deviceSerial` `string` $deviceSerial `$vsys` `string\|null` $vsys Returns `boolean`
`protected`	# `rewriteSDisabled_XML( )` For developer use only For developer use only
`public boolean`	# `setDisabled( boolean $disabled )` disable rule if $disabled = true, enable it if not disable rule if $disabled = true, enable it if not Parameters `$disabled` `boolean` $disabled Returns `boolean` true if value has changed
`public boolean`	# `API_setDisabled( boolean $disabled )` disable rule if $disabled = true, enable it if not disable rule if $disabled = true, enable it if not Parameters `$disabled` `boolean` $disabled Returns `boolean` true if value has changed
`public`	# `setEnabled( mixed $enabled )`
`public`	# `API_setEnabled( mixed $enabled )`
`public &`	# `getXPath( )`
`public boolean`	# `setName( string $name )` return true if change was successful false if not (duplicate rulename?) return true if change was successful false if not (duplicate rulename?) Parameters `$name` `string` $name new name for the rule Returns `boolean`
`public`	# `API_setName( string $newname )` Parameters `$newname` `string` $newname
`public`	# `API_clearPolicyAppUsageDATA( )`
`public`	# `zoneCalculation( mixed $fromOrTo, mixed $mode = "append", mixed $virtualRouter = "autodetermine", mixed $template_name = "notPanorama", mixed $vsys_name = "notPanorama" )`
`public`	# `zoneCalculationNatClone( mixed $zoneArray, mixed $zoneStore, mixed $padding, mixed $isAPI )`
`public`	# `isPreRule( )`
`public`	# `isPostRule( )`
`public`	# `isSecurityRule( )`
`public`	# `isNatRule( )`
`public`	# `isDecryptionRule( )`
`public`	# `isAppOverrideRule( )`
`public`	# `isCaptivePortalRule( )`
`public`	# `isAuthenticationRule( )`
`public`	# `isPbfRule( )`
`public`	# `isQoSRule( )`
`public`	# `isDoSRule( )`
`public`	# `ruleNature( )`

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

Methods used from centralServiceStoreUser
`()`

Methods used from centralAddressStoreUser
`()`

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

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

Properties summary
`protected string`	`$name`	`'temporaryname'`	#
`protected boolean`	`$disabled`	`FALSE`	#
`public ZoneRuleContainer`	`$from`	`null`	#
`public ZoneRuleContainer`	`$to`	`null`	#
`public AddressRuleContainer`	`$source`		#
`public AddressRuleContainer`	`$destination`		#
`public TagRuleContainer`	`$tags`		#
`public ServiceRuleContainer`	`$services`		#
`public RuleStore`	`$owner`	`null`	#
`protected null\|string[][]`	`$_targets`	`null`	#
`protected boolean`	`$_targetIsNegated`	`FALSE`	#

Properties used from centralServiceStoreUser
`$parentServiceStore`

Properties used from centralAddressStoreUser
`$parentAddressStore`

Properties used from ObjectWithDescription
`$_description`

Properties used from XmlConvertible
`$xmlroot`

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

Magic properties used from ObjectWithDescription
`$xmlroot`

Namespaces

Classes

Interfaces

Traits

Functions

Class Rule

Direct known subclasses

Indirect known subclasses

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Var

Returns

Var

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters