# Class DoSRule

© 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

  Rule uses PathableName, centralServiceStoreUser, centralAddressStoreUser, ObjectWithDescription, XmlConvertible
  RuleWithUserID
  DoSRule uses NegatableRule

Located at rule-classes/DoSRule.php

Methods summary
`protected` | # `load_from( )` For developer use only For developer use only #### Overrides `Rule::load_from()`
`protected` | # `load_to( )` For developer use only For developer use only #### Overrides `Rule::load_to()`
`public` | # `__construct( `RuleStore` $owner, boolean $fromTemplateXML = FALSE )` DoSRule constructor. DoSRule constructor. #### Parameters $owner ``RuleStore`` $owner $fromTemplateXML `boolean` $fromTemplateXML
`public` | # `load_from_domxml( mixed $xml )`
`public` | # `action( )`
`public` | # `display( mixed $padding = 0 )`
`public` | # `cleanForDestruction( )`
`public` | # `isDoSRule( )` #### Overrides `Rule::isDoSRule()`
`public` | # `ruleNature( )` #### Overrides `Rule::ruleNature()`
`public` | # `isZoneBasedFrom( )`
`public` | # `isZoneBasedTo( )`
`public` | # `isInterfaceBasedFrom( )`
`public` | # `isInterfaceBasedTo( )`
`public` | # `storeVariableName( )`

Methods inherited from RuleWithUserID
`userID_IsAny(), userID_IsCustom(), userID_IsKnown(), userID_IsPreLogon(), userID_IsUnknown(), userID_getUsers(), userID_loadUsersFromXml(), userID_setUsers(), userID_type()`

Methods inherited from Rule
`API_clearPolicyAppUsageDATA(), API_setDisabled(), API_setEnabled(), API_setName(), API_target_addDevice(), API_target_negateSet(), API_target_removeDevice(), API_target_setAny(), getXPath(), isAppOverrideRule(), isAuthenticationRule(), isCaptivePortalRule(), isDecryptionRule(), isDisabled(), isEnabled(), isNatRule(), isPbfRule(), isPostRule(), isPreRule(), isQoSRule(), isSecurityRule(), load_common_from_domxml(), load_destination(), load_source(), name(), rewriteSDisabled_XML(), setDisabled(), setEnabled(), setName(), target_addDevice(), target_hasDeviceAndVsys(), target_isAny(), target_isNegated(), target_negateSet(), target_removeDevice(), target_rewriteXML(), target_setAny(), targets(), targets_toString(), uuid(), zoneCalculation(), zoneCalculationNatClone()`

Methods used from NegatableRule
`(), (), (), (), (), (), ()`

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

Methods used from centralServiceStoreUser
`()`

Methods used from centralAddressStoreUser
`()`

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

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

Constants summary
`string` | `ActionDeny` | `'Deny'` | #
`string` | `ActionAllow` | `'Allow'` | #
`string` | `ActionProtect` | `'Protect'` | #

Constants inherited from RuleWithUserID
`__UserIDType_Any, __UserIDType_Custom, __UserIDType_Known, __UserIDType_PreLogon, __UserIDType_Unknown`

Properties summary
`public static string` | $templatexml | `'<entry name="**temporarynamechangeme**"><from><zone></zone></from><to><zone></zone>></to> <protection/><source><member>any</member></source><destination><member>any</member></destination> <source-user><member>any</member></source-user><service><member>any</member></service><action><deny/></action></entry>'` | #
`protected static mixed` | $templatexmlroot | `null` | #
`protected string` | $action | ``DoSRule::ActionDeny`` | #
`public `ZoneRuleContainer`|`InterfaceContainer`` | $from | `` | #
`public `ZoneRuleContainer`|`InterfaceContainer`` | $to | `` | #
`protected boolean` | $_zoneBasedFrom | `TRUE` | #
`protected boolean` | $_zoneBasedTo | `TRUE` | #

Properties inherited from RuleWithUserID
`$_userIDType, $_users`

Properties inherited from Rule
`$_targetIsNegated, $_targets, $destination, $disabled, $name, $owner, $services, $source, $tags`

Properties used from centralServiceStoreUser
`$parentServiceStore`

Properties used from centralAddressStoreUser
`$parentAddressStore`

Properties used from ObjectWithDescription
`$_description`

Properties used from XmlConvertible
`$xmlroot`

Properties used from NegatableRule
`$_destinationIsNegated, $_sourceIsNegated`

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

Magic properties used from ObjectWithDescription
`$xmlroot`