Class: HKEY

Source Location: /libraries/vwp/sys/registry/key.php

Class Overview [line 29]

VType
   |
   --VObject
      |
      --HKEY

VWP Registry Library

Author(s):

Version:

Copyright:

  • (c) Ralph Ritoch - All Rights Reserved

Variables

Constants

Methods


Child classes:

HKEY_CURRENT_CONFIG
VWP Registry Library
HKEY_USERS
VWP Registry Library
HKEY_LOCAL_MACHINE
VWP Registry Library
HKEY_CURRENT_USER
VWP Registry Library
HKEY_CLASSES_ROOT
VWP Registry Library

Inherited Variables

Inherited Constants

Inherited Methods

Class: VObject

VObject::__construct()
Class Constructor
VObject::bind()
Bind values to this object
VObject::delete()
Delete Object
VObject::get()
Get value
VObject::getAll()
Get all object values
VObject::getError()
Get error message
VObject::getErrors()
Get errors
VObject::getMethods()
Get object methods
VObject::getProperties()
Get object properties
VObject::save()
Save Object
VObject::set()
Set a value
VObject::setError()
Set error value
VObject::setProperties()
Set property values
VObject::setProperty()
Set property value
VObject::toString()
Convert object to string
VObject::__destruct()
Class Destructor
VObject::__get()
VObject::__isset()
VObject::__set()
VObject::__toString()
Return object as a string
VObject::__unset()


Class Details

VWP Registry Library

This is the base class for Registry Key Objects.

Tags:

[ Top ]


Class Variables

$doc

[line 39]

DomDocument Containing Key Data

Tags:

  • var - Dom Document
  • access - public

Type: object

Overrides:

[ Top ]

$rootKey

[line 57]

Key Node Name

Tags:

  • var - Key Node Name
  • access - public

Type: string

Overrides:

[ Top ]

$rootNode

[line 48]

Root Element for this Key

Tags:

  • var - Root Node for this key
  • access - public

Type: object

Overrides:

[ Top ]


Class Methods

__construct

HKEY __construct( )

[line 311]

Class Constructor

Tags:

  • access - public

Overridden in child classes as:

HKEY_CLASSES_ROOT::__construct()
Class Constructor

Overrides VObject::__construct() (Class Constructor)

Parameters:

[ Top ]

Close

void Close( )

[line 65]

Close this key

Tags:

  • access - public

Parameters:

[ Top ]

createKey

object|false createKey( string $path)

[line 257]

Create a key

Tags:

  • return - Registry key on success or false on failure
  • access - public

Parameters:

  • string $path - Relative path of new key

[ Top ]

getKey

object|false getKey( string $path)

[line 136]

Get A Subkey

Tags:

  • return - Returns a registry key on success or false on failure
  • access - public

Parameters:

  • string $path - Relative Path to key

[ Top ]

getValue

Value getValue( integer $val_idx)

[line 104]

Get A value from this key

Tags:

  • return - on success or false if value index not found
  • access - public

Parameters:

  • integer $val_idx - Index

[ Top ]

listKeys

array listKeys( )

[line 187]

List Keys

Tags:

  • return - List of keys
  • access - public

Parameters:

[ Top ]

loadXML

void loadXML( string $src)

[line 79]

Initialize key from XML Source

Tags:

  • access - public

Parameters:

  • string $src - XML Source

[ Top ]

saveXML

boolean saveXML( )

[line 91]

Generate XML document from Root Key

Tags:

  • return - True on success
  • access - public

Parameters:

[ Top ]

setValue

true|false setValue( string $name, string $value, integer $type)

[line 215]

Set a value

Tags:

  • return - True on success or false on failure

Parameters:

  • string $name - Value identifier
  • string $value - Value
  • integer $type - Data type

[ Top ]


Class Constants


Documentation generated on Sun, 06 Mar 2011 02:22:06 -0600 by phpDocumentor 1.4.3