PageRenderTime 27ms CodeModel.GetById 10ms RepoModel.GetById 0ms app.codeStats 0ms

/Resources/doc/class-Mazurkiewicz.FuzzyBundle.Fuzzy.Functions.AbstractFuzzyFunction.html

https://gitlab.com/auroree/fuzzy
HTML | 443 lines | 309 code | 134 blank | 0 comment | 0 complexity | cd0e9bd3b2fa3dd485461cb7649fdfef MD5 | raw file
    

  1. <!DOCTYPE html>
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

  4. 	<meta charset="utf-8">
    5. 

  5. 

  6. 	<title>Class Mazurkiewicz\FuzzyBundle\Fuzzy\Functions\AbstractFuzzyFunction</title>
    7. 

  7. 

  8. 	<link rel="stylesheet" href="resources/style.css?e99947befd7bf673c6b43ff75e9e0f170c88a60e">
    9. 

  9. 

  10. </head>
    11. 

  11. 

  12. <body>
    13. 

  13. <div id="left">
    14. 

  14. 	<div id="menu">
    15. 

  15. 		<a href="index.html" title="Overview"><span>Overview</span></a>
    16. 

  16. 

  17. 

  18. 		<div id="groups">
    19. 

  19. 				<h3>Namespaces</h3>
    20. 

  20. 			<ul>
    21. 

  21. 				<li class="active">
    22. 

  22. 					<a href="namespace-Mazurkiewicz.html">
    23. 

  23. 						Mazurkiewicz<span></span>
    24. 

  24. 					</a>
    25. 

  25. 

  26. 						<ul>
    27. 

  27. 				<li class="active">
    28. 

  28. 					<a href="namespace-Mazurkiewicz.FuzzyBundle.html">
    29. 

  29. 						FuzzyBundle<span></span>
    30. 

  30. 					</a>
    31. 

  31. 

  32. 						<ul>
    33. 

  33. 				<li>
    34. 

  34. 					<a href="namespace-Mazurkiewicz.FuzzyBundle.DataFixtures.html">
    35. 

  35. 						DataFixtures<span></span>
    36. 

  36. 					</a>
    37. 

  37. 

  38. 						<ul>
    39. 

  39. 				<li>
    40. 

  40. 					<a href="namespace-Mazurkiewicz.FuzzyBundle.DataFixtures.ORM.html">
    41. 

  41. 						ORM					</a>
    42. 

  42. 

  43. 						</li>
    44. 

  44. 							</ul></li>
    45. 

  45. 				<li>
    46. 

  46. 					<a href="namespace-Mazurkiewicz.FuzzyBundle.DependencyInjection.html">
    47. 

  47. 						DependencyInjection					</a>
    48. 

  48. 

  49. 						</li>
    50. 

  50. 				<li>
    51. 

  51. 					<a href="namespace-Mazurkiewicz.FuzzyBundle.Doctrine.html">
    52. 

  52. 						Doctrine<span></span>
    53. 

  53. 					</a>
    54. 

  54. 

  55. 						<ul>
    56. 

  56. 				<li>
    57. 

  57. 					<a href="namespace-Mazurkiewicz.FuzzyBundle.Doctrine.Dql.html">
    58. 

  58. 						Dql<span></span>
    59. 

  59. 					</a>
    60. 

  60. 

  61. 						<ul>
    62. 

  62. 				<li>
    63. 

  63. 					<a href="namespace-Mazurkiewicz.FuzzyBundle.Doctrine.Dql.MySql.html">
    64. 

  64. 						MySql<span></span>
    65. 

  65. 					</a>
    66. 

  66. 

  67. 						<ul>
    68. 

  68. 				<li>
    69. 

  69. 					<a href="namespace-Mazurkiewicz.FuzzyBundle.Doctrine.Dql.MySql.Common.html">
    70. 

  70. 						Common					</a>
    71. 

  71. 

  72. 						</li>
    73. 

  73. 				<li>
    74. 

  74. 					<a href="namespace-Mazurkiewicz.FuzzyBundle.Doctrine.Dql.MySql.Fuzzy.html">
    75. 

  75. 						Fuzzy					</a>
    76. 

  76. 

  77. 						</li>
    78. 

  78. 							</ul></li></ul></li></ul></li>
    79. 

  79. 				<li class="active">
    80. 

  80. 					<a href="namespace-Mazurkiewicz.FuzzyBundle.Fuzzy.html">
    81. 

  81. 						Fuzzy<span></span>
    82. 

  82. 					</a>
    83. 

  83. 

  84. 						<ul>
    85. 

  85. 				<li>
    86. 

  86. 					<a href="namespace-Mazurkiewicz.FuzzyBundle.Fuzzy.Exception.html">
    87. 

  87. 						Exception					</a>
    88. 

  88. 

  89. 						</li>
    90. 

  90. 				<li class="active">
    91. 

  91. 					<a href="namespace-Mazurkiewicz.FuzzyBundle.Fuzzy.Functions.html">
    92. 

  92. 						Functions					</a>
    93. 

  93. 

  94. 						</li>
    95. 

  95. 							</ul></li>
    96. 

  96. 				<li>
    97. 

  97. 					<a href="namespace-Mazurkiewicz.FuzzyBundle.Tests.html">
    98. 

  98. 						Tests<span></span>
    99. 

  99. 					</a>
    100. 

  100. 

  101. 						<ul>
    102. 

  102. 				<li>
    103. 

  103. 					<a href="namespace-Mazurkiewicz.FuzzyBundle.Tests.Doctrine.html">
    104. 

  104. 						Doctrine<span></span>
    105. 

  105. 					</a>
    106. 

  106. 

  107. 						<ul>
    108. 

  108. 				<li>
    109. 

  109. 					<a href="namespace-Mazurkiewicz.FuzzyBundle.Tests.Doctrine.Dql.html">
    110. 

  110. 						Dql<span></span>
    111. 

  111. 					</a>
    112. 

  112. 

  113. 						<ul>
    114. 

  114. 				<li>
    115. 

  115. 					<a href="namespace-Mazurkiewicz.FuzzyBundle.Tests.Doctrine.Dql.MySql.html">
    116. 

  116. 						MySql<span></span>
    117. 

  117. 					</a>
    118. 

  118. 

  119. 						<ul>
    120. 

  120. 				<li>
    121. 

  121. 					<a href="namespace-Mazurkiewicz.FuzzyBundle.Tests.Doctrine.Dql.MySql.Fuzzy.html">
    122. 

  122. 						Fuzzy					</a>
    123. 

  123. 

  124. 						</li>
    125. 

  125. 							</ul></li></ul></li></ul></li>
    126. 

  126. 				<li>
    127. 

  127. 					<a href="namespace-Mazurkiewicz.FuzzyBundle.Tests.Fuzzy.html">
    128. 

  128. 						Fuzzy<span></span>
    129. 

  129. 					</a>
    130. 

  130. 

  131. 						<ul>
    132. 

  132. 				<li>
    133. 

  133. 					<a href="namespace-Mazurkiewicz.FuzzyBundle.Tests.Fuzzy.Functions.html">
    134. 

  134. 						Functions					</a>
    135. 

  135. 

  136. 						</li>
    137. 

  137. 							</ul></li>
    138. 

  138. 				<li>
    139. 

  139. 					<a href="namespace-Mazurkiewicz.FuzzyBundle.Tests.Table.html">
    140. 

  140. 						Table					</a>
    141. 

  141. 

  142. 						</li>
    143. 

  143. 							</ul></li></ul></li></ul></li>
    144. 

  144. 			</ul>
    145. 

  145. 		</div>
    146. 

  146. 

  147. 		<hr>
    148. 

  148. 

  149. 

  150. 		<div id="elements">
    151. 

  151. 			<h3>Classes</h3>
    152. 

  152. 			<ul>
    153. 

  153. 				<li class="active"><a href="class-Mazurkiewicz.FuzzyBundle.Fuzzy.Functions.AbstractFuzzyFunction.html">AbstractFuzzyFunction</a></li>
    154. 

  154. 				<li><a href="class-Mazurkiewicz.FuzzyBundle.Fuzzy.Functions.InRangeFunction.html">InRangeFunction</a></li>
    155. 

  155. 				<li><a href="class-Mazurkiewicz.FuzzyBundle.Fuzzy.Functions.NearFunction.html">NearFunction</a></li>
    156. 

  156. 				<li><a href="class-Mazurkiewicz.FuzzyBundle.Fuzzy.Functions.NearGaussianFunction.html">NearGaussianFunction</a></li>
    157. 

  157. 			</ul>
    158. 

  158. 

  159. 

  160. 

  161. 

  162. 

  163. 		</div>
    164. 

  164. 	</div>
    165. 

  165. </div>
    166. 

  166. 

  167. <div id="splitter"></div>
    168. 

  168. 

  169. <div id="right">
    170. 

  170. <div id="rightInner">
    171. 

  171. 	<form id="search">
    172. 

  172. 		<input type="hidden" name="cx" value="">
    173. 

  173. 		<input type="hidden" name="ie" value="UTF-8">
    174. 

  174. 		<input type="text" name="q" class="text" placeholder="Search">
    175. 

  175. 	</form>
    176. 

  176. 

  177. 	<div id="navigation">
    178. 

  178. 		<ul>
    179. 

  179. 			<li>
    180. 

  180. 				<a href="index.html" title="Overview"><span>Overview</span></a>
    181. 

  181. 			</li>
    182. 

  182. 			<li>
    183. 

  183. 				<a href="namespace-Mazurkiewicz.FuzzyBundle.Fuzzy.Functions.html" title="Summary of Mazurkiewicz\FuzzyBundle\Fuzzy\Functions"><span>Namespace</span></a>
    184. 

  184. 			</li>
    185. 

  185. 			<li class="active">
    186. 

  186. <span>Class</span>			</li>
    187. 

  187. 		</ul>
    188. 

  188. 		<ul>
    189. 

  189. 		</ul>
    190. 

  190. 		<ul>
    191. 

  191. 		</ul>
    192. 

  192. 	</div>
    193. 

  193. 

  194. <div id="content" class="class">
    195. 

  195. 	<h1>Class AbstractFuzzyFunction</h1>
    196. 

  196. 

  197. 

  198. 	<div class="description">
    199. 

  199. 	<p>Base class for fuzzy function.</p>
    200. 

  200. 	</div>
    201. 

  201. 

  202. 

  203. 

  204. 	<div>
    205. 

  205. 		<h4>Direct known subclasses</h4>
    206. 

  206. 			<a href="class-Mazurkiewicz.FuzzyBundle.Fuzzy.Functions.InRangeFunction.html">Mazurkiewicz\FuzzyBundle\Fuzzy\Functions\InRangeFunction</a>, 
    207. 

  207. 			<a href="class-Mazurkiewicz.FuzzyBundle.Fuzzy.Functions.NearFunction.html">Mazurkiewicz\FuzzyBundle\Fuzzy\Functions\NearFunction</a>, 
    208. 

  208. 			<a href="class-Mazurkiewicz.FuzzyBundle.Fuzzy.Functions.NearGaussianFunction.html">Mazurkiewicz\FuzzyBundle\Fuzzy\Functions\NearGaussianFunction</a>
    209. 

  209. 	</div>
    210. 

  210. 

  211. 

  212. 

  213. 

  214. 

  215. 

  216. 	<div class="info">
    217. 

  217. 		<b>Abstract</b><br>
    218. 

  218. 		
    219. 

  219. 		<b>Namespace:</b> <a href="namespace-Mazurkiewicz.html">Mazurkiewicz</a>\<a href="namespace-Mazurkiewicz.FuzzyBundle.html">FuzzyBundle</a>\<a href="namespace-Mazurkiewicz.FuzzyBundle.Fuzzy.html">Fuzzy</a>\<a href="namespace-Mazurkiewicz.FuzzyBundle.Fuzzy.Functions.html">Functions</a><br>
    220. 

  220. 		
    221. 

  221. 

  222. 			<b>Located at</b> <a href="source-class-Mazurkiewicz.FuzzyBundle.Fuzzy.Functions.AbstractFuzzyFunction.html#5-61" title="Go to source code">Functions/AbstractFuzzyFunction.php</a>
    223. 

  223. 		<br>
    224. 

  224. 	</div>
    225. 

  225. 

  226. 

  227. 

  228. 	<table class="summary methods" id="methods">
    229. 

  229. 	<caption>Methods summary</caption>
    230. 

  230. 	<tr data-order="__construct" id="___construct">
    231. 

  231. 

  232. 		<td class="attributes"><code>
    233. 

  233. 			 public 
    234. 

  234. 

  235. 			
    236. 

  236. 			
    237. 

  237. 			</code>
    238. 

  238. 		</td>
    239. 

  239. 

  240. 		<td class="name"><div>
    241. 

  241. 		<a class="anchor" href="#___construct">#</a>
    242. 

  242. 		<code><a href="source-class-Mazurkiewicz.FuzzyBundle.Fuzzy.Functions.AbstractFuzzyFunction.html#17-25" title="Go to source code">__construct</a>( <span>array <var>$parameters</var></span> )</code>
    243. 

  243. 

  244. 		<div class="description short">
    245. 

  245. 			<p>Constructor.</p>
    246. 

  246. 		</div>
    247. 

  247. 

  248. 		<div class="description detailed hidden">
    249. 

  249. 			<p>Constructor.</p>
    250. 

  250. 

  251. 

  252. 				<h4>Parameters</h4>
    253. 

  253. 				<div class="list"><dl>
    254. 

  254. 					<dt><var>$parameters</var></dt>
    255. 

  255. 					<dd>Function parameters</dd>
    256. 

  256. 				</dl></div>
    257. 

  257. 

  258. 

  259. 

  260. 

  261. 

  262. 		</div>
    263. 

  263. 		</div></td>
    264. 

  264. 	</tr>
    265. 

  265. 	<tr data-order="getDql" id="_getDql">
    266. 

  266. 

  267. 		<td class="attributes"><code>
    268. 

  268. 			 public 
    269. 

  269. 

  270. 			
    271. 

  271. 			
    272. 

  272. 			</code>
    273. 

  273. 		</td>
    274. 

  274. 

  275. 		<td class="name"><div>
    276. 

  276. 		<a class="anchor" href="#_getDql">#</a>
    277. 

  277. 		<code><a href="source-class-Mazurkiewicz.FuzzyBundle.Fuzzy.Functions.AbstractFuzzyFunction.html#27-37" title="Go to source code">getDql</a>( <span>string <var>$mode</var></span>, <span>string <var>$value</var></span>, <span>float <var>$threshold</var> = <span class="php-keyword1">false</span></span> )</code>
    278. 

  278. 

  279. 		<div class="description short">
    280. 

  280. 			<p>Gets DQL condition expression.</p>
    281. 

  281. 		</div>
    282. 

  282. 

  283. 		<div class="description detailed hidden">
    284. 

  284. 			<p>Gets DQL condition expression.</p>
    285. 

  285. 

  286. 

  287. 				<h4>Parameters</h4>
    288. 

  288. 				<div class="list"><dl>
    289. 

  289. 					<dt><var>$mode</var></dt>
    290. 

  290. 					<dd>Contant from class FuzzyModes</dd>
    291. 

  291. 					<dt><var>$value</var></dt>
    292. 

  292. 					<dd>String representing value in sql statement</dd>
    293. 

  293. 					<dt><var>$threshold</var></dt>
    294. 

  294. 					<dd>Threshold for fuzzy query</dd>
    295. 

  295. 				</dl></div>
    296. 

  296. 

  297. 

  298. 

  299. 

  300. 

  301. 		</div>
    302. 

  302. 		</div></td>
    303. 

  303. 	</tr>
    304. 

  304. 	<tr data-order="concatFunction" id="_concatFunction">
    305. 

  305. 

  306. 		<td class="attributes"><code>
    307. 

  307. 			 protected 
    308. 

  308. 

  309. 			string
    310. 

  310. 			
    311. 

  311. 			</code>
    312. 

  312. 		</td>
    313. 

  313. 

  314. 		<td class="name"><div>
    315. 

  315. 		<a class="anchor" href="#_concatFunction">#</a>
    316. 

  316. 		<code><a href="source-class-Mazurkiewicz.FuzzyBundle.Fuzzy.Functions.AbstractFuzzyFunction.html#39-50" title="Go to source code">concatFunction</a>( <span>string <var>$identifier</var></span>, <span>array <var>$parameters</var></span> )</code>
    317. 

  317. 

  318. 		<div class="description short">
    319. 

  319. 			<p>Produces function call string.</p>
    320. 

  320. 		</div>
    321. 

  321. 

  322. 		<div class="description detailed hidden">
    323. 

  323. 			<p>Produces function call string.</p>
    324. 

  324. 

  325. 

  326. 				<h4>Parameters</h4>
    327. 

  327. 				<div class="list"><dl>
    328. 

  328. 					<dt><var>$identifier</var></dt>
    329. 

  329. 					<dd>Function identifier</dd>
    330. 

  330. 					<dt><var>$parameters</var></dt>
    331. 

  331. 					<dd>Function parameters</dd>
    332. 

  332. 				</dl></div>
    333. 

  333. 

  334. 				<h4>Returns</h4>
    335. 

  335. 				<div class="list">
    336. 

  336. 					string<br>Function call string
    337. 

  337. 				</div>
    338. 

  338. 

  339. 

  340. 

  341. 

  342. 		</div>
    343. 

  343. 		</div></td>
    344. 

  344. 	</tr>
    345. 

  345. 	<tr data-order="getDqlString" id="_getDqlString">
    346. 

  346. 

  347. 		<td class="attributes"><code>
    348. 

  348. 			abstract protected 
    349. 

  349. 

  350. 			
    351. 

  351. 			
    352. 

  352. 			</code>
    353. 

  353. 		</td>
    354. 

  354. 

  355. 		<td class="name"><div>
    356. 

  356. 		<a class="anchor" href="#_getDqlString">#</a>
    357. 

  357. 		<code><a href="source-class-Mazurkiewicz.FuzzyBundle.Fuzzy.Functions.AbstractFuzzyFunction.html#52-60" title="Go to source code">getDqlString</a>( <span><code><a href="class-Mazurkiewicz.FuzzyBundle.Fuzzy.FuzzyModes.html">Mazurkiewicz\FuzzyBundle\Fuzzy\FuzzyModes</a></code> <var>$mode</var></span>, <span>array <var>$parameters</var></span>, <span>string <var>$value</var></span>, <span>float <var>$threshold</var></span> )</code>
    358. 

  358. 

  359. 		<div class="description short">
    360. 

  360. 			<p>Gets DQL expression representing fuzzy function.</p>
    361. 

  361. 		</div>
    362. 

  362. 

  363. 		<div class="description detailed hidden">
    364. 

  364. 			<p>Gets DQL expression representing fuzzy function.</p>
    365. 

  365. 

  366. 

  367. 				<h4>Parameters</h4>
    368. 

  368. 				<div class="list"><dl>
    369. 

  369. 					<dt><var>$mode</var></dt>
    370. 

  370. 					<dd></dd>
    371. 

  371. 					<dt><var>$parameters</var></dt>
    372. 

  372. 					<dd>Array of function parameters</dd>
    373. 

  373. 					<dt><var>$value</var></dt>
    374. 

  374. 					<dd>String representing value in sql statement</dd>
    375. 

  375. 					<dt><var>$threshold</var></dt>
    376. 

  376. 					<dd>Threshold for fuzzy query</dd>
    377. 

  377. 				</dl></div>
    378. 

  378. 

  379. 

  380. 

  381. 

  382. 

  383. 		</div>
    384. 

  384. 		</div></td>
    385. 

  385. 	</tr>
    386. 

  386. 	</table>
    387. 

  387. 

  388. 

  389. 

  390. 

  391. 

  392. 

  393. 

  394. 

  395. 

  396. 

  397. 

  398. 

  399. 	<table class="summary properties" id="properties">
    400. 

  400. 	<caption>Properties summary</caption>
    401. 

  401. 	<tr data-order="parameters" id="$parameters">
    402. 

  402. 		<td class="attributes"><code>
    403. 

  403. 			private  
    404. 

  404. 			array
    405. 

  405. 		</code></td>
    406. 

  406. 

  407. 		<td class="name">
    408. 

  408. 				<a href="source-class-Mazurkiewicz.FuzzyBundle.Fuzzy.Functions.AbstractFuzzyFunction.html#10-15" title="Go to source code"><var>$parameters</var></a>
    409. 

  409. 

  410. 			<div class="description short">
    411. 

  411. 				<p>List of function parameters.</p>
    412. 

  412. 			</div>
    413. 

  413. 

  414. 			<div class="description detailed hidden">
    415. 

  415. 				<p>List of function parameters.</p>
    416. 

  416. 

  417. 			</div>
    418. 

  418. 		</td>
    419. 

  419. 		<td class="value">
    420. 

  420. 			<div>
    421. 

  421. 				<a href="#$parameters" class="anchor">#</a>
    422. 

  422. 				<code></code>
    423. 

  423. 			</div>
    424. 

  424. 		</td>
    425. 

  425. 	</tr>
    426. 

  426. 	</table>
    427. 

  427. 

  428. 

  429. 

  430. 

  431. 

  432. 

  433. </div>
    434. 

  434. 

  435. 	<div id="footer">
    436. 

  436. 		 API documentation generated by <a href="http://apigen.org">ApiGen</a>
    437. 

  437. 	</div>
    438. 

  438. </div>
    439. 

  439. </div>
    440. 

  440. <script src="resources/combined.js"></script>
    441. 

  441. <script src="elementlist.js"></script>
    442. 

  442. </body>
    443. 

  443. </html>
    444. 

  444.