DataAction Class Reference

List of all members.

Public Member Functions

 __construct ($status, $id, $data, $master=false)
 assign_logger ($logger)
 log ($a, $b="")
 add_field ($name, $value)
 remove_field ($name)
 sync_config ($slave)
 get_value ($name)
 set_value ($name, $value)
 get_data ()
 get_userdata_value ($name)
 set_userdata_value ($name, $value)
 get_status ()
 set_status ($status)
 get_id ()
 set_response_text ($text)
 set_response_xml ($text)
 set_response_attribute ($name, $value)
 is_ready ()
 get_new_id ()
 master_id ()
 error ()
 invalid ()
 success ($id=false)
 to_xml ()
 __toString ()

Private Attributes

 $status
 cuurent status of record
 $id
 id of record
 $data
 data hash of record
 $userdata
 hash of extra data , attached to record
 $nid
 new id value , after operation executed
 $output
 custom output to client side code
 $attrs
 hash of custtom attributes
 $ready
 flag of operation's execution
 $master
 master DataActon object
 $addf
 array of added fields
 $delf
 array of deleted fields
 $logger
 LogMaster object.


Detailed Description

contain all info related to action and controls customizaton

Constructor & Destructor Documentation

__construct ( status,
id,
data,
master = false 
)

constructor

Parameters:
status current operation status
id record id
data hash of data
master master DataAction object


Member Function Documentation

__toString (  ) 

convert self to string ( for logs )

Returns:
DataAction operation report as plain string

add_field ( name,
value 
)

add custom field and value to DB operation

Parameters:
name name of field which will be added to DB operation
value value which will be used for related field in DB operation

assign_logger ( logger  ) 

assign log master object

Has not any default usage except of debug purposes

Parameters:
logger LogMaster object
Returns:
description of return value

error (  ) 

set result of operation as error

get_data (  ) 

get hash of data properties

Returns:
hash of data properties

get_id (  ) 

get id of current record

Returns:
id of record

get_new_id (  ) 

return new id value

equal to original ID normally, after insert operation - value assigned for new DB record

Returns:
new id value

get_status (  ) 

get current status of record

Returns:
string with status value

get_userdata_value ( name  ) 

get some extra info attached to record

Currently client side code encode all item related and global userdata so it can be accessed by this method.

Parameters:
name name of userdata property
Returns:
value of related userdata property

get_value ( name  ) 

get value of some record's propery

Parameters:
name name of record's property ( name of db field or alias )
Returns:
value of related property

invalid (  ) 

set result of operation as invalid

is_ready (  ) 

check if action finished

Returns:
true if action finished, false otherwise

log ( a,
b = "" 
)

log a record , if LogMaster was assigned

Parameters:
a string which will be logged
b data which will be added to log record, optional

master_id (  ) 

return id of master record

Doens't have sense if record has not related master record

Returns:
id of master record

remove_field ( name  ) 

remove field from DB operation

Parameters:
name name of field which will be removed from DB operation

set_response_attribute ( name,
value 
)

sets custom response attributes

can be accessed through defineAction on client side

Parameters:
name name of custom attribute
value value of custom attribute

set_response_text ( text  ) 

sets custom response text

can be accessed through defineAction on client side. Text wrapped in CDATA, so no extra escaping necessary

Parameters:
text custom response text

set_response_xml ( text  ) 

sets custom response xml

can be accessed through defineAction on client side

Parameters:
text string with XML data

set_status ( status  ) 

assign new status to the record

Parameters:
status new status value

set_userdata_value ( name,
value 
)

set some extra info attached to record

Parameters:
name name of userdata property
value value of userdata property

set_value ( name,
value 
)

set value of some record's propery

Parameters:
name name of record's property ( name of db field or alias )
value value of related property

success ( id = false  ) 

confirm successful opeation execution

Parameters:
id new id value, optional

sync_config ( slave  ) 

sync field configuration with external object

Parameters:
slave SQLMaster object
Todo:
check , if all fields removed then cancel action

to_xml (  ) 

convert DataAction to xml format compatible with client side dataProcessor

Returns:
DataAction operation report as XML string


Member Data Documentation

$addf [private]

array of added fields

$attrs [private]

hash of custtom attributes

$data [private]

data hash of record

$delf [private]

array of deleted fields

$id [private]

id of record

$logger [private]

LogMaster object.

$master [private]

master DataActon object

$nid [private]

new id value , after operation executed

$output [private]

custom output to client side code

$ready [private]

flag of operation's execution

$status [private]

cuurent status of record

$userdata [private]

hash of extra data , attached to record


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

Generated on Tue Mar 3 20:06:24 2009 for dhxmlXConnector by  doxygen 1.5.8