WatchGuardAlias
extends WatchGuardObject
in package
Class WatchGuardAlias
Table of Contents
Properties
- $default : mixed
- $enabled : mixed
- $jsonObject : mixed
- $obj : SimpleXMLElement
- $objectType : mixed
- $property : property
- $refcount : int
- $referencedBy : array<string|int, mixed>
- $type : string
- type of Alias: address, alias, group, etc.
- $XMLObject : mixed
Methods
- __construct() : mixed
- WatchGuardAlias constructor.
- debug() : void
- print object as debug output
- getDescription() : mixed
- getDescriptionPretty() : mixed
- getJsonObject() : mixed
- getName() : mixed
- getNamePretty() : mixed
- getReferencedAliases() : array<string|int, mixed>
- get all referenced aliases contained in this alias
- isDefault() : bool
- isEnabled() : mixed
- isReferenced() : mixed
- isUnused() : mixed
- isXMLObject() : mixed
- prepareJson() : mixed
- setDefault() : mixed
- setEnabled() : mixed
- storeReference() : mixed
- stores a reference to this object.
- textout() : mixed
- output for alias objects, suppressing some defaults overloads base class method
- printName() : mixed
- print the name of $this
- verbosetextout() : mixed
- verbose output of alias contents.
Properties
$default
protected
mixed
$default
= false
$enabled
protected
mixed
$enabled
$jsonObject
protected
mixed
$jsonObject
= []
$obj
protected
SimpleXMLElement
$obj
stored object
$objectType
protected
mixed
$objectType
$property
protected
property
$property
of this object (proberty value from xml file)
$refcount
protected
int
$refcount
count of references to this object
$referencedBy
protected
array<string|int, mixed>
$referencedBy
list of object names which reference this object.
$type
type of Alias: address, alias, group, etc.
protected
string
$type
$XMLObject
protected
mixed
$XMLObject
= true
Methods
__construct()
WatchGuardAlias constructor.
public
__construct(SimpleXMLElement $element) : mixed
Parameters
- $element : SimpleXMLElement
debug()
print object as debug output
public
debug() : void
getDescription()
public
getDescription() : mixed
getDescriptionPretty()
public
getDescriptionPretty() : mixed
getJsonObject()
public
getJsonObject() : mixed
getName()
public
getName() : mixed
getNamePretty()
public
getNamePretty() : mixed
getReferencedAliases()
get all referenced aliases contained in this alias
public
getReferencedAliases() : array<string|int, mixed>
Return values
array<string|int, mixed> —of referencedAlias->__toString();
isDefault()
public
isDefault() : bool
Return values
boolisEnabled()
public
isEnabled() : mixed
isReferenced()
public
isReferenced() : mixed
isUnused()
public
isUnused() : mixed
isXMLObject()
public
isXMLObject() : mixed
prepareJson()
public
prepareJson(mixed $xmlfile) : mixed
Parameters
- $xmlfile : mixed
setDefault()
public
setDefault(bool $default) : mixed
Parameters
- $default : bool
setEnabled()
public
setEnabled(bool $value) : mixed
Parameters
- $value : bool
storeReference()
stores a reference to this object.
public
storeReference(mixed $name, mixed $type) : mixed
Parameters
- $name : mixed
-
string name of reference to store
- $type : mixed
-
string type of reference (policy|alias|...)
textout()
output for alias objects, suppressing some defaults overloads base class method
public
textout(WatchGuardXMLFile $xmlfile) : mixed
Parameters
- $xmlfile : WatchGuardXMLFile
printName()
print the name of $this
protected
printName(mixed $xmlfile) : mixed
Parameters
- $xmlfile : mixed
-
WatchGuardXMLFile in which other objects can be found
verbosetextout()
verbose output of alias contents.
protected
verbosetextout(WatchGuardXMLFile $xmlfile) : mixed
overloads base class method
Parameters
- $xmlfile : WatchGuardXMLFile