Client
[ class tree: Client ] [ index: Client ] [ all elements ]

Class: ClientExportRtf

Source Location: /plugins/exportRtf/client/ClientExportRtf.php

Class Overview

PluginBase
   |
   --ClientPlugin
      |
      --ExportPlugin
         |
         --ClientExportRtf

Overall class for generating RTF


Variables

Methods


Inherited Constants

Inherited Variables

Inherited Methods

Class: ExportPlugin

ExportPlugin::getExport()
Renders export
ExportPlugin::getExportResult()
Retrieves MapResult
ExportPlugin::getExportUrl()
Returns base export plugin URL.
ExportPlugin::getLastMapRequest()
Returns session-saved last MapRequest.
ExportPlugin::getLastMapResult()
Returns session-saved last MapResult.
ExportPlugin::output()
Outputs exported content.

Class: ClientPlugin

ClientPlugin::__construct()
Constructor
ClientPlugin::checkBool()
Checks if variable $variable has a boolean (0 or 1) value $value.
ClientPlugin::checkInt()
Checks if variable $variable has an integer positive or zero value $value.
ClientPlugin::checkNumeric()
Checks if variable $variable has a numeric value $value.
ClientPlugin::disable()
Sets the enable level to ClientPlugin::ENABLE_LEVEL_SERVERCALL.
ClientPlugin::enable()
Sets the enable level to ClientPlugin::ENABLE_LEVEL_FULL.
ClientPlugin::getCartoclient()
ClientPlugin::getConfig()
ClientPlugin::getEnabledLevel()
Returns the enable level.
ClientPlugin::getFolderId()
get folder id if set in plugin config
ClientPlugin::getHttpValue()
Returns the user-submitted $key data if it is set.
ClientPlugin::initializeConfig()
Initializes plugin configuration
ClientPlugin::isEnabledAtLevel()
Sets the enable level to ClientPlugin::ENABLE_LEVEL_FULL.
ClientPlugin::setEnableLevel()
Sets the enable level (to be used with the AJAX mode).

Class: PluginBase

PluginBase::__construct()
Constructor
PluginBase::account()
Records an accounting message for plugins
PluginBase::getBasePath()
PluginBase::getExtendedName()
PluginBase::getName()
PluginBase::getRequest()
Get plugin's request or result out of MapRequest or MapResult
PluginBase::initialize()
Plugin initialization (can be extended in custom plugins)
PluginBase::initializeConfig()
Initializes plugin
PluginBase::preInitialize()
Plugin pre initialization. In most cases, plugins should use
PluginBase::replacePlugin()
Returns name of parent plugin in case of plugin extension
PluginBase::setBasePath()
PluginBase::setExtendedName()
PluginBase::setName()

Class Details

[line 29]
Overall class for generating RTF



[ Top ]


Class Variables

$addedInputs = array()

[line 49]



Tags:

var:  received inputs
access:  protected

Type:   array


[ Top ]

$addedValues = array()

[line 45]



Tags:

var:  optional values set in the config file
access:  protected

Type:   array


[ Top ]

$exportRtfFormState = array()

[line 41]



Tags:

var:  state that comes from posted form
access:  protected

Type:   array


[ Top ]

$optionalInputs = array('title', 'scalebar', 'overview', 'queryResult')

[line 37]



Tags:

var:  activated block in the form.tpl
access:  protected

Type:   array


[ Top ]

$rtf =

[line 33]



Tags:

var:  the output RTF
access:  private

Type:   string


[ Top ]



Class Methods


constructor __construct [line 54]

ClientExportRtf __construct( )

Constructor



Tags:

access:  public


Overrides ClientPlugin::__construct() (Constructor)

[ Top ]

method convert_to_rtf_image [line 341]

string convert_to_rtf_image( mixed $img_path, mixed $imgType)

Returns an hexadecimal representation of an image



Tags:

return:  An hexadecimal representation of an image
access:  public


[ Top ]

method drawUserForm [line 167]

string drawUserForm( )

Returns a String of the user form that will be injected in the cartoclient.tpl



Tags:

return:  The user form that will be injected in the cartoclient.tpl
access:  protected


[ Top ]

method fetchRtfImage [line 290]

string fetchRtfImage( mixed $image_path)

Returns an RTF string containing an RTF compatible image

GIF is not supported for Open Office




Tags:

return:  An RTF string containing the query result in form of tables
access:  protected


[ Top ]

method fetchRtfQueryResult [line 247]

string fetchRtfQueryResult( )

Returns an RTF string containing the query result in form of tables



Tags:

return:  An RTF string containing the query result in form of tables
access:  protected


[ Top ]

method getConfiguration [line 127]

ExportConfiguration getConfiguration( )

Builds export configuration.



Tags:

access:  public


[ Top ]

method getExport [line 91]

String getExport( )



Tags:

return:  exported rtf string
access:  protected
see:  ExportPlugin::getExport


Overrides ExportPlugin::getExport() (Renders export)

[ Top ]

method getGfxPath [line 331]

string getGfxPath( string $gfx)

Returns the absolute URL of $gfx, using the ResourceHandler



Tags:

access:  protected


Parameters:

string   $gfx  

[ Top ]

method getLastBbox [line 355]

Bbox getLastBbox( )



Tags:

return:  bbox from last session-saved MapResult.
access:  protected


[ Top ]

method getLastMapImage [line 368]

void getLastMapImage( )

function kept for future developments



Tags:

access:  protected


[ Top ]

method handleHttpGetRequest [line 82]

void handleHttpGetRequest( mixed $request)



Tags:

access:  public
see:  GuiProvider::handleHttpGetRequest()


[ Top ]

method handleHttpPostRequest [line 61]

void handleHttpPostRequest( mixed $request)



Tags:

access:  public


[ Top ]

method output [line 106]

void output( )



Tags:

access:  public
see:  ExportPlugin::output()


Overrides ExportPlugin::output() (Outputs exported content.)

[ Top ]

method renderForm [line 159]

void renderForm( Smarty $template)



Tags:

access:  public
see:  GuiProvider::renderForm()


[ Top ]

method render_rtf [line 200]

string render_rtf( )

Returns an RTF string containing the map and other choosen data



Tags:

return:  An RTF string containing the map and other choosen data
access:  protected


[ Top ]


Documentation generated on Mon, 09 Sep 2013 13:30:35 +0200 by phpDocumentor 1.3.0RC3