4.12. OutputFormatObj Class

Next: OwsRequestObj Class Previous: MapObj Class  

• Constant names and class member variable names are case-sensitive in PHP.
• Several MapScript functions (all those that access files in the back end such as ms_newMapObj(), drawMap(), etc.) will affect the value of the current working directory (CWD) in the PHP environment. This will be fixed eventually but in the meantime you should be careful about these side-effects.

Constructor :

 Instance of outputformatObj is always embedded inside the mapObj.
 It is uses a read only.

 No constructor available (coming soon, see bug 979)


Members:

  string    name
  string    mimetype
  string    driver
  string    extension
  int       renderer
  int       imagemode     // MS_IMAGEMODE_* value.
  int       transparent
       
 Methods related to the output format :

  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.

       Example: $oMap->outputformat->setOption("OUTPUT_TYPE", "RASTER");
    
  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.

  void setFormatOption(string property_name, string new_value)
       Deprecated. See setOption().

  string  getFormatOption(string property_name)
       Deprecated. See getOption().

Next: OwsRequestObj Class Previous: MapObj Class