PageRenderTime 53ms CodeModel.GetById 25ms RepoModel.GetById 0ms app.codeStats 0ms

/doxy/html/class_facebook_1_1_url_1_1_facebook_url_manipulator.html

https://bitbucket.org/leozmoos/projet_web_bdd
HTML | 343 lines | 324 code | 14 blank | 5 comment | 0 complexity | 8ae7bd5557244640693d120d7c2919d4 MD5 | raw file
Possible License(s): MPL-2.0-no-copyleft-exception 
    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <meta name="generator" content="Doxygen 1.8.14"/>
    7. 

  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
    8. 

  8. <title>Hapy: FacebookUrlManipulator Class Reference</title>
    9. 

  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    10. 

  10. <script type="text/javascript" src="jquery.js"></script>
    11. 

  11. <script type="text/javascript" src="dynsections.js"></script>
    12. 

  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
    13. 

  13. <script type="text/javascript" src="search/searchdata.js"></script>
    14. 

  14. <script type="text/javascript" src="search/search.js"></script>
    15. 

  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    16. 

  16. </head>
    17. 

  17. <body>
    18. 

  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    19. 

  19. <div id="titlearea">
    20. 

  20. <table cellspacing="0" cellpadding="0">
    21. 

  21.  <tbody>
    22. 

  22.  <tr style="height: 56px;">
    23. 

  23.   <td id="projectlogo"><img alt="Logo" src="LogoHapy.png"/></td>
    24. 

  24.   <td id="projectalign" style="padding-left: 0.5em;">
    25. 

  25.    <div id="projectname">Hapy
    26. 

  26.    &#160;<span id="projectnumber">1.0</span>
    27. 

  27.    </div>
    28. 

  28.    <div id="projectbrief">Hapy projet web</div>
    29. 

  29.   </td>
    30. 

  30.  </tr>
    31. 

  31.  </tbody>
    32. 

  32. </table>
    33. 

  33. </div>
    34. 

  34. <!-- end header part -->
    35. 

  35. <!-- Generated by Doxygen 1.8.14 -->
    36. 

  36. <script type="text/javascript">
    37. 

  37. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
    38. 

  38. var searchBox = new SearchBox("searchBox", "search",false,'Search');
    39. 

  39. /* @license-end */
    40. 

  40. </script>
    41. 

  41. <script type="text/javascript" src="menudata.js"></script>
    42. 

  42. <script type="text/javascript" src="menu.js"></script>
    43. 

  43. <script type="text/javascript">
    44. 

  44. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
    45. 

  45. $(function() {
    46. 

  46.   initMenu('',true,false,'search.php','Search');
    47. 

  47.   $(document).ready(function() { init_search(); });
    48. 

  48. });
    49. 

  49. /* @license-end */</script>
    50. 

  50. <div id="main-nav"></div>
    51. 

  51. <!-- window showing the filter options -->
    52. 

  52. <div id="MSearchSelectWindow"
    53. 

  53.      onmouseover="return searchBox.OnSearchSelectShow()"
    54. 

  54.      onmouseout="return searchBox.OnSearchSelectHide()"
    55. 

  55.      onkeydown="return searchBox.OnSearchSelectKey(event)">
    56. 

  56. </div>
    57. 

  57. 

  58. <!-- iframe showing the search results (closed by default) -->
    59. 

  59. <div id="MSearchResultsWindow">
    60. 

  60. <iframe src="javascript:void(0)" frameborder="0" 
    61. 

  61.         name="MSearchResults" id="MSearchResults">
    62. 

  62. </iframe>
    63. 

  63. </div>
    64. 

  64. 

  65. <div id="nav-path" class="navpath">
    66. 

  66.   <ul>
    67. 

  67. <li class="navelem"><a class="el" href="namespace_facebook.html">Facebook</a></li><li class="navelem"><a class="el" href="namespace_facebook_1_1_url.html">Url</a></li><li class="navelem"><a class="el" href="class_facebook_1_1_url_1_1_facebook_url_manipulator.html">FacebookUrlManipulator</a></li>  </ul>
    68. 

  68. </div>
    69. 

  69. </div><!-- top -->
    70. 

  70. <div class="header">
    71. 

  71.   <div class="summary">
    72. 

  72. <a href="#pub-static-methods">Static Public Member Functions</a>  </div>
    73. 

  73.   <div class="headertitle">
    74. 

  74. <div class="title">FacebookUrlManipulator Class Reference</div>  </div>
    75. 

  75. </div><!--header-->
    76. 

  76. <div class="contents">
    77. 

  77. <table class="memberdecls">
    78. 

  78. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
    79. 

  79. Static Public Member Functions</h2></td></tr>
    80. 

  80. <tr class="memitem:a1c2c5e7054a2e6493476364d8d902b05"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_facebook_1_1_url_1_1_facebook_url_manipulator.html#a1c2c5e7054a2e6493476364d8d902b05">removeParamsFromUrl</a> ($url, array $paramsToFilter)</td></tr>
    81. 

  81. <tr class="separator:a1c2c5e7054a2e6493476364d8d902b05"><td class="memSeparator" colspan="2">&#160;</td></tr>
    82. 

  82. <tr class="memitem:aad8825685089134c129d3c2075195783"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_facebook_1_1_url_1_1_facebook_url_manipulator.html#aad8825685089134c129d3c2075195783">appendParamsToUrl</a> ($url, array $newParams=[])</td></tr>
    83. 

  83. <tr class="separator:aad8825685089134c129d3c2075195783"><td class="memSeparator" colspan="2">&#160;</td></tr>
    84. 

  84. <tr class="memitem:a99fdc16a8923c1000e6cb9f17786a576"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_facebook_1_1_url_1_1_facebook_url_manipulator.html#a99fdc16a8923c1000e6cb9f17786a576">getParamsAsArray</a> ($url)</td></tr>
    85. 

  85. <tr class="separator:a99fdc16a8923c1000e6cb9f17786a576"><td class="memSeparator" colspan="2">&#160;</td></tr>
    86. 

  86. <tr class="memitem:a5634731b5b4b64ffb92c07c21cc78669"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_facebook_1_1_url_1_1_facebook_url_manipulator.html#a5634731b5b4b64ffb92c07c21cc78669">mergeUrlParams</a> ($urlToStealFrom, $urlToAddTo)</td></tr>
    87. 

  87. <tr class="separator:a5634731b5b4b64ffb92c07c21cc78669"><td class="memSeparator" colspan="2">&#160;</td></tr>
    88. 

  88. <tr class="memitem:ade221e200b8ff2a755b36e205a60c7be"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_facebook_1_1_url_1_1_facebook_url_manipulator.html#ade221e200b8ff2a755b36e205a60c7be">forceSlashPrefix</a> ($string)</td></tr>
    89. 

  89. <tr class="separator:ade221e200b8ff2a755b36e205a60c7be"><td class="memSeparator" colspan="2">&#160;</td></tr>
    90. 

  90. <tr class="memitem:aa714a9170567de719a7042e842abe1d1"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_facebook_1_1_url_1_1_facebook_url_manipulator.html#aa714a9170567de719a7042e842abe1d1">baseGraphUrlEndpoint</a> ($urlToTrim)</td></tr>
    91. 

  91. <tr class="separator:aa714a9170567de719a7042e842abe1d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
    92. 

  92. </table>
    93. 

  93. <h2 class="groupheader">Member Function Documentation</h2>
    94. 

  94. <a id="aad8825685089134c129d3c2075195783"></a>
    95. 

  95. <h2 class="memtitle"><span class="permalink"><a href="#aad8825685089134c129d3c2075195783">&#9670;&nbsp;</a></span>appendParamsToUrl()</h2>
    96. 

  96. 

  97. <div class="memitem">
    98. 

  98. <div class="memproto">
    99. 

  99. <table class="mlabels">
    100. 

  100.   <tr>
    101. 

  101.   <td class="mlabels-left">
    102. 

  102.       <table class="memname">
    103. 

  103.         <tr>
    104. 

  104.           <td class="memname">static appendParamsToUrl </td>
    105. 

  105.           <td>(</td>
    106. 

  106.           <td class="paramtype">&#160;</td>
    107. 

  107.           <td class="paramname"><em>$url</em>, </td>
    108. 

  108.         </tr>
    109. 

  109.         <tr>
    110. 

  110.           <td class="paramkey"></td>
    111. 

  111.           <td></td>
    112. 

  112.           <td class="paramtype">array&#160;</td>
    113. 

  113.           <td class="paramname"><em>$newParams</em> = <code>[]</code>&#160;</td>
    114. 

  114.         </tr>
    115. 

  115.         <tr>
    116. 

  116.           <td></td>
    117. 

  117.           <td>)</td>
    118. 

  118.           <td></td><td></td>
    119. 

  119.         </tr>
    120. 

  120.       </table>
    121. 

  121.   </td>
    122. 

  122.   <td class="mlabels-right">
    123. 

  123. <span class="mlabels"><span class="mlabel">static</span></span>  </td>
    124. 

  124.   </tr>
    125. 

  125. </table>
    126. 

  126. </div><div class="memdoc">
    127. 

  127. <p>Gracefully appends params to the URL.</p>
    128. 

  128. <dl class="params"><dt>Parameters</dt><dd>
    129. 

  129.   <table class="params">
    130. 

  130.     <tr><td class="paramtype">string</td><td class="paramname">$url</td><td>The URL that will receive the params. </td></tr>
    131. 

  131.     <tr><td class="paramtype">array</td><td class="paramname">$newParams</td><td>The params to append to the URL.</td></tr>
    132. 

  132.   </table>
    133. 

  133.   </dd>
    134. 

  134. </dl>
    135. 

  135. <dl class="section return"><dt>Returns</dt><dd>string </dd></dl>
    136. 

  136. 

  137. </div>
    138. 

  138. </div>
    139. 

  139. <a id="aa714a9170567de719a7042e842abe1d1"></a>
    140. 

  140. <h2 class="memtitle"><span class="permalink"><a href="#aa714a9170567de719a7042e842abe1d1">&#9670;&nbsp;</a></span>baseGraphUrlEndpoint()</h2>
    141. 

  141. 

  142. <div class="memitem">
    143. 

  143. <div class="memproto">
    144. 

  144. <table class="mlabels">
    145. 

  145.   <tr>
    146. 

  146.   <td class="mlabels-left">
    147. 

  147.       <table class="memname">
    148. 

  148.         <tr>
    149. 

  149.           <td class="memname">static baseGraphUrlEndpoint </td>
    150. 

  150.           <td>(</td>
    151. 

  151.           <td class="paramtype">&#160;</td>
    152. 

  152.           <td class="paramname"><em>$urlToTrim</em></td><td>)</td>
    153. 

  153.           <td></td>
    154. 

  154.         </tr>
    155. 

  155.       </table>
    156. 

  156.   </td>
    157. 

  157.   <td class="mlabels-right">
    158. 

  158. <span class="mlabels"><span class="mlabel">static</span></span>  </td>
    159. 

  159.   </tr>
    160. 

  160. </table>
    161. 

  161. </div><div class="memdoc">
    162. 

  162. <p>Trims off the hostname and Graph version from a URL.</p>
    163. 

  163. <dl class="params"><dt>Parameters</dt><dd>
    164. 

  164.   <table class="params">
    165. 

  165.     <tr><td class="paramtype">string</td><td class="paramname">$urlToTrim</td><td>The URL the needs the surgery.</td></tr>
    166. 

  166.   </table>
    167. 

  167.   </dd>
    168. 

  168. </dl>
    169. 

  169. <dl class="section return"><dt>Returns</dt><dd>string The $urlToTrim with the hostname and Graph version removed. </dd></dl>
    170. 

  170. 

  171. </div>
    172. 

  172. </div>
    173. 

  173. <a id="ade221e200b8ff2a755b36e205a60c7be"></a>
    174. 

  174. <h2 class="memtitle"><span class="permalink"><a href="#ade221e200b8ff2a755b36e205a60c7be">&#9670;&nbsp;</a></span>forceSlashPrefix()</h2>
    175. 

  175. 

  176. <div class="memitem">
    177. 

  177. <div class="memproto">
    178. 

  178. <table class="mlabels">
    179. 

  179.   <tr>
    180. 

  180.   <td class="mlabels-left">
    181. 

  181.       <table class="memname">
    182. 

  182.         <tr>
    183. 

  183.           <td class="memname">static forceSlashPrefix </td>
    184. 

  184.           <td>(</td>
    185. 

  185.           <td class="paramtype">&#160;</td>
    186. 

  186.           <td class="paramname"><em>$string</em></td><td>)</td>
    187. 

  187.           <td></td>
    188. 

  188.         </tr>
    189. 

  189.       </table>
    190. 

  190.   </td>
    191. 

  191.   <td class="mlabels-right">
    192. 

  192. <span class="mlabels"><span class="mlabel">static</span></span>  </td>
    193. 

  193.   </tr>
    194. 

  194. </table>
    195. 

  195. </div><div class="memdoc">
    196. 

  196. <p>Check for a "/" prefix and prepend it if not exists.</p>
    197. 

  197. <dl class="params"><dt>Parameters</dt><dd>
    198. 

  198.   <table class="params">
    199. 

  199.     <tr><td class="paramtype">string&#160;|&#160;null</td><td class="paramname">$string</td><td></td></tr>
    200. 

  200.   </table>
    201. 

  201.   </dd>
    202. 

  202. </dl>
    203. 

  203. <dl class="section return"><dt>Returns</dt><dd>string|null </dd></dl>
    204. 

  204. 

  205. </div>
    206. 

  206. </div>
    207. 

  207. <a id="a99fdc16a8923c1000e6cb9f17786a576"></a>
    208. 

  208. <h2 class="memtitle"><span class="permalink"><a href="#a99fdc16a8923c1000e6cb9f17786a576">&#9670;&nbsp;</a></span>getParamsAsArray()</h2>
    209. 

  209. 

  210. <div class="memitem">
    211. 

  211. <div class="memproto">
    212. 

  212. <table class="mlabels">
    213. 

  213.   <tr>
    214. 

  214.   <td class="mlabels-left">
    215. 

  215.       <table class="memname">
    216. 

  216.         <tr>
    217. 

  217.           <td class="memname">static getParamsAsArray </td>
    218. 

  218.           <td>(</td>
    219. 

  219.           <td class="paramtype">&#160;</td>
    220. 

  220.           <td class="paramname"><em>$url</em></td><td>)</td>
    221. 

  221.           <td></td>
    222. 

  222.         </tr>
    223. 

  223.       </table>
    224. 

  224.   </td>
    225. 

  225.   <td class="mlabels-right">
    226. 

  226. <span class="mlabels"><span class="mlabel">static</span></span>  </td>
    227. 

  227.   </tr>
    228. 

  228. </table>
    229. 

  229. </div><div class="memdoc">
    230. 

  230. <p>Returns the params from a URL in the form of an array.</p>
    231. 

  231. <dl class="params"><dt>Parameters</dt><dd>
    232. 

  232.   <table class="params">
    233. 

  233.     <tr><td class="paramtype">string</td><td class="paramname">$url</td><td>The URL to parse the params from.</td></tr>
    234. 

  234.   </table>
    235. 

  235.   </dd>
    236. 

  236. </dl>
    237. 

  237. <dl class="section return"><dt>Returns</dt><dd>array </dd></dl>
    238. 

  238. 

  239. </div>
    240. 

  240. </div>
    241. 

  241. <a id="a5634731b5b4b64ffb92c07c21cc78669"></a>
    242. 

  242. <h2 class="memtitle"><span class="permalink"><a href="#a5634731b5b4b64ffb92c07c21cc78669">&#9670;&nbsp;</a></span>mergeUrlParams()</h2>
    243. 

  243. 

  244. <div class="memitem">
    245. 

  245. <div class="memproto">
    246. 

  246. <table class="mlabels">
    247. 

  247.   <tr>
    248. 

  248.   <td class="mlabels-left">
    249. 

  249.       <table class="memname">
    250. 

  250.         <tr>
    251. 

  251.           <td class="memname">static mergeUrlParams </td>
    252. 

  252.           <td>(</td>
    253. 

  253.           <td class="paramtype">&#160;</td>
    254. 

  254.           <td class="paramname"><em>$urlToStealFrom</em>, </td>
    255. 

  255.         </tr>
    256. 

  256.         <tr>
    257. 

  257.           <td class="paramkey"></td>
    258. 

  258.           <td></td>
    259. 

  259.           <td class="paramtype">&#160;</td>
    260. 

  260.           <td class="paramname"><em>$urlToAddTo</em>&#160;</td>
    261. 

  261.         </tr>
    262. 

  262.         <tr>
    263. 

  263.           <td></td>
    264. 

  264.           <td>)</td>
    265. 

  265.           <td></td><td></td>
    266. 

  266.         </tr>
    267. 

  267.       </table>
    268. 

  268.   </td>
    269. 

  269.   <td class="mlabels-right">
    270. 

  270. <span class="mlabels"><span class="mlabel">static</span></span>  </td>
    271. 

  271.   </tr>
    272. 

  272. </table>
    273. 

  273. </div><div class="memdoc">
    274. 

  274. <p>Adds the params of the first URL to the second URL.</p>
    275. 

  275. <p>Any params that already exist in the second URL will go untouched.</p>
    276. 

  276. <dl class="params"><dt>Parameters</dt><dd>
    277. 

  277.   <table class="params">
    278. 

  278.     <tr><td class="paramtype">string</td><td class="paramname">$urlToStealFrom</td><td>The URL harvest the params from. </td></tr>
    279. 

  279.     <tr><td class="paramtype">string</td><td class="paramname">$urlToAddTo</td><td>The URL that will receive the new params.</td></tr>
    280. 

  280.   </table>
    281. 

  281.   </dd>
    282. 

  282. </dl>
    283. 

  283. <dl class="section return"><dt>Returns</dt><dd>string The $urlToAddTo with any new params from $urlToStealFrom. </dd></dl>
    284. 

  284. 

  285. </div>
    286. 

  286. </div>
    287. 

  287. <a id="a1c2c5e7054a2e6493476364d8d902b05"></a>
    288. 

  288. <h2 class="memtitle"><span class="permalink"><a href="#a1c2c5e7054a2e6493476364d8d902b05">&#9670;&nbsp;</a></span>removeParamsFromUrl()</h2>
    289. 

  289. 

  290. <div class="memitem">
    291. 

  291. <div class="memproto">
    292. 

  292. <table class="mlabels">
    293. 

  293.   <tr>
    294. 

  294.   <td class="mlabels-left">
    295. 

  295.       <table class="memname">
    296. 

  296.         <tr>
    297. 

  297.           <td class="memname">static removeParamsFromUrl </td>
    298. 

  298.           <td>(</td>
    299. 

  299.           <td class="paramtype">&#160;</td>
    300. 

  300.           <td class="paramname"><em>$url</em>, </td>
    301. 

  301.         </tr>
    302. 

  302.         <tr>
    303. 

  303.           <td class="paramkey"></td>
    304. 

  304.           <td></td>
    305. 

  305.           <td class="paramtype">array&#160;</td>
    306. 

  306.           <td class="paramname"><em>$paramsToFilter</em>&#160;</td>
    307. 

  307.         </tr>
    308. 

  308.         <tr>
    309. 

  309.           <td></td>
    310. 

  310.           <td>)</td>
    311. 

  311.           <td></td><td></td>
    312. 

  312.         </tr>
    313. 

  313.       </table>
    314. 

  314.   </td>
    315. 

  315.   <td class="mlabels-right">
    316. 

  316. <span class="mlabels"><span class="mlabel">static</span></span>  </td>
    317. 

  317.   </tr>
    318. 

  318. </table>
    319. 

  319. </div><div class="memdoc">
    320. 

  320. <p>Remove params from a URL.</p>
    321. 

  321. <dl class="params"><dt>Parameters</dt><dd>
    322. 

  322.   <table class="params">
    323. 

  323.     <tr><td class="paramtype">string</td><td class="paramname">$url</td><td>The URL to filter. </td></tr>
    324. 

  324.     <tr><td class="paramtype">array</td><td class="paramname">$paramsToFilter</td><td>The params to filter from the URL.</td></tr>
    325. 

  325.   </table>
    326. 

  326.   </dd>
    327. 

  327. </dl>
    328. 

  328. <dl class="section return"><dt>Returns</dt><dd>string The URL with the params removed. </dd></dl>
    329. 

  329. 

  330. </div>
    331. 

  331. </div>
    332. 

  332. <hr/>The documentation for this class was generated from the following file:<ul>
    333. 

  333. <li>src/Facebook/Url/<a class="el" href="_facebook_url_manipulator_8php.html">FacebookUrlManipulator.php</a></li>
    334. 

  334. </ul>
    335. 

  335. </div><!-- contents -->
    336. 

  336. <!-- start footer part -->
    337. 

  337. <hr class="footer"/><address class="footer"><small>
    338. 

  338. Generated by &#160;<a href="http://www.doxygen.org/index.html">
    339. 

  339. <img class="footer" src="doxygen.png" alt="doxygen"/>
    340. 

  340. </a> 1.8.14
    341. 

  341. </small></address>
    342. 

  342. </body>
    343. 

  343. </html>
    344. 

  344.