1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 <?php
namespace Gedcomx\Rs\Client\Util;
/**
* This is a helper utility for building syntactically correct place search query strings.
*
* Class GedcomxPlaceSearchQueryBuilder
*
* @package Gedcomx\Rs\Client\Util
*/
class GedcomxPlaceSearchQueryBuilder extends GedcomxBaseSearchQueryBuilder
{
/**
* The name parameter in place search queries.
*/
const NAME = "name";
/**
* The date parameter in place search queries.
*/
const DATE = "date";
/**
* The parent parameter in place search queries.
*/
const PARENT_ID = "parentId";
/**
* The type parameter in place search queries.
*/
const TYPE_ID = "typeId";
/**
* The type group parameter in place search queries.
*/
const TYPE_GROUP_ID = "typeGroupId";
/**
* The latitude parameter in place search queries.
*/
const LATITUDE = "latitude";
/**
* The longitude parameter in place search queries.
*/
const LONGITUDE = "longitude";
/**
* The distance parameter in place search queries.
*/
const DISTANCE = "distance";
/**
* Creates a generic search parameter with the specified name and value.
*
* @param string $name
* @param string $value
* @param string $prefix
* @param bool $exact
*
* @return $this
*/
private function param($prefix, $name, $value, $exact)
{
$this->parameters[] = new SearchParameter($prefix, $name, $value, $exact);
return $this;
}
/**
* Search where place name equals
*
* @param string $value
* @param bool $exact
* @param bool $required
*
* @return $this
*/
public function name($value, $exact = true, $required = false)
{
return $this->param($required ? "+" : null, self::NAME, $value, $exact);
}
/**
* Search where place name is not equal to
*
* @param string $value
*
* @return $this
*/
public function nameNot($value)
{
return $this->param("-", NAME, $value, false);
}
/**
* Search where place date equals
*
* @param string $value
* @param bool $exact
* @param bool $required
*
* @return $this
*/
public function date($value, $exact = true, $required = false)
{
return $this->param($required ? "+" : null, self::DATE, $value, $exact);
}
/**
* Search where place date is not equal to
*
* @param string $value
*
* @return $this
*/
public function dateNot($value)
{
return $this->param("-", self::DATE, $value, false);
}
/**
* Search where place parentId equals
*
* @param string $value
* @param bool $exact
* @param bool $required
*
* @return $this
*/
public function parentId($value, $exact = true, $required = false)
{
return $this->param($required ? "+" : null, self::PARENT_ID, $value, $exact);
}
/**
* Search where place parent id is not equal to
*
* @param string $value
*
* @return $this
*/
public function parentIdNot($value)
{
return $this->param("-", self::PARENT_ID, $value, false);
}
/**
* Search where place type id equals
*
* @param string $value
* @param bool $exact
* @param bool $required
*
* @return $this
*/
public function typeId($value, $exact = true, $required = false)
{
return $this->param($required ? "+" : null, self::TYPE_ID, $value, $exact);
}
/**
* Search where place type id is not equal to
*
* @param string $value
*
* @return $this
*/
public function typeIdNot($value)
{
return $this->param("-", self::TYPE_ID, $value, false);
}
/**
* Search where place type group id equals
*
* @param string $value
* @param bool $exact
* @param bool $required
*
* @return $this
*/
public function typeGroupId($value, $exact = true, $required = false)
{
return $this->param($required ? "+" : null, self::TYPE_GROUP_ID, $value, $exact);
}
/**
* Search where place group id is not equal to
*
* @param string $value
*
* @return $this
*/
public function typeGroupIdNot($value)
{
return $this->param("-", self::TYPE_GROUP_ID, $value, false);
}
/**
* Search where latitude equals
*
* @param string $value
* @param bool $exact
* @param bool $required
*
* @return $this
*/
public function latitude($value, $exact = true, $required = false)
{
return $this->param($required ? "+" : null, self::LATITUDE, $value, $exact);
}
/**
* Search where latitude is not equal to
*
* @param string $value
*
* @return $this
*/
public function latitudeNot($value)
{
return $this->param("-", self::LATITUDE, $value, false);
}
/**
* Search where longitude equals
*
* @param string $value
* @param bool $exact
* @param bool $required
*
* @return $this
*/
public function longitude($value, $exact = true, $required = false)
{
return $this->param($required ? "+" : null, self::LONGITUDE, $value, $exact);
}
/**
* Search where longitdue is not equal to
*
* @param string $value
*
* @return $this
*/
public function longitudeNot($value)
{
return $this->param("-", self::LONGITUDE, $value, false);
}
/**
* Search where distance equals
*
* @param string $value
* @param bool $exact
* @param bool $required
*
* @return $this
*/
public function distance($value, $exact = true, $required = false)
{
return $this->param($required ? "+" : null, self::DISTANCE, $value, $exact);
}
/**
* Search where distance is not equal to
*
* @param string $value
*
* @return $this
*/
public function distanceNot($value)
{
return $this->param("-", self::DISTANCE, $value, false);
}
}