webapp/mapapp.php

Go to the documentation of this file.

<?php

define('MAPAPP_VERSION', 0.1);

require_once('mapmanager/mapmanager.php'); // we need the MapManager class definition
require_once('smartyapp.php');  //  we need the SmartyApp class definition

class MapApp extends SmartyApp
{
    var $map_manager;

    function MapApp(&$map_manager) 
        {
            $this->SmartyApp();
            $this->setMapManager($map_manager);

            // set default smarty directories
            $smarty =& $this->getSmarty();
            $web =& $map_manager->get('web');
            
            $imagepath = realpath($web->imagepath);
            if (substr($imagepath, -1) == DIRECTORY_SEPARATOR)
                $imagepath = substr($imagepath, 0, -1);
            
            $smarty->template_dir = $smarty->config_dir = $map_manager->get('shapepath');
            $smarty->compile_dir = $smarty->cache_dir = $imagepath;
        }

    function assign() 
        {
            $smarty =& $this->getSmarty();
            $control_box =& $this->getControlBox();
            $map_manager =& $this->getMapManager();

            // update the extent
            $mapext =& $control_box->get('mapext');
            $mapext->setValue(rectToString($map_manager->get('extent')));

            // determine refmap visibility
            $refmap =& $control_box->get('ref_map');
            $reference =& $map_manager->get('reference');
            if ($reference->status == MS_ON)
                $refmap->setDisplay(true);
            else
                $refmap->setDisplay(false);

            // determine layer choice visibility
            $layer_choice =& $control_box->get('layer_choice');
            if (sizeof($map_manager->getSelectableLayerNames()))
                $layer_choice->setDisplay(true);
            else
                $layer_choice->setDisplay(false);
            
            // assign the scale
            $smarty->assign('scale', $map_manager->get('scale'));

            // assign the legend
            $legend =& $map_manager->get('legend');
            if ($legend->status == MS_ON) {
                $imageObj = $map_manager->drawLegend();
                $smarty->assign('legend', $imageObj->saveWebImage());
            }

            // assign the scalebar
            $scalebar =& $map_manager->get('scalebar');
            if ($scalebar->status == MS_ON) {
                $imageObj = $map_manager->drawScaleBar();
                $smarty->assign('scalebar', $imageObj->saveWebImage());
            }
            
            parent::assign();
        }    
    
    // ACCESSOR METHODS
    
    function setMapManager(&$map_manager) 
        {
            $this->map_manager =& $map_manager;
        }

    function &getMapManager() 
        {
            return $this->map_manager;
        }

    function getTemplate() 
        {
            $map_manager =& $this->getMapManager();
            $web = $map_manager->get('web');

            return $web->template;
        }

    function setTemplate($template) 
        {
            $map_manager =& $this->getMapManager();
            $web =& $map_manager->get('web');
            $web->set('template', $template);
        }
    
    // INIT METHODS

    function initMapExt() 
        {
            $map_manager =& $this->getMapManager();
            $control_box =& $this->getControlBox();

            if (!$control_box->exists('mapext'))
                $mapext =& $control_box->addHidden('mapext', rectToString($map_manager->get('extent')));
            else
                $mapext =& $control_box->get('mapext');

            if (!$mapext->actionExists('set_extent'))
                $mapext->addAction(FC_EVENT_UPDATE, 'set_extent', array(&$this, 'doSetExtent'));            
        }

    function initMainMap() 
        {
            $control_box =& $this->getControlBox();

            if (!$control_box->exists('main_map'))
                $main_map =& $control_box->addImage('main_map');
            else
                $main_map =& $control_box->get('main_map');

            if (!$main_map->actionExists('define_click'))
                $main_map->addAction(FC_EVENT_CLICK, 'define_click', array(&$this, 'doDefineMapClick'));
        }

    function initRefMap() 
        {
            $control_box =& $this->getControlBox();

            if (!$control_box->exists('ref_map'))
                $ref_map =& $control_box->addImage('ref_map');
            else
                $ref_map =& $control_box->get('ref_map');

            if (!$ref_map->actionExists('define_click'))
                $ref_map->addAction(FC_EVENT_CLICK, 'define_click', array(&$this, 'doDefineRefMapClick'));

            if (!$ref_map->actionExists('zoom'))
                $ref_map->addAction(FC_EVENT_CLICK, 'zoom', array(&$this, 'doSetRefMapZoom'));            
        }

    function initZoomLevel() 
        {
            $control_box =& $this->getControlBox();

            if (!$control_box->exists('zoom_level')) {
                $zoom_level =& $control_box->addSingleSelect('zoom_level', array('zoom_high' => array('High', 5),
                                                                                 'zoom_medium' => array('Medium', 3),
                                                                                 'zoom_low' => array('Low', 2)));
                $zoom_level->select('zoom_high');
            } else {
                $zoom_level =& $control_box->get('zoom_level');
            }

            if (!$zoom_level->actionExists('zoom'))
                $zoom_level->addAction(FC_EVENT_UPDATE, 'zoom', array(&$this, 'doSetZoomLevel'));

            $zoom_level->triggerAction('zoom'); // seed the zoom level!
        }

    function initMapTools() 
        {
            $control_box =& $this->getControlBox();

            if (!$control_box->exists('map_tools'))
                $map_tools =& $control_box->addRadioChoice('map_tools', array('zoom_in' => array('Zoom in', 1),
                                                                              'zoom_out' => array('Zoom out', 2),
                                                                              'pan' => array('Pan', 3)));
            $this->initZoomIn();
            $this->initZoomOut();
            $this->initPan();

            $control =& $control_box->get('map_tools');
            $control->triggerActions();    // if anything has been selected, ensure the appropriate action is triggered
        }

    function initZoomIn() 
        {
            $control_box =& $this->getControlBox();
            
            $map_tools =& $control_box->get('map_tools');
            
            $zoom_in =& $map_tools->get('zoom_in');

            if (!$zoom_in->actionExists('zoom_on'))
                $zoom_in->addAction(FC_EVENT_SELECT, 'zoom_on', array(&$this, 'doSetZoomInOn'));
            if (!$zoom_in->actionExists('zoom_off'))
                $zoom_in->addAction(FC_EVENT_DESELECT, 'zoom_off', array(&$this, 'doSetZoomInOff'));
        }

    function initZoomOut() 
        {
            $control_box =& $this->getControlBox();

            $map_tools =& $control_box->get('map_tools');
            
            $zoom_out =& $map_tools->get('zoom_out');

            if (!$zoom_out->actionExists('zoom_on'))
                $zoom_out->addAction(FC_EVENT_SELECT, 'zoom_on', array(&$this, 'doSetZoomOutOn'));
            if (!$zoom_out->actionExists('zoom_off'))
                $zoom_out->addAction(FC_EVENT_DESELECT, 'zoom_off', array(&$this, 'doSetZoomOutOff'));

            $zoom_out->setDisabled(true);            
        }    
    
    function initPan() 
        {
            $control_box =& $this->getControlBox();

            $map_tools =& $control_box->get('map_tools');
            
            $pan =& $map_tools->get('pan');

            if (!$pan->actionExists('zoom_on'))
                $pan->addAction(FC_EVENT_SELECT, 'zoom_on', array(&$this, 'doSetZoomPanOn'));
            if (!$pan->actionExists('zoom_off'))
                $pan->addAction(FC_EVENT_DESELECT, 'zoom_off', array(&$this, 'doSetZoomPanOff'));

            $pan->setDisabled(true);
        }

    function initZoomAll() 
        {
            $control_box =& $this->getControlBox();

            if (!$control_box->exists('zoom_all'))
                $zoom_all =& $control_box->addSubmit('zoom_all', 'Zoom all');
            else
                $zoom_all =& $control_box->get('zoom_all');
            
            if (!$zoom_all->actionExists('zoom'))
                $zoom_all->addAction(FC_EVENT_CLICK, 'zoom', array(&$this, 'doSetZoomAll'));

            $zoom_all->setDisabled(true);
        }

    function initRefresh() 
        {
            $control_box =& $this->getControlBox();

            if (!$control_box->exists('refresh'))
                $control_box->addSubmit('refresh', 'Refresh');            
        }

    function initLayerChoice() 
        {
            $map_manager =& $this->getMapManager();
            $control_box =& $this->getControlBox();

            if (!$control_box->exists('layer_choice'))
                $layer_choice =& $control_box->addCheckboxChoice('layer_choice');
            else
                $layer_choice =& $control_box->get('layer_choice');

            if (!$layer_choice->actionExists('layer_choice'))
                $layer_choice->addAction(FC_EVENT_UPDATE, 'toggle_layers', array(&$this, 'doToggleAllLayersState'));

            $selectable_layers = $map_manager->getSelectableLayerNames();
            $layer_count = sizeof($selectable_layers);
            
            // set the selectable layers, in reverse order so base layers appear at the bottom of the list
            for ($i = $layer_count - 1; $i >= 0; $i--) 
                {
                    $layer_id = $selectable_layers[$i];
                    $layer = $map_manager->getLayerByName($layer_id);
                    $layer_name = $layer->getMetaData('LABEL');
                    if ($layer_name == '')
                        $layer_name = $layer_id;
                    
                    $control =& $layer_choice->addChoice($layer_id, $layer_name, ($layer->status != MS_OFF) ? true : false);
                    //$control->addAction(FC_EVENT_SELECT ^ FC_EVENT_DESELECT, 'toggle_layer', array(&$this, 'doToggleLayerState'));
                }            
        }
    
    function init() 
        {
            parent::init();
            
            $this->initMapExt();
            $this->initMainMap();
            $this->initZoomLevel();
            $this->initMapTools();
            /* this occurs inside initMapTools() now...
            $this->initZoomIn();
            $this->initZoomOut();
            $this->initPan();*/
            $this->initZoomAll();
            $this->initRefMap();
            $this->initRefresh();
            $this->initLayerChoice();
        }

    function updateZoomControls()
        {
            $map_manager =& $this->getMapManager();
            $control_box =& $this->getControlBox();
            
            $map_tools =& $control_box->get('map_tools');
            $zoom_in =& $map_tools->get('zoom_in');
            $zoom_out =& $map_tools->get('zoom_out');
            $pan =& $map_tools->get('pan');
            $zoom_all =& $control_box->get('zoom_all');

            if ($map_manager->zoomedToMinScale()) {
                $zoom_in->setDisabled(true);
            } else {
                $zoom_in->setDisabled(false);
            }

            if ($map_manager->zoomedToMaxExtent()) {
                $zoom_out->setDisabled(true);
                $pan->setDisabled(true);
                $zoom_all->setDisabled(true);
            } else {
                $pan->setDisabled(false);

                if ($map_manager->zoomedToMaxScale()) {
                    $zoom_out->setDisabled(true);
                    $zoom_all->setDisabled(true);
                } else {
                    $zoom_out->setDisabled(false);
                    $zoom_all->setDisabled(false);
                }
            }

            $zoom_type = $map_manager->getZoomType();

            if (!$zoom_in->disabled() and !$zoom_in->selected() and $zoom_type == MM_ZOOM_IN)
                $zoom_in->select();
            elseif ($zoom_in->selected() and $zoom_type != MM_ZOOM_IN)
                $zoom_in->deselect();

    
            if (!$zoom_out->disabled() and !$zoom_out->selected() and $zoom_type == MM_ZOOM_OUT)
                $zoom_out->select();
            elseif ($zoom_out->selected() and $zoom_type != MM_ZOOM_OUT)
                $zoom_out->deselect();

            if (!$pan->disabled() and !$pan->selected() and $zoom_type == MM_ZOOM_PAN)
                $pan->select();
            elseif ($pan->selected() and $zoom_type != MM_ZOOM_PAN)
                $pan->deselect();
        }

    
    // CALLBACK METHODS    

    function doSetExtent(&$control) 
        {
            $map_manager =& $this->getMapManager();
            $rect = stringToRect($control->getValue());
            $map_manager->setextent($rect->minx, $rect->miny, $rect->maxx, $rect->maxy);
        }

    function doToggleAllLayersState(&$control) 
        {
            $map_manager =& $this->getMapManager();
            $value = $control->getValue();

            if (is_array($value)) {    // it's a multiple select choice
                foreach($map_manager->getSelectableLayerNames() as $name) 
                    {
                        if (in_array($name, $value)) 
                            $map_manager->turnLayerOn($name, true);
                        else
                            $map_manager->turnLayerOff($name, true);
                    }
            } else {            // it's a single select choice
                foreach($map_manager->getSelectableLayerNames() as $name) 
                    {
                        $layer = $map_manager->getLayerByName($name);
                        
                        if ($name != $value)
                            $map_manager->turnLayerOff($name, true);
                        else
                            $map_manager->turnLayerOn($name, true);
                    }
            }
        }

    function doToggleLayerState(&$control) 
        {            
            $layer_name = $control->getValue();
            $map_manager =& $this->getMapManager();

            $layer = $map_manager->getLayerByName($layer_name);
            if ($control->selected())
                $layer->set('status', MS_ON);
            else
                $layer->set('status', MS_OFF);
        }
    
    function doSetZoomAll(&$control) 
        {
            $map_manager =& $this->getMapManager();
            $map_manager->setZoomType(MM_ZOOM_EXTENT);

            $map_manager->setZoomExtent($map_manager->getMaxExtent());
        }

    function doSetZoomLevel(&$control) 
        {
            $map_manager =& $this->getMapManager();
            $map_manager->setZoomLevel($control->getValue());
        }

    function doDefineMapClick(&$image_input) 
        {
            list($x, $y) = $image_input->getValue();
            $image_point = ms_newpointobj();
            $image_point->setXY($x, $y);

            $map_manager =& $this->getMapManager();
            $map_point = $map_manager->imagePointToMapPoint($image_point);
            
            $map_manager->setMapClick($map_point, MM_CLICK_MAIN);
        }

    function doDefineRefMapClick(&$image_input) 
        {
            list($x, $y) = $image_input->getValue();
            $image_point = ms_newpointobj();
            $image_point->setXY($x, $y);

            $map_manager =& $this->getMapManager();
            $map_point = $map_manager->imagePointToRefMapPoint($image_point);
            
            $map_manager->setMapClick($map_point, MM_CLICK_REF);
        }

    function doSetRefMapZoom(&$image_input) 
        {
            $map_manager =& $this->getMapManager();
            $map_manager->setZoomType(MM_ZOOM_PAN);
        }

    function doSetZoomPanOn(&$control) 
        {
            //print "Setting ZoomPan On<br/>\n";

            $map_manager =& $this->getMapManager();
            $map_manager->setZoomType(MM_ZOOM_PAN);
        }

    function doSetZoomPanOff(&$control)
        {
            //print "Setting ZoomPanOff<br/>\n";

            $map_manager =& $this->getMapManager();
            if ($map_manager->getZoomType() == MM_ZOOM_PAN)
                $map_manager->setZoomType(MM_ZOOM_NONE);
        }
    
    function doSetZoomInOn(&$control) 
        {
            //print "Setting ZoomIn On<br/>\n";

            $map_manager =& $this->getMapManager();
            $map_manager->setZoomType(MM_ZOOM_IN);
        }

    function doSetZoomInOff(&$control)
        {
            //print "Setting ZoomIn Off<br/>\n";

            $map_manager =& $this->getMapManager();
            if ($map_manager->getZoomType() == MM_ZOOM_IN)
                $map_manager->setZoomType(MM_ZOOM_NONE);
        }
    
    function doSetZoomOutOn(&$control)
        {
            //print "Setting ZoomOut On<br/>\n";

            $map_manager =& $this->getMapManager();
            $map_manager->setZoomType(MM_ZOOM_OUT);
        }

    function doSetZoomOutOff(&$control)
        {
            //print "Setting ZoomOut Off<br/>\n";

            $map_manager =& $this->getMapManager();
            if ($map_manager->getZoomType() == MM_ZOOM_OUT)
                $map_manager->setZoomType(MM_ZOOM_NONE);
        }

    
    // IMAGE RELATED METHODS

    function imageObjToImage(&$imageObj, &$image)
        {
            if (!is_a($image, 'ImageInput')) {
                $class = get_class($image);
                trigger_error("The control object must be an 'ImageInput'; id $image_id returned '$class'", E_USER_ERROR);
            }
            
            $url = $imageObj->saveWebImage();
            $image->setSrc($url);
        }
    
    function drawToImage(&$image)
        {
            $map_manager =& $this->getMapManager();
            $imageObj = $map_manager->draw();
            $this->imageObjToImage($imageObj, $image);
        }

    function drawReferenceMapToImage(&$image)
        {
            $map_manager =& $this->getMapManager();
            $imageObj = $map_manager->drawReferenceMap();
            $this->imageObjToImage($imageObj, $image);
        }

    // OUTPUT METHODS
    
    function draw($return = true)
        {            
            $control_box =& $this->getControlBox();
            $main_map =& $control_box->get('main_map');
        
            $this->drawToImage($main_map);

            if ($return)
                return $main_map->toString();
        }

    function drawReferenceMap($return = true) 
        {
            $control_box =& $this->getControlBox();
            $ref_map =& $control_box->get('ref_map');
        
            $this->drawReferenceMapToImage($ref_map);

            if ($return)
                return $ref_map->toString();            
        }

    /***************************************************
     * Version INTERFACE
     ***************************************************/

    function version() 
        {
            return MAPAPP_VERSION;
        }
    
    /***************************************************
     * Printable INTERFACE
     ***************************************************/
    
    function toString() 
        {
            $control_box =& $this->getControlBox();
            
            // update the main_map control if required
            $main_map =& $control_box->get('main_map');
            if ($main_map->display())
                $this->draw(false);
            
            // update the ref_map control if required
            $map_manager =& $this->getMapManager();
            $reference =& $map_manager->get('reference');
            
            if ($reference->status == MS_ON) {
                $ref_map =& $control_box->get('ref_map');
                if ($ref_map->display())
                    $this->drawReferenceMap(false);
            }
            
            return parent::toString();
        }
    
    /***************************************************
     * Serialisation INTERFACE
     ***************************************************/

    function __sleep() 
        {
            $sleep_vars = parent::__sleep();
            
            array_push($sleep_vars, 'map_manager');
            return $sleep_vars;
        }
}


?>

---