# Class Tag

© 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

  Tag uses ReferenceableObject, PathableName, XmlConvertible

Located at object-classes/Tag.php

Methods summary
`public` | # `__construct( string $name, `TagStore`|null $owner, boolean $fromXmlTemplate = FALSE )` #### Parameters $name `string` $name $owner ``TagStore`|null` $owner $fromXmlTemplate `boolean` $fromXmlTemplate
`public boolean` | # `setName( string $newName )` #### Parameters $newName `string` $newName #### Returns `boolean`
`public` | # `API_setName( string $newName )` #### Parameters $newName `string` $newName
`public boolean` | # `setColor( string $newColor, boolean $rewriteXml = TRUE )` #### Parameters $newColor `string` $newColor $rewriteXml `boolean` $rewriteXml #### Returns `boolean`
`public boolean` | # `API_setColor( string $newColor )` #### Parameters $newColor `string` $newColor #### Returns `boolean`
`public array` | # `availableColors( )` #### Returns `array`
`public string &` | # `getXPath( )` #### Returns `string`
`public` | # `isTmp( )`
`public` | # `load_from_domxml( `DOMElement` $xml )`
`public string` | # `getColor( )` #### Returns `string`
`public string` | # `getComments( )` #### Returns `string`
`public boolean` | # `addComments( mixed $newComment, mixed $rewriteXml = TRUE )` @param string $newComment @param bool $rewriteXml @param string $newComment @param bool $rewriteXml #### Returns `boolean`
`public boolean` | # `API_addComments( string $newComment )` #### Parameters $newComment `string` $newComment #### Returns `boolean`
`public boolean` | # `deleteComments( )` #### Returns `boolean`
`public boolean` | # `API_deleteComments( )` #### Returns `boolean`
`public` | # `isTag( )`
`public boolean` | # `equals( mixed $otherObject )` #### Parameters $otherObject `mixed` $otherObject Tag #### Returns `boolean`
`public` | # `sameValue( `Tag` $otherObject )`

Methods used from ReferenceableObject
`(), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), ()`

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

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

Constants summary
`string` | `NONE` | `'none'` | #
`string` | `color1` | `'red'` | #
`string` | `color2` | `'green'` | #
`string` | `color3` | `'blue'` | #
`string` | `color4` | `'yellow'` | #
`string` | `color5` | `'copper'` | #
`string` | `color6` | `'orange'` | #
`string` | `color7` | `'purple'` | #
`string` | `color8` | `'gray'` | #
`string` | `color9` | `'light green'` | #
`string` | `color10` | `'cyan'` | #
`string` | `color11` | `'light gray'` | #
`string` | `color12` | `'blue gray'` | #
`string` | `color13` | `'lime'` | #
`string` | `color14` | `'black'` | #
`string` | `color15` | `'gold'` | #
`string` | `color16` | `'brown'` | #
`string` | `color17` | `'dark green'` | #
`string` | `color19` | `'Maroon'` | #
`string` | `color20` | `'Red-Orange'` | #
`string` | `color21` | `'Yellow-Orange'` | #
`string` | `color22` | `'Forest Green'` | #
`string` | `color23` | `'Turquoise Blue'` | #
`string` | `color24` | `'Azure Blue'` | #
`string` | `color25` | `'Cerulean Blue'` | #
`string` | `color26` | `'Midnight Blue'` | #
`string` | `color27` | `'Medium Blue'` | #
`string` | `color28` | `'Cobalt Blue'` | #
`string` | `color29` | `'Violet Blue'` | #
`string` | `color30` | `'Blue Violet'` | #
`string` | `color31` | `'Medium Violet'` | #
`string` | `color32` | `'Medium Rose'` | #
`string` | `color33` | `'Lavender'` | #
`string` | `color34` | `'Orchid'` | #
`string` | `color35` | `'Thistle'` | #
`string` | `color36` | `'Peach'` | #
`string` | `color37` | `'Salmon'` | #
`string` | `color38` | `'Magenta'` | #
`string` | `color39` | `'Red Violet'` | #
`string` | `color40` | `'Mahogany'` | #
`string` | `color41` | `'Burnt Sienna'` | #
`string` | `color42` | `'Chestnut'` | #

Properties summary
`public `TagStore`|null` | $owner | `null` | #
`public string|null` | $color | `` | #
`public string|null` | $comments | `` | #
`public static array` | $TagColors | `array( self::NONE => 'none', self::color1 => 'color1', self::color2 => 'color2', self::color3 => 'color3', self::color4 => 'color4', self::color5 => 'color5', self::color6 => 'color6', self::color7 => 'color7', self::color8 => 'color8', self::color9 => 'color9', self::color10 => 'color10', self::color11 => 'color11', self::color12 => 'color12', self::color13 => 'color13', self::color14 => 'color14', self::color15 => 'color15', self::color16 => 'color16', self::color17 => 'color17', //color18 not defined in PAN-OS self::color19 => 'color19', self::color20 => 'color20', self::color21 => 'color21', self::color22 => 'color22', self::color23 => 'color23', self::color24 => 'color24', self::color25 => 'color25', self::color26 => 'color26', self::color27 => 'color27', self::color28 => 'color28', self::color29 => 'color29', self::color30 => 'color30', self::color31 => 'color31', self::color32 => 'color32', self::color33 => 'color33', self::color34 => 'color34', self::color35 => 'color35', self::color36 => 'color36', self::color37 => 'color37', self::color38 => 'color38', self::color39 => 'color39', self::color40 => 'color40', self::color41 => 'color41', self::color42 => 'color42' )` | #
`public static string` | $templatexml | `'<entry name="**temporarynamechangeme**"></entry>'` | #

Properties used from ReferenceableObject
`$name, $refcomphash, $refrules`

Properties used from XmlConvertible
`$xmlroot`

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