StorageNode Class Reference

Inheritance diagram for StorageNode:

Collaboration diagram for StorageNode:

Public Member Functions
	get ($key='')
	getStorageGroup ()
	loadOnline ()
	getNodeFailure ($Host)
	getLogfiles ()
	getSnapinfiles ()
	getImages ()
	getClientLoad ()
	getUsedSlotCount ()
	getQueuedSlotCount ()
Public Member Functions inherited from FOGController
	__construct ($data='')
	__destruct ()
	__toString ()
	set ($key, $value)
	add ($key, $value)
	remove ($key, $value)
	save ()
	load ($key='id')
	getcolumns (&$fields)
	destroy ($key='id')
	key (&$key)
	isValid ()
	buildQuery (&$join, &$whereArrayAnd, &$c, $not=false, $compare='=')
	setQuery (&$queryData)
	getManager ()
	assocSetter ($assocItem, $alterItem='', $implicitCall=false)
Public Member Functions inherited from FOGBase
	__construct ()
	orderBy (&$orderBy)

Protected Member Functions
	loadUsedtasks ()
Protected Member Functions inherited from FOGController
	loadItem ($key)
	addRemItem ($key, $array, $array_type)
Protected Member Functions inherited from FOGBase
	isLoaded ($key)
	setRequest ()
	sendData ( $datatosend, $service=true, $array=array())

Protected Attributes
	$databaseTable = 'nfsGroupMembers'
	$databaseFields
	$databaseFieldsRequired
	$additionalFields
	$databaseFieldClassRelationships
Protected Attributes inherited from FOGController
	$data = array()
	$autoSave = false
	$databaseTable = ''
	$databaseFields = array()
	$databaseFieldsRequired = array()
	$additionalFields = array()
	$databaseFieldsFlipped = array()
	$databaseFieldsToIgnore
	$aliasedFields = array()
	$databaseFieldClassRelationships = array()
	$loadQueryTemplate = 'SELECT %s FROM `%s` %s WHERE `%s`=%s %s'
	$insertQueryTemplate = 'INSERT INTO `%s` (%s) VALUES (%s) %s %s'
	$destroyQueryTemplate = 'DELETE FROM `%s` WHERE %s=%s%s'
Protected Attributes inherited from FOGBase
	$isLoaded = array()

Private Member Functions
	_getData ($item)

Additional Inherited Members
Static Public Member Functions inherited from FOGBase
static	getClass ($class, $data='', $props=false)
static	getHostItem ( $service=true, $encoded=false, $hostnotrequired=false, $returnmacs=false, $override=false, $mac=false)
static	getAllBlamedNodes ($Host)
static	niceDate ($date='now', $utc=false)
static	formatTime ($time, $format=false, $utc=false)
static	createSecToken ()
static	aesencrypt ( $data, $key=false, $enctype='aes-256-cbc')
static	aesdecrypt ( $encdata, $key=false, $enctype='aes-128-cbc')
static	parseMacList ( $stringlist, $image=false, $client=false)
static	getSubObjectIDs ( $object='Host', $findWhere=array(), $getField='id', $not=false, $operator='AND', $orderBy='name', $groupBy=false, $filter='array_unique')
static	getSetting ($key)
static	setSetting ($key, $value)
static	getQueuedStates ()
static	getQueuedState ()
static	getCheckedInState ()
static	getProgressState ()
static	getCompleteState ()
static	getCancelledState ()
static	stringBetween ($string, $start, $end)
static	stripAndDecode (&$item)
static	getMasterInterface ($ip_find)
static	lasterror ()
static	getFilesize ($path)
static	wakeUp ($macs)
static	fastmerge ($array1)
static	getHash ($file)
static	attemptLogin ($username, $password)
static	clearMACLookupTable ()
static	getMACLookupCount ()
static	resolveHostname ($host)
static	getBroadcast ()
static	randWait ()
Static Public Attributes inherited from FOGBase
static	$locale = ''
static	$fogpingactive = false
static	$fogdeleteactive = false
static	$fogexportactive = false
static	$pendingMACs = 0
static	$pendingHosts = 0
static	$defaultscreen = ''
static	$pluginsinstalled = array()
static	$useragent
static	$foglang
static	$ajax = false
static	$post = false
static	$service = false
static	$json = false
static	$newService = false
static	$scriptname
static	$querystring
static	$httpreqwith
static	$reqmethod
static	$remoteaddr
static	$httpreferer
static	$mySchema = 0
static	$showhtml = true
static	$httpproto = false
static	$httphost = ''
static	$Host = null
Static Protected Member Functions inherited from FOGBase
static	getActivePlugins ()
static	fatalError ($txt, $data=array())
static	error ($txt, $data=array())
static	debug ($txt, $data=array())
static	info ($txt, $data=array())
static	setMessage ($txt, $data=array())
static	getMessages ()
static	redirect ($url='')
static	arrayInsertBefore ( $key, array &$array, $new_key, $new_value)
static	arrayInsertAfter ( $key, array &$array, $new_key, $new_value)
static	arrayRemove ($key, array &$array)
static	arrayFind ( $needle, array $haystack, $ignorecase=false)
static	resetRequest ()
static	formatByteSize ($size)
static	getGlobalModuleStatus ($names=false, $keys=false)
static	validDate ($date, $format='')
static	pluralize ($count, $text, $space=false)
static	diff ($start, $end, $ago=false)
static	humanify ($diff, $unit)
static	arrayChangeKey (array &$array, $old_key, $new_key)
static	byteconvert ($kilobytes)
static	hex2bin ($hex)
static	certEncrypt ($data)
static	certDecrypt ($dataArr, $padding=true)
static	arrayStrpos ($haystack, $needles, $case=true)
static	log ( $txt, $curlog, $logfile, $logbrow, $obj, $level=1)
static	logHistory ($string)
static	getIPAddress ($force=false)
Static Protected Attributes inherited from FOGBase
static	$strlen
static	$debug = false
static	$info = false
static	$buildSelectBox
static	$selected
static	$DB
static	$FOGFTP
static	$FOGCore
static	$EventManager
static	$HookManager
static	$TimeZone
static	$FOGUser
static	$FOGPageManager
static	$FOGURLRequests
static	$FOGSubMenu
static	$ips = array()
static	$interface = array()
static	$searchPages

Detailed Description

Definition at line 22 of file storagenode.class.php.

Member Function Documentation

_getData()

StorageNode::_getData (   $item )

private

Get's the storage node snapins, logfiles, and images in a single multi call rather than three individual calls.

Returns

array

Definition at line 202 of file storagenode.class.php.

References $items, $response, and $url.

Referenced by getImages(), getLogfiles(), and getSnapinfiles().

get()

StorageNode::get

(

$key = ''

)

Gets an item from the key sent, if no key all object data is returned.

Parameters

mixed

$key

the key to get

Returns

object

Reimplemented from FOGController.

Definition at line 102 of file storagenode.class.php.

References FOGBase\isLoaded().

Referenced by TaskQueue\_email(), TaskQueue\_moveUpload(), and TaskQueue\checkIn().

getClientLoad()

StorageNode::getClientLoad

(

)

Gets this node's load of clients.

Returns

float

Definition at line 269 of file storagenode.class.php.

References getQueuedSlotCount(), and getUsedSlotCount().

getImages()

StorageNode::getImages

(

)

Loads the images available on this node.

Returns

void

Definition at line 254 of file storagenode.class.php.

References $response, _getData(), and FOGBase\getSubObjectIDs().

getLogfiles()

StorageNode::getLogfiles

(

)

Loads the logfiles available on this node.

Returns

void

Definition at line 186 of file storagenode.class.php.

References $paths, and _getData().

getNodeFailure()

StorageNode::getNodeFailure

(

$Host

)

Get the node failure.

Parameters

int

$Host

the host id

Returns

object

Definition at line 160 of file storagenode.class.php.

References FOGBase\$Host, and FOGBase\niceDate().

getQueuedSlotCount()

StorageNode::getQueuedSlotCount

(

)

Gets the queued hosts on this node.

Returns

int

Definition at line 333 of file storagenode.class.php.

References FOGBase\getClass(), and FOGBase\getSubObjectIDs().

Referenced by getClientLoad().

getSnapinfiles()

StorageNode::getSnapinfiles

(

)

Loads the snapins available on this node.

Returns

void

Definition at line 243 of file storagenode.class.php.

References $response, and _getData().

getStorageGroup()

StorageNode::getStorageGroup

(

)

Get the storage group of this node.

Returns

object

Definition at line 139 of file storagenode.class.php.

getUsedSlotCount()

StorageNode::getUsedSlotCount

(

)

Gets this node's used count.

Returns

int

Definition at line 303 of file storagenode.class.php.

References FOGBase\getClass(), and FOGBase\getSubObjectIDs().

Referenced by TaskQueue\checkIn(), and getClientLoad().

loadOnline()

StorageNode::loadOnline

(

)

Loads the online status for us.

Returns

void

Definition at line 148 of file storagenode.class.php.

References $test.

loadUsedtasks()

StorageNode::loadUsedtasks ( )

protected

Load used tasks.

Returns

void

Definition at line 286 of file storagenode.class.php.

Member Data Documentation

$additionalFields

StorageNode::$additionalFields

protected

Initial value:

= array(
        'images',
        'snapinfiles',
        'logfiles',
        'usedtasks',
        'storagegroup',
        'online'
    )

Definition at line 75 of file storagenode.class.php.

$databaseFieldClassRelationships

StorageNode::$databaseFieldClassRelationships

protected

Initial value:

= array(
        'StorageGroup' => array(
            'id',
            'storagegroupID',
            'storagegroup'
        )
    )

Definition at line 88 of file storagenode.class.php.

$databaseFields

StorageNode::$databaseFields

protected

Initial value:

= array(
        'id' => 'ngmID',
        'name' => 'ngmMemberName',
        'description' => 'ngmMemberDescription',
        'isMaster' => 'ngmIsMasterNode',
        'storagegroupID' => 'ngmGroupID',
        'isEnabled' => 'ngmIsEnabled',
        'isGraphEnabled' => 'ngmGraphEnabled',
        'path' => 'ngmRootPath',
        'ftppath' => 'ngmFTPPath',
        'bitrate' => 'ngmMaxBitrate',
        'helloInterval' => 'ngmHelloInterval',
        'snapinpath' => 'ngmSnapinPath',
        'sslpath' => 'ngmSSLPath',
        'ip' => 'ngmHostname',
        'maxClients' => 'ngmMaxClients',
        'user' => 'ngmUser',
        'pass' => 'ngmPass',
        'key' => 'ngmKey',
        'interface' => 'ngmInterface',
        'bandwidth' => 'ngmBandwidthLimit',
        'webroot' => 'ngmWebroot'
    )

Definition at line 35 of file storagenode.class.php.

$databaseFieldsRequired

StorageNode::$databaseFieldsRequired

protected

Initial value:

= array(
        'ip',
        'path',
        'ftppath',
        'user',
        'pass'
    )

Definition at line 63 of file storagenode.class.php.

$databaseTable

StorageNode::$databaseTable = 'nfsGroupMembers'

protected

Definition at line 29 of file storagenode.class.php.

---

The documentation for this class was generated from the following file:

• packages/web/lib/fog/storagenode.class.php