# Trait ObjectWithDescription

#### Direct Known Users

Address, AddressGroup, SecurityProfileAntiSpyware, SecurityProfileAntiVirus, SecurityProfileDNSSecurity, SecurityProfileFileBlocking, SecurityProfileURL, SecurityProfileVirusAndWildfire, SecurityProfileVulnerability, SecurityProfileWildfire, Service, CustomSecurityProfileURL, DecryptionProfile, EthernetInterface, HipObjectsProfile, HipProfilesProfile, PredefinedSecurityProfileURL, Rule, SecurityProfile

#### Indirect Known Users

AggregateEthernetInterface, AppOverrideRule, SecurityRule, AuthenticationRule, CaptivePortalRule, DecryptionRule, DoSRule, NatRule, PbfRule, QoSRule, RuleWithUserID
Located at misc-classes/trait/ObjectWithDescription.php

Methods summary
`public string` | # `description( )` #### Returns `string` if no description then string will be empty: ''
`public boolean` | # `setDescription( null|string $newDescription = null, mixed $tagName = "description" )` #### Parameters $newDescription `null|string` $newDescription empty or null description will erase existing one $tagName #### Returns `boolean` false if no update was made to description (already had same value)
`public boolean` | # `API_setDescription( string $newDescription, mixed $tagName = "description" )` #### Parameters $newDescription `string` $newDescription $tagName #### Returns `boolean` true if value was changed
`public` | # `description_merge( `Rule` $other )`
`protected` | # `_load_description_from_domxml( )`

Properties summary
`protected string` | $_description | `null` | #

Magic properties summary
`public `DOMElement`|null` | $xmlroot | #