outputformatObj

final class outputformatObj (View source)

Instance of outputformatObj is always embedded inside the mapObj_.

It is uses a read only. No constructor available (coming soon, see ticket 979)

Properties

string $driver
string $extension
int $imagemode

MSIMAGEMODE* value.
string $mimetype
string $name
int $renderer
int $transparent

Methods

string
getOption(string $property_name)

Returns the associated value for the format option property passed as argument. Returns an empty string if property not found.

int
set(string $property_name, $new_value)

Set object property to a new value.

void
setOption(string $property_name, string $new_value)

Add or Modify the format option list. return true on success.

int
validate()

Checks some internal consistency issues, Returns MS_SUCCESS or MS_FAILURE. Some problems are fixed up internally. May produce debug output if issues encountered.

Details

at line 3262
final string getOption(string $property_name)

Returns the associated value for the format option property passed as argument. Returns an empty string if property not found.

Parameters

string $property_name

Return Value

string

at line 3271
final int set(string $property_name, $new_value)

Set object property to a new value.

Parameters

string $property_name
$new_value

Return Value

int

at line 3282
final void setOption(string $property_name, string $new_value)

Add or Modify the format option list. return true on success.

.. code-block:: php $oMap->outputformat->setOption("OUTPUT_TYPE", "RASTER");

Parameters

string $property_name
string $new_value

Return Value

void

at line 3291
final int validate()

Checks some internal consistency issues, Returns MS_SUCCESS or MS_FAILURE. Some problems are fixed up internally. May produce debug output if issues encountered.

Return Value

int