Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: ../general-devel/lib/support/external/pipe/externalpipe.class.php
phpGeneral - support

ExternalPipe

External
   |
  +-- ExternalPipe

Send data through a pipe to an external programm

 

public class ExternalPipe extends External

Send data through a pipe to an external programm
Writes the text representation of the desired operation, the credentials andall attribute/value pairs in a defined format to another program connected bya pipe.

AuthorsNorbert Sendetzky <norbert@linuxnetworks.de>

 

Methods inherited from External

external

Public Method Summary

object ExternalPipe

ExternalPipe(array $param, string &$errmsg)

Class constructor
boolean

output(string $operation, array $attributes, string $type, string &$errmsg)

Send data to the external program

Private Field Summary

string

$progname

integer

$pipe

integer

$param

Included files inherited from External

../lib/include/locale.class.php

Included files Summary, Type: include_once

../lib/support/external/external.class.php Warning: documentation is missing.

Public Method Details

ExternalPipe

public object ExternalPipe ExternalPipe( array $param, string &$errmsg )

  Class constructor
Initializes member variables and sets up the base class

Parameter
array $param
Associative array contains userid, password, realm and module specific parameters
string &$errmsg
Reference for storing error messages in case of a failure
Returns object ExternalPipe


output

public boolean output( string $operation, array $attributes, string $type, string &$errmsg )

  Send data to the external program
Opens a pipe to the specified program, sends operation, credentials(userid and password) and all attribute/value pairs to this programm andcloses the pipe after the execution of the external program is complete.

Parameter
string $operation
Desired operation like add, delete or modify
array $attributes
Associative array of attribute/value pairs
string $type
type of the sent object like node, user, group or device
string &$errmsg
Reference for storing error messages in case of a failure
Returns boolean

TRUE on success, otherwise FALSE


Private Field Details

$progname

private string $progname

>>""<<



$pipe

private integer $pipe

>><<



$param

private integer $param

>><<



Included Files, Type: include_once

../lib/support/external/external.class.php

include_once( ../lib/support/external/external.class.php )




Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta