vendor/numero2/contao-storelocator/src/Resources/contao/classes/StoreLocator.php line 113

Open in your IDE?
  1. <?php
  3. /**
  4.  * StoreLocator Bundle for Contao Open Source CMS
  5.  *
  6.  * @author    Benny Born <benny.born@numero2.de>
  7.  * @author    Michael Bösherz <michael.boesherz@numero2.de>
  8.  * @license   LGPL-3.0-or-later
  9.  * @copyright Copyright (c) 2024, numero2 - Agentur für digitales Marketing GbR
  10.  */
  13. namespace numero2\StoreLocator;
  15. use Contao\Config;
  16. use Contao\Controller;
  17. use Contao\FrontendTemplate;
  18. use Contao\Input;
  19. use Contao\Module;
  20. use Contao\PageModel;
  21. use Contao\StringUtil;
  22. use Contao\System;
  23. use Contao\Validator;
  24. use Geocoder\Query\GeocodeQuery;
  25. use numero2\StoreLocator\DCAHelper\Stores;
  28. class StoreLocator {
  31.     /**
  32.      * Replace matching Insert Tags
  33.      *
  34.      * @param string $strBuffer
  35.      * @param bool $blnCache
  36.      *
  37.      * @return string|boolean
  38.      */
  39.     public function replaceInsertTags( $strBuffer, $blnCache=false ) {
  41.         Controller::loadDataContainer(StoresModel::getTable());
  43.         $aParams = [];
  44.         $aParams = explode('::', $strBuffer);
  46.         switch( $aParams[0] ) {
  48.             case 'store' :
  50.                 $aDCAFields = [];
  51.                 $aDCAFields = array_keys($GLOBALS['TL_DCA'][StoresModel::getTable()]['fields']);
  53.                 // get data from current store
  54.                 if( !empty($aParams[1]) && in_array($aParams[1], $aDCAFields) ) {
  56.                     $alias = null;
  57.                     $alias = Input::get('auto_item') ? Input::get('auto_item') : Input::get('store');
  59.                     // find store
  60.                     $objStore = null;
  61.                     $objStore = StoresModel::findByIdOrAlias($alias);
  63.                     if( !$objStore ) {
  64.                         return false;
  65.                     }
  67.                     self::parseStoreData($objStore);
  69.                     return $objStore->{$aParams[1]};
  71.                 // get specific store
  72.                 } else {
  74.                     $oTemplate = new FrontendTemplate('mod_storelocator_inserttag');
  76.                     // find store
  77.                     $objStore = null;
  78.                     $objStore = StoresModel::findByIdOrAlias($aParams[1]);
  80.                     if( !$objStore ) {
  81.                         return false;
  82.                     }
  84.                     self::parseStoreData($objStore);
  86.                     $oTemplate->store = $objStore;
  88.                     $sTemplate = $oTemplate->parse();
  89.                     $sTemplate = Controller::replaceInsertTags($sTemplate);
  91.                     return $sTemplate;
  92.                 }
  94.                 break;
  96.             // not our insert tag?
  97.             default :
  98.                 return false;
  99.                 break;
  100.         }
  102.         return false;
  103.     }
  106.     /**
  107.      * Parses the given store so we can use it directly to
  108.      * display the details template
  109.      *
  110.      * @param numero2\StoreLocator\StoresModel $store
  111.      * @param Contao\Module $module
  112.      */
  113.     public static function parseStoreData( StoresModel $store, ?Module $module=null ): void {
  115.         $store->name = StringUtil::restoreBasicEntities($store->name);
  116.         $store->description = StringUtil::restoreBasicEntities($store->description);
  118.         // validate latitude and longitude
  119.         if( !Validator::isNumeric($store->latitude) || !Validator::isNumeric($store->longitude) ) {
  121.             $store->latitude = '';
  122.             $store->longitude = '';
  124.             System::getContainer()->get('monolog.logger.contao.error')->error('Error parsing geocords ('. $store->latitude .','. $store->longitude .') for store ID '.$store->id);
  125.         }
  127.         $store->latitude = floatval($store->latitude);
  128.         $store->longitude = floatval($store->longitude);
  130.         if( $store->latitude < -90 || $store->latitude > 90 || $store->longitude < -180 || $store->longitude > 180 ) {
  132.             $store->latitude = '';
  133.             $store->longitude = '';
  135.             System::getContainer()->get('monolog.logger.contao.error')->error('Error parsing geocords not in range ('. $store->latitude .','. $store->longitude .') for store ID '.$store->id);
  136.         }
  138.         // get opening times
  139.         $aTimes = StringUtil::deserialize( $store->opening_times );
  140.         $aTimes = !empty($aTimes[0]['from']) ? $aTimes : null;
  142.         if( !empty($aTimes) ) {
  144.             $aWeekdays = [];
  145.             $aWeekdays = StoreLocator::getWeekdays();
  147.             foreach( $aTimes as $i => $day ) {
  148.                 $aTimes[$i]['label'] = $aWeekdays[ $day['weekday'] ];
  149.             }
  150.         }
  152.         $store->opening_times = $aTimes;
  154.         // set country name
  155.         $aCountryNames = [];
  156.         $aCountryNames = Stores::getCountries();
  158.         $store->country_code = $store->country;
  159.         $store->country_name = $aCountryNames[ $store->country ];
  161.         // create a clickable link for telephone number
  162.         if( !empty($store->phone) ) {
  163.             $store->phoneLink = 'tel:'.preg_replace("|[^\+0-9]|", "", $store->phone);
  164.         }
  166.         // create a clickable link for fax number
  167.         if( !empty($store->fax) ) {
  168.             $store->faxLink = 'fax:'.preg_replace("|[^\+0-9]|", "", $store->fax);
  169.         }
  171.         // create a "pretty" url
  172.         if( !empty($store->url) ) {
  174.             $aURL = [];
  175.             $aURL = parse_url($store->url);
  177.             if( !empty($aURL['host']) ) {
  178.                 $store->prettyUrl = $aURL['host'];
  179.             }
  180.         }
  182.         // add link to details
  183.         if( $module && $module->jumpTo ) {
  185.             $objLink = null;
  186.             $objLink = PageModel::findById($module->jumpTo);
  188.             if( $objLink ) {
  189.                 $store->link = $objLink->getFrontendUrl((!Config::get('useAutoItem')?'/store/':'/').($store->alias?$store->alias:$store->id));
  190.             }
  191.         }
  193.         // HOOK: add custom logic to parse the store details
  194.         if( isset($GLOBALS['N2SL_HOOKS']['parseStoreData']) && is_array($GLOBALS['N2SL_HOOKS']['parseStoreData']) ) {
  196.             foreach( $GLOBALS['N2SL_HOOKS']['parseStoreData'] as $callback ) {
  198.                 if( is_array($callback) ) {
  199.                     System::importStatic($callback[0])->{$callback[1]}($store, $module);
  200.                 }
  201.             }
  202.         }
  203.     }
  206.     /**
  207.      * Returns a list of weekdays
  208.      *
  209.      * @return array
  210.      */
  211.     public static function getWeekdays(): array {
  213.         return [
  214.             'MO' => &$GLOBALS['TL_LANG']['DAYS'][1]
  215.         ,   'TU' => &$GLOBALS['TL_LANG']['DAYS'][2]
  216.         ,   'WE' => &$GLOBALS['TL_LANG']['DAYS'][3]
  217.         ,   'TH' => &$GLOBALS['TL_LANG']['DAYS'][4]
  218.         ,   'FR' => &$GLOBALS['TL_LANG']['DAYS'][5]
  219.         ,   'SA' => &$GLOBALS['TL_LANG']['DAYS'][6]
  220.         ,   'SU' => &$GLOBALS['TL_LANG']['DAYS'][0]
  221.         ];
  222.     }
  225.     /**
  226.      * Find coordinates for given address
  227.      *
  228.      * @param string Street
  229.      * @param string Postal/ZIP Code
  230.      * @param string Name of city
  231.      * @param string 2-letter country code
  232.      * @param string Address string without specific format
  233.      *
  234.      * @return array
  235.      */
  236.     public function getCoordinates( $street=null, $postal=null, $city=null, $country=null, $fullAddress=null ): array {
  238.         trigger_deprecation('numero2/contao-storelocator', '4.3', 'Using StoreLocator::getCoordinates() has been deprecated and will no longer work in Storelocator 5.0. Use the service "numero2_storelocator.util.store_locator" instead.');
  240.         return System::getContainer()->get('numero2_storelocator.util.store_locator')->getCoordinates(null, null, null, null, $fullAddress, false);
  241.     }
  244.     /**
  245.      * Gets coordinates for an address without a specific format
  246.      *
  247.      * @param string The address
  248.      *
  249.      * @return array
  250.      */
  251.     public function getCoordinatesByString( string $fullAddress=null ): array {
  253.         trigger_deprecation('numero2/contao-storelocator', '4.3', 'Using StoreLocator::getCoordinatesByString() has been deprecated and will no longer work in Storelocator 5.0. Use the service "numero2_storelocator.util.store_locator" instead.');
  255.         return System::getContainer()->get('numero2_storelocator.util.store_locator')->getCoordinatesByString($fullAddress, false);
  256.     }
  259.     /**
  260.      * Parses the given search value into its components.
  261.      *
  262.      * @param string The generated search string
  263.      *
  264.      * @return array
  265.      */
  266.     public static function parseSearchValue( $searchVal=null ): array {
  268.         if( !$searchVal ) {
  269.             return [];
  270.         }
  272.         if( strpos($searchVal, ";") !== false ) {
  273.             $searchVal = explode(";", $searchVal);
  274.         }
  276.         $ret = [];
  278.         if( is_array($searchVal) ) {
  280.             if( count($searchVal) == 3 ) {
  282.                 $ret['filter'] = $searchVal[0];
  283.                 $ret['order'] = $searchVal[1];
  284.                 $ret['sort'] = $searchVal[2];
  286.             } else if( count($searchVal) == 4 ) {
  288.                 $ret['filter'] = $searchVal[0];
  289.                 $ret['order'] = $searchVal[1];
  290.                 $ret['sort'] = $searchVal[2];
  291.                 $ret['tags'] = $searchVal[3];
  293.             } else {
  295.                 if( !empty($searchVal[0]) ) $ret['term'] = $searchVal[0];
  296.                 if( !empty($searchVal[1]) ) $ret['category'] = $searchVal[1];
  297.                 if( !empty($searchVal[2]) ) $ret['longitude'] = $searchVal[2];
  298.                 if( !empty($searchVal[3]) ) $ret['latitude'] = $searchVal[3];
  300.                 if( !empty($searchVal[4]) ) $ret['filter'] = $searchVal[4];
  301.                 if( !empty($searchVal[5]) ) $ret['order'] = $searchVal[5];
  302.                 if( !empty($searchVal[6]) ) $ret['sort'] = $searchVal[6];
  303.                 if( !empty($searchVal[7]) ) $ret['tags'] = $searchVal[7];
  304.             }
  306.         } else {
  308.             $ret['term'] = $searchVal;
  309.         }
  311.         foreach( $ret as $i => $d ) {
  312.             $ret[$i] = urldecode($d);
  313.         }
  315.         return $ret;
  316.     }
  319.     /**
  320.      * Generates the search string
  321.      *
  322.      * @param array $arrData
  323.      *
  324.      * @return string
  325.      */
  326.     public static function generateSearchValue( $arrData ): string {
  328.         if( !is_array($arrData) ) {
  329.             return '';
  330.         }
  332.         $aData = [];
  334.         if( !empty($arrData['term']) ) {
  336.             $aData[0] = html_entity_decode($arrData['term']);
  338.             if( !empty($arrData['category']) ) {
  339.                 $aData[1] = $arrData['category'];
  340.             }
  342.             if( !empty($arrData['longitude']) && !empty($arrData['latitude']) ) {
  343.                 $aData[1] = !empty($aData[1])?$aData[1]:'';
  344.                 $aData[2] = $arrData['longitude'];
  345.                 $aData[3] = $arrData['latitude'];
  346.                 $aData[4] = '';
  347.             }
  348.         }
  350.         if( !empty($arrData['filter']) || !empty($arrData['order']) || !empty($arrData['sort']) || !empty($arrData['tags']) ) {
  352.             if( count($aData) == 0 ) {
  354.                 $aData[0] = $arrData['filter']??'';
  355.                 $aData[1] = $arrData['order']??'';
  356.                 $aData[2] = $arrData['sort']??'';
  358.                 if( !empty($arrData['tags']) ) {
  359.                     $aData[3] = $arrData['tags'];
  360.                 }
  362.             } else {
  364.                 $aData[0] = $aData[0]??'';
  365.                 $aData[1] = $aData[1]??'';
  366.                 $aData[2] = $aData[2]??'';
  367.                 $aData[3] = $aData[3]??'';
  368.                 $aData[4] = $arrData['filter']??'';
  369.                 $aData[5] = $arrData['order']??'';
  370.                 $aData[6] = $arrData['sort']??'';
  371.                 $aData[7] = $arrData['tags']??'';
  372.             }
  373.         }
  375.         foreach( $aData as $i => $d ) {
  376.             $aData[$i] = urlencode($d);
  377.         }
  379.         $strData = ( count($aData) > 1 ) ? implode(';',$aData) : ($aData[0]??'');
  381.         return $strData;
  382.     }
  385.     /**
  386.      * Create filter where from value and field list and an optional tag id
  387.      *
  388.      * @param string $value
  389.      * @param array $fields
  390.      * @param string $tagId
  391.      *
  392.      * @return string
  393.      */
  394.     public static function createFilterWhereClause( string $searchValue, array $fields, ?string $tagId=null ): string {
  396.         $ret = [];
  398.         if( !empty($searchValue) ) {
  399.             foreach( $fields as $key => $field ) {
  400.                 $ret[] = $field." LIKE '%%".$searchValue."%%'";
  401.             }
  402.         }
  404.         if( !empty($ret) ) {
  405.             $ret = '('.implode(" OR ", $ret).')';
  406.         } else {
  407.             $ret = '';
  408.         }
  410.         if( !empty($tagId) ) {
  412.             if( strlen($ret) ) {
  413.                 $ret .= "AND ";
  414.             }
  416.             $ret .= "id IN ( SELECT s.id
  417.                 FROM tl_storelocator_stores AS s
  418.                 JOIN tl_tags_rel as r on (r.pid = s.id AND r.ptable = 'tl_storelocator_stores' AND r.field = 'tags' AND r.tag_id = $tagId)
  419.             )";
  420.         }
  422.         return $ret;
  423.     }
  424. }