/plugins/PHPParser/tags/PHPParser-1.3.0/docs/PHPParser.html

# · HTML · 302 lines · 283 code · 19 blank · 0 comment · 0 complexity · e23f0806c3e653d9af9be4b23ccb7cc1 MD5 · raw file 

    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

  4. 	<meta http-equiv="Content-Type"
    5. 

  5. 	      content="text/html; charset=iso-8859-1">
    6. 

  6. 	<meta name="Author" content="Matthieu Casanova">
    7. 

  7. 	<title>PHPParser Plugin</title>
    8. 

  8. </head>
    9. 

  9. 

  10. <body>
    11. 

  11. <table border="0" cellspacing="0" width="100%" bgcolor="#ccccff">
    12. 

  12. 	<tr>
    13. 

  13. 		<td valign="top" style="font-weight:bold;font-size:x-large">PHP Parser</td>
    14. 

  14. 		<td align="right" valign="top" style="font-size:small">
    15. 

  15. 			<span style="font-weight:bold">Version 1.3.0 (Sep 07, 2010)</span><br>
    16. 

  16. 			Matthieu Casanova &lt;chocolat.mou@gmail.com&gt;&nbsp;
    17. 

  17. 		</td>
    18. 

  18. 	</tr>
    19. 

  19. </table>
    20. 

  20. <h2>Introduction</h2>
    21. 

  21. 

  22. <p>In the beginning of 2003 I found the <b>phpeclipse</b> project, a plugin to do php in <b>Eclipse</b>.
    23. 

  23. 	I worked on it, and finaly wrote an alternative php parser for the project.
    24. 

  24. 	The matter is that I don't like SWT very much so when I discovered discovered jEdit
    25. 

  25. 	I loved it. So I decided to write a plugin using my php parser.
    26. 

  26. 	It uses ErrorList plugin to show the errors and Sidekick plugin to manage parser.
    27. 

  27. </p>
    28. 

  28. 

  29. <h2>Usage</h2>
    30. 

  30. 

  31. <h3>Parsing</h3>
    32. 

  32. 

  33. <p>
    34. 

  34. 	The parser is now launched by Sidekick plugin. You can ask to reparse the file with the "parse buffer" action of
    35. 

  35. 	Sidekick.
    36. 

  36. 	You can choose to enable parse on keystroke within Sidekick, it should be slower, but with good computer there
    37. 

  37. 	will be
    38. 

  38. 	no problem.
    39. 

  39. 	It supports php5 if you activate it in the options panel.
    40. 

  40. </p>
    41. 

  41. 

  42. <h3>Project management</h3>
    43. 

  43. 

  44. <p>
    45. 

  45. 	The project management is a feature that will allow you to describe a project. A project is a group of files
    46. 

  46. 	(under a
    47. 

  47. 	root folder). It supports VFS so you can
    48. 

  48. 	have a root on a ftp for example. To manage project please open the dockable view.
    49. 

  49. 	When you create a project you'll have to choose a root folder. After that, click on the "reparse" button. It
    50. 

  50. 	will
    51. 

  51. 	parse all php files in your project
    52. 

  52. 	and keep track of them in memory (you can show the parsing progress in the jEdit's IO threads). Of course, each
    53. 

  53. 	time
    54. 

  54. 	you'll open a file in your project and
    55. 

  55. 	work on it, this file will be updated in the project memory. But only files under your root will be added.
    56. 

  56. 	This feature will be useful for code completion (there is a little but I hope I'll add a lot more after), and
    57. 

  57. 	for code
    58. 

  58. 	browsing
    59. 

  59. </p>
    60. 

  60. 

  61. <h3>Code Browsing</h3>
    62. 

  62. The parser will provide a Sidekick structure view of you file, to show it, use the "Structure browser" of Sidekick
    63. 

  63. plugin.
    64. 

  64. There are also 3 actions to browse php code : Find class, Find method and Find in file. Those actions will work if you
    65. 

  65. have a project up to date.
    66. 

  66. It will display a small dialog working like OpenIt plugin (I took a lot of ideas from this plugin), and you'll be able
    67. 

  67. to do incremental search on classes, methods,
    68. 

  68. displaying a little list of matching class or methods (depends on action you choosed). When you select one, the file
    69. 

  69. will be opened at the good position.
    70. 

  70. <h3>Code completion</h3>
    71. 

  71. 

  72. <p>
    73. 

  73. 	I added some code completion, but it doesn't work very well for the moment. To enable it, please use the action
    74. 

  74. 	"Show
    75. 

  75. 	completion popup" from Sidekick.
    76. 

  76. 	There are completion after the following situation :
    77. 

  77. <ul>
    78. 

  78. 	<li><b>extends</b></li>
    79. 

  79. 	<li><b>new </b></li>
    80. 

  80. 	<li><b>$this-></b></li>
    81. 

  81. 	<li><b>AnyClass::</b></li>
    82. 

  82. </ul>
    83. 

  83. The completion will work better with a project too, for example after <b>new</b> and <b>extends</b>, I will display
    84. 

  84. all classes in the project.
    85. 

  85. After <b>$this-></b> I'll display methods and fields of the class and superclasses.
    86. 

  86. After <b>AnyClass::</b> I'll display methods of the class and superclasses ...
    87. 

  87. </p>
    88. 

  88. 

  89. <h3>Code analysis</h3>
    90. 

  90. 

  91. <p>
    92. 

  92. 	There are some code analysis but you should be very careful because it's far from being perfect. If a variable
    93. 

  93. 	is
    94. 

  94. 	given to a
    95. 

  95. 	method and is assigned by reference, the parser will not know that and report it as variable used but not
    96. 

  96. 	assigned ...
    97. 

  97. </p>
    98. 

  98. 

  99. <h2>History</h2>
    100. 

  100. <ul>
    101. 

  101. 	<li>1.3.0</li>
    102. 

  102. 	<ul>
    103. 

  103.         <li><ul>Dropped specific php 4 support.</ul></li>
    104. 

  104. 		<li>Features
    105. 

  105. 			<ul>
    106. 

  106. 				<li>conditional expression (ternary/elvis) inspection :
    107. 

  107. 					a warning is created if true and false value are the same
    108. 

  108. 				(very limited check).</li>
    109. 

  109.                 <li>Added a warning when having $$ in code. While it may be wanted, it is usually a bug.</li>
    110. 

  110.                 <li>Updated to use JavaCC 5.0.</li>
    111. 

  111. 			</ul>
    112. 

  112. 		</li>
    113. 

  113. 		<li>Bugs fixed</li>
    114. 

  114. 		<ul>
    115. 

  115. 			<li>Fixed parsing of use($x,...) in closure declaration</li>
    116. 

  116. 			<li>fixed parsing of variables in String (#2935111)</li>
    117. 

  117. 			<li>exception during parsing of $ in strings that happens sometimes (#2897416)</li>
    118. 

  118. 			<li>added short ternary operator ($a = $b ?:$c) (#2461597)</li>
    119. 

  119. 			<li>several parsing bug in class declaration</li>
    120. 

  120. 			<li>several parsing bug in double quoted strings (#2944017)</li>
    121. 

  121. 			<li>fixes in heredoc (#2855209)</li>
    122. 

  122. 			<li>better type detection for cast expressions</li>
    123. 

  123. 		</ul>
    124. 

  124. 	</ul>
    125. 

  125. 	<li>1.2.7</li>
    126. 

  126. 	<ul>
    127. 

  127. 		<li>Bugs fixed</li>
    128. 

  128. 		<ul>
    129. 

  129. 			<li>Added basic namespace keyword support</li>
    130. 

  130. 			<li>Allow $this->return syntax</li>
    131. 

  131. 			<li>fixed an exception when parsing interface declaration (#1910321)</li>
    132. 

  132. 			<li>the variables used in &lt;?=$tutu?&gt; were ignored by code analysis</li>
    133. 

  133. 			<li>Fixed chained method call syntax (#2854175)</li>
    134. 

  134. 			<li>The parser now accept methods with name = null (#2849929)</li>
    135. 

  135. 			<li>closure parsing support (#2461603)</li>
    136. 

  136. 		</ul>
    137. 

  137. 	</ul>
    138. 

  138. 

  139. 	<li>1.2.6</li>
    140. 

  140. 	<ul>
    141. 

  141. 		<li>Bugs fixed</li>
    142. 

  142. 		<ul>
    143. 

  143. 			<li>public static method() declaration in interface (#1910321)</li>
    144. 

  144. 			<li>Wrong use check of variables in "instanceof" expression (#1739752)</li>
    145. 

  145. 			<li>"default" keyword confuses the parser (#1891144)</li>
    146. 

  146. 			<li>it is now allowed to extends Object (#2318629)</li>
    147. 

  147. 		</ul>
    148. 

  148. 	</ul>
    149. 

  149. 

  150. 	<li>1.2.5</li>
    151. 

  151. 	<ul>
    152. 

  152. 		<li>Bugs fixed</li>
    153. 

  153. 		<ul>
    154. 

  154. 			<li>loading project where several classes have the same name</li>
    155. 

  155. 			<li>Wrong use check of variables in "instanceof" expression (#1739752)</li>
    156. 

  156. 			<li>"default" keyword confuses the parser (#1891144)</li>
    157. 

  157. 		</ul>
    158. 

  158. 	</ul>
    159. 

  159. 	<li>1.2.4</li>
    160. 

  160. 	<ul>
    161. 

  161. 		<li>Bugs fixed</li>
    162. 

  162. 		<ul>
    163. 

  163. 			<li>clone keyword support</li>
    164. 

  164. 			<li>1535949 fixed : default method call type was String, it is now Unknown</li>
    165. 

  165. 			<li>syntax class::constant</li>
    166. 

  166. 		</ul>
    167. 

  167. 		<li>Changes</li>
    168. 

  168. 		<ul>
    169. 

  169. 			<li>Quick search sorted by name length (this is better now :)</li>
    170. 

  170. 		</ul>
    171. 

  171. 	</ul>
    172. 

  172. </ul>
    173. 

  173. <ul>
    174. 

  174. 	<li>1.2.3</li>
    175. 

  175. 	<ul>
    176. 

  176. 		<li>Bugs fixed</li>
    177. 

  177. 		<ul>
    178. 

  178. 			<li>better modifier parsing</li>
    179. 

  179. 			<li>a bug fixed in code analysis of try statements</li>
    180. 

  180. 			<li>some bugs fixed in dockable panel</li>
    181. 

  181. 			<li>1458668 fixed (&lt; while ($a) : ?&gt;blabla&lt;?endwhile;?&gt;</li>
    182. 

  182. 			<li>1432935 fixed</li>
    183. 

  183. 			<li>1489533 fixed (const keyword)</li>
    184. 

  184. 			<li>Syntax like TR_TreeAction::getInstance('containers')->isRoot(5); fixed</li>
    185. 

  185. 			<li>several fields declared in the same likes is now allowed in php 5</li>
    186. 

  186. 		</ul>
    187. 

  187. 	</ul>
    188. 

  188. </ul>
    189. 

  189. <ul>
    190. 

  190. 	<li>1.2.2</li>
    191. 

  191. 	<ul>
    192. 

  192. 		<li>Missing '?>' is now reported as warning and can be deactivated in the options</li>
    193. 

  193. 		<li>Better code completion handling for interfaces</li>
    194. 

  194. 		<li>&lt;?xml token is now ignored (I think if you put such token, your php.ini config will only accept
    195. 

  195. 			&lt;?php for
    196. 

  196. 			starting php scripts
    197. 

  197. 		</li>
    198. 

  198. 		<li>Bugs fixed</li>
    199. 

  199. 		<ul>
    200. 

  200. 			<li>php 5 : better handling of type of the method parameters (array and several other keywords
    201. 

  201. 				are now allowed)
    202. 

  202. 			</li>
    203. 

  203. 			<li>Class access are allowed after method calls ( $a->test()->tutu() )</li>
    204. 

  204. 			<li>Interfaces can now extends several interfaces</li>
    205. 

  205. 			<li>1378327 fixed</li>
    206. 

  206. 			<li>981809 fixed</li>
    207. 

  207. 			<li>1066608 fixed</li>
    208. 

  208. 			<li>1368690 fixed : syntax like if ($a && $b = 3)</li>
    209. 

  209. 			<li>Bug fixed when you had an interface in a project preventing the project to load</li>
    210. 

  210. 		</ul>
    211. 

  211. 	</ul>
    212. 

  212. </ul>
    213. 

  213. <ul>
    214. 

  214. 	<li>1.2.1</li>
    215. 

  215. 	<ul>
    216. 

  216. 		<li>Option for conditional expression warning</li>
    217. 

  217. 		<li>Bugs fixed</li>
    218. 

  218. 		<ul>
    219. 

  219. 			<li>Release 1.2.0 was missing some icons</li>
    220. 

  220. 			<li>NPE fixed in smart code completion</li>
    221. 

  221. 			<li>Some code analysis were executed twice</li>
    222. 

  222. 			<li>NPE fixed in ArrayInitializer code analysis <i>array('foo',)</i> syntax</li>
    223. 

  223. 		</ul>
    224. 

  224. 	</ul>
    225. 

  225. </ul>
    226. 

  226. <ul>
    227. 

  227. 	<li>1.2.0<br>
    228. 

  228. 		<ul>
    229. 

  229. 			<li>Bugs fixed
    230. 

  230. 				<ul>
    231. 

  231. 					<li>1203867 bugfix with code analysis</li>
    232. 

  232. 					<li>1098323 A <b>?></b> in an heredoc syntax will not crash the parser anymore
    233. 

  233. 					</li>
    234. 

  234. 					<li>1098321 The keyword <b>xor</b> is now supported</li>
    235. 

  235. 					<li>Fix warning in code analysis on global requiring super globals variables
    236. 

  236. 					</li>
    237. 

  237. 					<li>a memory leak, the PHPErrorSource was instantiated on each parse and never
    238. 

  238. 						released
    239. 

  239. 					</li>
    240. 

  240. 					<li>Keywords that can be method names should now be managed.</li>
    241. 

  241. 				</ul>
    242. 

  242. 			</li>
    243. 

  243. 			<li>Features
    244. 

  244. 				<ul>
    245. 

  245. 					<li>Sidekick completion</li>
    246. 

  246. 					<li>Project handling</li>
    247. 

  247. 					<li>Quick access to find class and methods</li>
    248. 

  248. 					<li>new warning for syntax case '' ; (semicolon instead of colon)</li>
    249. 

  249. 					<li>Parsing of double quoted strings</li>
    250. 

  250. 					<li>php 5 support</li>
    251. 

  251. 				</ul>
    252. 

  252. 			</li>
    253. 

  253. 			<li>Others
    254. 

  254. 				<ul>
    255. 

  255. 					<li>Some cleanup in the parser</li>
    256. 

  256. 				</ul>
    257. 

  257. 		</ul>
    258. 

  258. 	</li>
    259. 

  259. 	<li>1.1.0<br>
    260. 

  260. 		<ul>
    261. 

  261. 			<li>The files edited with jEdit php mode are parsed, no more option pane to choose them</li>
    262. 

  262. 			<li>Sidekick structure tree</li>
    263. 

  263. 			<li>Parse on keystroke with sidekick</li>
    264. 

  264. 			<li>Code analysis:
    265. 

  265. 				<ul>
    266. 

  266. 					<li>Unused method parameters reported</li>
    267. 

  267. 					<li>Variable used before being assigned are reported</li>
    268. 

  268. 				</ul>
    269. 

  269. 			</li>
    270. 

  270. 		</ul>
    271. 

  271. 

  272. 	</li>
    273. 

  273. 

  274. 	<li>1.0.3<br>
    275. 

  275. 		<ul>
    276. 

  276. 			<li>Heredoc support</li>
    277. 

  277. 			<li>My contact adress changed</li>
    278. 

  278. 		</ul>
    279. 

  279. 	</li>
    280. 

  280. 	<li>1.0.2<br>
    281. 

  281. 		<ul>
    282. 

  282. 			<li>When you deactivate the parser in the options, it will really be deactivated</li>
    283. 

  283. 			<li>lot of bugfixes in the parsing</li>
    284. 

  284. 		</ul>
    285. 

  285. 	</li>
    286. 

  286. </ul>
    287. 

  287. 

  288. <h2>known issue</h2>
    289. 

  289. <ul>
    290. 

  290. 	<li>when you deactivate the parser the errors aren't removed from ErrorList (but is it really a bug or a feature
    291. 

  291. 		?)
    292. 

  292. 	</li>
    293. 

  293. 	<li>When you have several classes or methods with the same name in the project only one is kept in the project
    294. 

  294. 		memory
    295. 

  295. 	</li>
    296. 

  296. </ul>
    297. 

  297. 

  298. <h2>Feedback</h2>
    299. 

  299. 

  300. <p>Please report bugs to the bug jEdit's plugin tracker on sourceforge.net</p>
    301. 

  301. </body>
    302. 

  302. </html>
    303.