UpdateAttributeStatus Class Reference

Collaboration diagram for UpdateAttributeStatus:

Public Member Functions
	__construct ($statusFile)
	getContent ()
	getStatus ()
	getCodeLines ($code)
	getLastMessage ()
	getError ()
	getResults ()
	isFinished ()

Data Fields
const	statusRunning = 1
const	StatusFinished = 2
const	statusUnknown = 3

Detailed Description

Format document list to be easily used in

$newValue=4;
$attrid='TST_ENUM';
$s = new \SearchDoc('', 'TST_UPDTATTR');
$s->setObjectReturn();
$s->setSlice(34);
$dl = new \DocumentList($s);
$ua = new \UpdateAttribute();
$ua->useCollection($dl);
$comment = "coucoux";
$ua->addHistoryComment($comment);
$ua->revise('REvX');
$statusFile= $ua->bgSetValue($attrid, $newValue);
$sua= new UpdateAttributeStatus($statusFile);
while (! $sua->isFinished()) {
print $sua->getStatus();
print ".";
sleep(1);
}

Definition at line 36 of file Class.UpdateAttributeStatus.php.

Constructor & Destructor Documentation

__construct

(

$statusFile

)

Definition at line 45 of file Class.UpdateAttributeStatus.php.

Member Function Documentation

getCodeLines

(

$code

)

get lines which match code

Parameters

string

$code

Returns

string[]

Definition at line 86 of file Class.UpdateAttributeStatus.php.

getContent

(

)

return file status content one line by array items

Returns

string[]

Definition at line 60 of file Class.UpdateAttributeStatus.php.

getError

(

)

return error messages empty string if not

Returns

string error messages

Definition at line 111 of file Class.UpdateAttributeStatus.php.

Here is the call graph for this function:

getLastMessage

(

)

get last message from file status

Returns

UpdateAttributeStatusLine

Definition at line 99 of file Class.UpdateAttributeStatus.php.

getResults

(

)

get all status for each documents return null is no processing doduments

Returns

null|UpdateAttributeResults[]

Definition at line 125 of file Class.UpdateAttributeStatus.php.

Here is the call graph for this function:

getStatus

(

)

return global status update file status content

Returns

int StatusFinished, StatusRunning or statusUnknown

Definition at line 70 of file Class.UpdateAttributeStatus.php.

isFinished

(

)

return true is status file contains message that indicates end of processing

Returns

bool

Definition at line 139 of file Class.UpdateAttributeStatus.php.

Here is the call graph for this function:

Field Documentation

const StatusFinished = 2

Definition at line 42 of file Class.UpdateAttributeStatus.php.

const statusRunning = 1

Definition at line 41 of file Class.UpdateAttributeStatus.php.

const statusUnknown = 3

Definition at line 43 of file Class.UpdateAttributeStatus.php.

---

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

• Class.UpdateAttributeStatus.php