system/modules/sg-locations/models/SgLocationsModel.php line 52

Open in your IDE?
  1. <?php
  3. /**
  4.  * Contao Open Source CMS
  5.  *
  6.  * Copyright (c) 2005-2015 Leo Feyer
  7.  *
  8.  * @package   SgLocations
  9.  * @author    Sg-Medien GmbH <info@sg-medien.com>
  10.  * @license   EULA
  11.  * @copyright Sg-Medien GmbH 2017
  12.  */
  15. /**
  16.  * Set custom namespace
  17.  */
  18. namespace SgM;
  21. /**
  22.  * Class SgLocationsModel
  23.  *
  24.  * Reads and writes locations.
  25.  *
  26.  * @package   SgLocations
  27.  * @author    Sg-Medien GmbH <info@sg-medien.com>
  28.  * @copyright Sg-Medien GmbH 2017
  29.  */
  30. class SgLocationsModel extends \Model
  31. {
  32.     /**
  33.      * Table name
  34.      * @var string
  35.      */
  36.     protected static $strTable = 'tl_sg_locations';
  39.     /**
  40.      * Find a location by its ID
  41.      *
  42.      * @param mixed $varId The numeric ID
  43.      * @param array $arrOptions An optional options array
  44.      *
  45.      * @return \Model|null The SgLocationsModel or null if there is no location
  46.      */
  47.     public static function findById($varId, array $arrOptions = array())
  48.     {
  49.         $t = static::$strTable;
  50.         $arrColumns = array("$t.id=?");
  52.         return static::findOneBy($arrColumns, array((is_numeric($varId) ? $varId : 0)), $arrOptions);
  53.     }
  56.     /**
  57.      * Find a location from one or more categories by its ID
  58.      *
  59.      * @param mixed $varId The numeric ID
  60.      * @param array $arrPids An array of parent IDs
  61.      * @param array $arrOptions An optional options array
  62.      *
  63.      * @return \Model|null The SgLocationsModel or null if there is no location
  64.      */
  65.     public static function findByIdAndPids($varId, $arrPids, array $arrOptions = array())
  66.     {
  67.         if (!is_array($arrPids) OR empty($arrPids)) {
  68.             return null;
  69.         }
  71.         $t = static::$strTable;
  72.         $arrColumns = array("$t.id=? AND pid IN(" . implode(',', array_map('intval', $arrPids)) . ")");
  74.         return static::findOneBy($arrColumns, array((is_numeric($varId) ? $varId : 0)), $arrOptions);
  75.     }
  78.     /**
  79.      * Find all locations by their parent ID
  80.      *
  81.      * @param int   $intPid The parent ID
  82.      * @param array $arrOptions An optional options array
  83.      *
  84.      * @return \Model\Collection|null A collection of models or null if there are no locations
  85.      */
  86.     public static function findByPid($intPid, array $arrOptions = array())
  87.     {
  88.         $t = static::$strTable;
  89.         $arrColumns = array("$t.pid=?");
  91.         if (!isset($arrOptions['order'])) {
  92.             $arrOptions['order'] = "$t.sorting";
  93.         }
  95.         return static::findBy($arrColumns, $intPid, $arrOptions);
  96.     }
  99.     /**
  100.      * Count all locations (optional by their parent IDs)
  101.      *
  102.      * @param array $arrPids An optional array of location category IDs.
  103.      * @param array $arrFilters An optional filter array.
  104.      * @param array $arrOptions An optional options array.
  105.      *
  106.      * @return \Model\Collection|null A collection of models or null if there are no location elements
  107.      */
  108.     public static function countAllOrByPids(array $arrPids = array(), array $arrFilters = array(), array $arrOptions = array())
  109.     {
  110.         $t = static::$strTable;
  111.         $arrColumns = (is_array($arrPids) AND !empty($arrPids)) ? array("$t.pid IN(" . implode(',', array_map('intval', $arrPids)) . ")") : array("$t.pid!=0");
  113.         $arrValues = array();
  114.         if (is_array($arrFilters) AND !empty($arrFilters)) {
  115.             foreach ($arrFilters AS $filter) {
  116.                 if (is_array($filter)) {
  117.                     if (isset($filter['sql']) AND !empty($filter['sql'])) {
  118.                         $arrColumns[] = str_replace('%t', $t, $filter['sql']);
  119.                     }
  120.                     if (is_array($filter['values']) AND !empty($filter['values'])) {
  121.                         $arrValues = array_merge($arrValues, $filter['values']);
  122.                     }
  123.                 }
  124.             }
  125.         }
  127.         return static::countBy($arrColumns, $arrValues, $arrOptions);
  128.     }
  131.     /**
  132.      * Find all locations (optional by their parent IDs)
  133.      *
  134.      * @param array   $arrPids An optional array of location category IDs.
  135.      * @param integer $intLimit An optional limit.
  136.      * @param integer $intOffset An optional offset.
  137.      * @param array   $arrFilters An optional filter array.
  138.      * @param array   $arrOptions An optional options array.
  139.      *
  140.      * @return \Model\Collection|null A collection of models or null if there are no location elements
  141.      */
  142.     public static function findAllOrByPids(array $arrPids = array(), $intLimit = 0, $intOffset = 0, array $arrFilters = array(), array $arrOptions = array())
  143.     {
  144.         $t = static::$strTable;
  145.         $arrColumns = (is_array($arrPids) AND !empty($arrPids)) ? array("$t.pid IN(" . implode(',', array_map('intval', $arrPids)) . ")") : array("$t.pid!=0");
  147.         $arrValues = array();
  148.         if (is_array($arrFilters) AND !empty($arrFilters)) {
  149.             foreach ($arrFilters AS $filter) {
  150.                 if (is_array($filter)) {
  151.                     if (isset($filter['sql']) AND !empty($filter['sql'])) {
  152.                         $arrColumns[] = str_replace('%t', $t, $filter['sql']);
  153.                     }
  154.                     if (is_array($filter['values']) AND !empty($filter['values'])) {
  155.                         $arrValues = array_merge($arrValues, $filter['values']);
  156.                     }
  157.                 }
  158.             }
  159.         }
  161.         if (!isset($arrOptions['order'])) {
  162.             $arrOptions['order'] = "$t.pid, $t.sorting";
  163.         } else {
  164.             $arrOptions['order'] = str_replace('%t', $t, $arrOptions['order']);
  165.         }
  167.         $arrOptions['limit'] = $intLimit;
  168.         $arrOptions['offset'] = $intOffset;
  170.         return static::findBy($arrColumns, $arrValues, $arrOptions);
  171.     }
  172. }