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

/docs/class-ESIterator.md

https://bitbucket.org/evsmusic/esiterator
Markdown | 399 lines | 248 code | 151 blank | 0 comment | 0 complexity | 5d4e7e9dd8d6c03eb761ecd6d2b0cc2c MD5 | raw file
    

  1. <!DOCTYPE html>
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

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

  5. 	<meta name="generator" content="ApiGen 2.8.0" />
    6. 

  6. 

  7. 	<title>Class ESIterator | ESIterator</title>
    8. 

  8. 

  9. 	<script type="text/javascript" src="resources/combined.js?2056212191"></script>
    10. 

  10. 	<script type="text/javascript" src="elementlist.js?4127875162"></script>
    11. 

  11. 	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
    12. 

  12. 

  13. </head>
    14. 

  14. 

  15. <body>
    16. 

  16. <div id="left">
    17. 

  17. 	<div id="menu">
    18. 

  18. 		<a href="readme.md" title="Overview"><span>Overview</span></a>
    19. 

  19. 

  20. 

  21. 		<div id="groups">
    22. 

  22. 		</div>
    23. 

  23. 

  24. 

  25. 

  26. 		<div id="elements">
    27. 

  27. 			<h3>Classes</h3>
    28. 

  28. 			<ul>
    29. 

  29. 				<li class="active"><a href="class-ESIterator.md">ESIterator</a></li>
    30. 

  30. 				<li><a href="class-ESIteratorException.md">ESIteratorException</a></li>
    31. 

  31. 			</ul>
    32. 

  32. 

  33. 

  34. 

  35. 

  36. 

  37. 		</div>
    38. 

  38. 	</div>
    39. 

  39. </div>
    40. 

  40. 

  41. <div id="splitter"></div>
    42. 

  42. 

  43. <div id="right">
    44. 

  44. <div id="rightInner">
    45. 

  45. 	<form id="search">
    46. 

  46. 		<input type="hidden" name="cx" value="" />
    47. 

  47. 		<input type="hidden" name="ie" value="UTF-8" />
    48. 

  48. 		<input type="text" name="q" class="text" />
    49. 

  49. 		<input type="submit" value="Search" />
    50. 

  50. 	</form>
    51. 

  51. 

  52. 	<div id="navigation">
    53. 

  53. 		<ul>
    54. 

  54. 			<li>
    55. 

  55. 				<a href="readme.md" title="Overview"><span>Overview</span></a>
    56. 

  56. 			</li>
    57. 

  57. 			<li class="active">
    58. 

  58. <span>Class</span>			</li>
    59. 

  59. 		</ul>
    60. 

  60. 		<ul>
    61. 

  61. 			<li>
    62. 

  62. 				<a href="tree.md" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
    63. 

  63. 			</li>
    64. 

  64. 		</ul>
    65. 

  65. 		<ul>
    66. 

  66. 		</ul>
    67. 

  67. 	</div>
    68. 

  68. 

  69. <div id="content" class="class">
    70. 

  70. 	<h1>Class ESIterator</h1>
    71. 

  71. 

  72. 

  73. 

  74. 

  75. 

  76. 

  77. 

  78. 

  79. 

  80. 

  81. 

  82. 	<div class="info">
    83. 

  83. 		
    84. 

  84. 		
    85. 

  85. 		
    86. 

  86. 		
    87. 

  87. 

  88. 				<b>Copyright:</b>
    89. 

  89. 				(c) 2013, RED STAR design<br />
    90. 

  90. 				<b>Author:</b>
    91. 

  91. 				Edward Stock &lt;<a
    92. 

  92. href="mailto:edward.vstock&#64;gmail.com">edward.vstock&#64;<!---->gmail.com</a>&gt;<br />
    93. 

  93. 		<b>Located at</b> <a href="source-class-ESIterator.md#8-307" title="Go to source code">helpers/ESIterator.php</a><br />
    94. 

  94. 	</div>
    95. 

  95. 

  96. 

  97. 

  98. 	<table class="summary" id="methods">
    99. 

  99. 	<caption>Methods summary</caption>
    100. 

  100. 	<tr data-order="getLevels" id="_getLevels">
    101. 

  101. 

  102. 		<td class="attributes"><code>
    103. 

  103. 			 public static
    104. 

  104. 			array
    105. 

  105. 			
    106. 

  106. 			</code>
    107. 

  107. 		</td>
    108. 

  108. 

  109. 		<td class="name"><div>
    110. 

  110. 		<a class="anchor" href="#_getLevels">#</a>
    111. 

  111. 		<code><a href="source-class-ESIterator.md#131-153" title="Go to source code">getLevels</a>( <span>string <var>$className</var></span> )</code>
    112. 

  112. 

  113. 		<div class="description short">
    114. 

  114. 			
    115. 

  115. <p>Генерируем многоуровнеый
    116. 

  116. отсортированный массив. Применимо как для
    117. 

  117. всяких категорий так и для пунктов меню.
    118. 

  118. Главное требование - таблица должна иметь 3
    119. 

  119. обязательных поля: <code>int parent_id, int level, string
    120. 

  120. title</code></p>
    121. 

  121. 

  122. 		</div>
    123. 

  123. 

  124. 		<div class="description detailed hidden">
    125. 

  125. 			
    126. 

  126. <p>Генерируем многоуровнеый
    127. 

  127. отсортированный массив. Применимо как для
    128. 

  128. всяких категорий так и для пунктов меню.
    129. 

  129. Главное требование - таблица должна иметь 3
    130. 

  130. обязательных поля: <code>int parent_id, int level, string
    131. 

  131. title</code></p>
    132. 

  132. 

  133. <p>Можно смело использовать вместо
    134. 

  134. <code>CHtml::listData(&lt;span
    135. 

  135. class="php-keyword1"&gt;Class&lt;/span&gt;::model()-&gt;findAll(),&lt;span
    136. 

  136. class="php-quote"&gt;'id'&lt;/span&gt;,&lt;span
    137. 

  137. class="php-quote"&gt;'title'&lt;/span&gt;)</code></p>
    138. 

  138. 

  139. 

  140. 

  141. 				<h4>Parameters</h4>
    142. 

  142. 				<div class="list"><dl>
    143. 

  143. 					<dt><var>$className</var></dt>
    144. 

  144. 					<dd><code>string</code><br>$className Имя класса AR.</dd>
    145. 

  145. 				</dl></div>
    146. 

  146. 

  147. 				<h4>Returns</h4>
    148. 

  148. 				<div class="list">
    149. 

  149. 					<code>array</code><br><code>id=&gt;title</code><br />
    150. 

  150. 				</div>
    151. 

  151. 

  152. 				<h4>Throws</h4>
    153. 

  153. 				<div class="list">
    154. 

  154. 					<code><code><a href="class-ESIteratorException.md">ESIteratorException</a></code></code><br>если поле 'level' отсутствует в таблице, то
    155. 

  155. метод выбросит исключение<br />
    156. 

  156. 				</div>
    157. 

  157. 

  158. 

  159. 

  160. 		</div>
    161. 

  161. 		</div></td>
    162. 

  162. 	</tr>
    163. 

  163. 	<tr data-order="getForDataProvider" id="_getForDataProvider">
    164. 

  164. 

  165. 		<td class="attributes"><code>
    166. 

  166. 			 public static
    167. 

  167. 			array
    168. 

  168. 			
    169. 

  169. 			</code>
    170. 

  170. 		</td>
    171. 

  171. 

  172. 		<td class="name"><div>
    173. 

  173. 		<a class="anchor" href="#_getForDataProvider">#</a>
    174. 

  174. 		<code><a href="source-class-ESIterator.md#156-174" title="Go to source code">getForDataProvider</a>( <span>string <var>$className</var></span> )</code>
    175. 

  175. 

  176. 		<div class="description short">
    177. 

  177. 			
    178. 

  178. <p>Итерирует пункты меню для CGridView через
    179. 

  179. итератор CArrayDataProvider. Использовать в
    180. 

  180. CArrayDataProvider, так так метод возвращает
    181. 

  181. массив</p>
    182. 

  182. 

  183. 		</div>
    184. 

  184. 

  185. 		<div class="description detailed hidden">
    186. 

  186. 			
    187. 

  187. <p>Итерирует пункты меню для CGridView через
    188. 

  188. итератор CArrayDataProvider. Использовать в
    189. 

  189. CArrayDataProvider, так так метод возвращает
    190. 

  190. массив</p>
    191. 

  191. 

  192. 

  193. 

  194. 				<h4>Parameters</h4>
    195. 

  195. 				<div class="list"><dl>
    196. 

  196. 					<dt><var>$className</var></dt>
    197. 

  197. 					<dd><code>string</code><br>$className имя класса CActiveRecord</dd>
    198. 

  198. 				</dl></div>
    199. 

  199. 

  200. 				<h4>Returns</h4>
    201. 

  201. 				<div class="list">
    202. 

  202. 					<code>array</code><br />
    203. 

  203. 				</div>
    204. 

  204. 

  205. 

  206. 

  207. 

  208. 		</div>
    209. 

  209. 		</div></td>
    210. 

  210. 	</tr>
    211. 

  211. 	<tr data-order="setNewLevel" id="_setNewLevel">
    212. 

  212. 

  213. 		<td class="attributes"><code>
    214. 

  214. 			 public static
    215. 

  215. 			integer
    216. 

  216. 			
    217. 

  217. 			</code>
    218. 

  218. 		</td>
    219. 

  219. 

  220. 		<td class="name"><div>
    221. 

  221. 		<a class="anchor" href="#_setNewLevel">#</a>
    222. 

  222. 		<code><a href="source-class-ESIterator.md#189-208" title="Go to source code">setNewLevel</a>( <span>object <var>$model</var></span> )</code>
    223. 

  223. 

  224. 		<div class="description short">
    225. 

  225. 			
    226. 

  226. <p>Устанавливает новый уровень в
    227. 

  227. соответствии с родителем</p>
    228. 

  228. 

  229. 		</div>
    230. 

  230. 

  231. 		<div class="description detailed hidden">
    232. 

  232. 			
    233. 

  233. <p>Устанавливает новый уровень в
    234. 

  234. соответствии с родителем</p>
    235. 

  235. 

  236. 

  237. 

  238. 				<h4>Parameters</h4>
    239. 

  239. 				<div class="list"><dl>
    240. 

  240. 					<dt><var>$model</var></dt>
    241. 

  241. 					<dd><code>object</code><br>$model Указатель текущего класса {$this}</dd>
    242. 

  242. 				</dl></div>
    243. 

  243. 

  244. 				<h4>Returns</h4>
    245. 

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

  246. 					<code>integer</code><br />
    247. 

  247. 				</div>
    248. 

  248. 

  249. 

  250. 

  251. 

  252. 		</div>
    253. 

  253. 		</div></td>
    254. 

  254. 	</tr>
    255. 

  255. 	<tr data-order="getForMenu" id="_getForMenu">
    256. 

  256. 

  257. 		<td class="attributes"><code>
    258. 

  258. 			 public static
    259. 

  259. 			
    260. 

  260. 			
    261. 

  261. 			</code>
    262. 

  262. 		</td>
    263. 

  263. 

  264. 		<td class="name"><div>
    265. 

  265. 		<a class="anchor" href="#_getForMenu">#</a>
    266. 

  266. 		<code><a href="source-class-ESIterator.md#214-233" title="Go to source code">getForMenu</a>( <span>mixed <var>$className</var></span> )</code>
    267. 

  267. 

  268. 		<div class="description short">
    269. 

  269. 			
    270. 

  270. 		</div>
    271. 

  271. 

  272. 		<div class="description detailed hidden">
    273. 

  273. 			
    274. 

  274. 

  275. 

  276. 

  277. 

  278. 

  279. 

  280. 

  281. 		</div>
    282. 

  282. 		</div></td>
    283. 

  283. 	</tr>
    284. 

  284. 	<tr data-order="__destruct" id="___destruct">
    285. 

  285. 

  286. 		<td class="attributes"><code>
    287. 

  287. 			 public 
    288. 

  288. 			
    289. 

  289. 			
    290. 

  290. 			</code>
    291. 

  291. 		</td>
    292. 

  292. 

  293. 		<td class="name"><div>
    294. 

  294. 		<a class="anchor" href="#___destruct">#</a>
    295. 

  295. 		<code><a href="source-class-ESIterator.md#304-306" title="Go to source code">__destruct</a>( )</code>
    296. 

  296. 

  297. 		<div class="description short">
    298. 

  298. 			
    299. 

  299. 		</div>
    300. 

  300. 

  301. 		<div class="description detailed hidden">
    302. 

  302. 			
    303. 

  303. 

  304. 

  305. 

  306. 

  307. 

  308. 

  309. 

  310. 		</div>
    311. 

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

  312. 	</tr>
    313. 

  313. 	</table>
    314. 

  314. 

  315. 

  316. 

  317. 

  318. 

  319. 

  320. 

  321. 

  322. 

  323. 

  324. 

  325. 

  326. 	<table class="summary" id="properties">
    327. 

  327. 	<caption>Properties summary</caption>
    328. 

  328. 	<tr data-order="startLine" id="$startLine">
    329. 

  329. 		<td class="attributes"><code>
    330. 

  330. 			public static 
    331. 

  331. 			string
    332. 

  332. 		</code></td>
    333. 

  333. 

  334. 		<td class="name">
    335. 

  335. 				<a href="source-class-ESIterator.md#25-29" title="Go to source code"><var>$startLine</var></a>
    336. 

  336. 		</td>
    337. 

  337. 		<td class="value"><code><span class="php-quote">' | '</span></code></td>
    338. 

  338. 		<td class="description"><div>
    339. 

  339. 			<a href="#$startLine" class="anchor">#</a>
    340. 

  340. 

  341. 			<div class="description short">
    342. 

  342. 				
    343. 

  343. <p>Линия начального (первого) уровня
    344. 

  344. пункта</p>
    345. 

  345. 

  346. 			</div>
    347. 

  347. 

  348. 			<div class="description detailed hidden">
    349. 

  349. 				
    350. 

  350. <p>Линия начального (первого) уровня
    351. 

  351. пункта</p>
    352. 

  352. 

  353. 

  354. 			</div>
    355. 

  355. 		</div></td>
    356. 

  356. 	</tr>
    357. 

  357. 	<tr data-order="continousLine" id="$continousLine">
    358. 

  358. 		<td class="attributes"><code>
    359. 

  359. 			public static 
    360. 

  360. 			string
    361. 

  361. 		</code></td>
    362. 

  362. 

  363. 		<td class="name">
    364. 

  364. 				<a href="source-class-ESIterator.md#31-35" title="Go to source code"><var>$continousLine</var></a>
    365. 

  365. 		</td>
    366. 

  366. 		<td class="value"><code><span class="php-quote">' -- '</span></code></td>
    367. 

  367. 		<td class="description"><div>
    368. 

  368. 			<a href="#$continousLine" class="anchor">#</a>
    369. 

  369. 

  370. 			<div class="description short">
    371. 

  371. 				
    372. 

  372. <p>Линия остальных пунктов</p>
    373. 

  373. 

  374. 			</div>
    375. 

  375. 

  376. 			<div class="description detailed hidden">
    377. 

  377. 				
    378. 

  378. <p>Линия остальных пунктов</p>
    379. 

  379. 

  380. 

  381. 			</div>
    382. 

  382. 		</div></td>
    383. 

  383. 	</tr>
    384. 

  384. 	</table>
    385. 

  385. 

  386. 

  387. 

  388. 

  389. 

  390. 

  391. </div>
    392. 

  392. 

  393. 	<div id="footer">
    394. 

  394. 		ESIterator API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
    395. 

  395. 	</div>
    396. 

  396. </div>
    397. 

  397. </div>
    398. 

  398. </body>
    399. 

  399. </html>
    400. 

  400.