BMLT_Satellite_local Class Reference

This is the implementation of a standalone BMLT satellite server. More...

List of all members.

Public Member Functions
	call_curl ($in_uri, $in_post=true, &$http_status=null)
	This is a function that returns the results of an HTTP call to a URI. It is a lot more secure than file_get_contents, but does the same thing.
	Execute ($in_phase= 'csv', $in_http_vars=null)
	Performs the function necessary to provide the relevant content.
Static Public Member Functions
static	MakeBMLT ($is_csv=false, $in_http_vars=null)
	Functions.
Public Attributes
	$root_server_uri = ''
	All this stuff is dynamic stuff that applies directly to the instance.
	$http_vars = ''
	This is the combined GET and POST HTTP parameters.
	$params = ''
	This is a parameter list that is appended to URIs.
	$lang_enum = null
	Set this to a desired language (If null, the server decides -null is default).
Private Member Functions
	__construct ()
	Functions.
Static Private Attributes
static	$bmlt_instance = null
	This is static stuff that comprises the way the class is accessed.

---

Detailed Description

This is the implementation of a standalone BMLT satellite server.

It is meant to be instantiated in a simple PHP file, with a few calls to the BMLT_Satellite::Execute() function to deliver the XHTML to be displayed.

---

Constructor & Destructor Documentation

BMLT_Satellite_local::__construct

(

)

[private]

Functions.

We make the constructor private, so this class isn't instantiated on its own.

---

Member Function Documentation

BMLT_Satellite_local::call_curl	(	$	in_uri,
		$	in_post = true,
		&$	http_status = null
	)

This is a function that returns the results of an HTTP call to a URI. It is a lot more secure than file_get_contents, but does the same thing.

Returns:

a string, containing the response. Null if the call fails to get any data.

Parameters:

in_uri	A string. The URI to call.
in_post	If false, the transaction is a GET, not a POST. Default is true.
http_status	Optional reference to a string. Returns the HTTP call status.

Referenced by Execute().

BMLT_Satellite_local::Execute	(	$	in_phase = 'csv',
		$	in_http_vars = null
	)

Performs the function necessary to provide the relevant content.

This is the meat of this little class. It needs to be called in order to fetch the relevant data from the root server, and output it to the browser.

Returns:

a string, containing the XHTML to be displayed.

Parameters:

in_http_vars

These contain alternatives to the $_GET and/or $_POST parameters. Default is null.

static BMLT_Satellite_local::MakeBMLT	(	$	is_csv = false,
		$	in_http_vars = null
	)		[static]

Functions.

This is how clients will instantiate the BMLT. Either a new instance is created, or we get the current one.

Parameters:

is_csv	If true, then this object will be used for CSV data.
in_http_vars	These contain alternatives to the $_GET and/or $_POST parameters. Default is null.

Referenced by napdf::__construct().

---

Member Data Documentation

BMLT_Satellite_local::$bmlt_instance = null [static, private]

This is static stuff that comprises the way the class is accessed.

Data Members This will be the only instance of this class.

Referenced by MakeBMLT().

BMLT_Satellite_local::$http_vars = ''

This is the combined GET and POST HTTP parameters.

BMLT_Satellite_local::$lang_enum = null

Set this to a desired language (If null, the server decides -null is default).

BMLT_Satellite_local::$params = ''

This is a parameter list that is appended to URIs.

BMLT_Satellite_local::$root_server_uri = ''

All this stuff is dynamic stuff that applies directly to the instance.

Data members The root server URI, with the API entrypoint added.

---

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

• local_server/pdf_generator/BMLT_Satellite_local.class.php