PageRenderTime 1372ms CodeModel.GetById 24ms RepoModel.GetById 0ms app.codeStats 0ms

/db_wp-includes_Text_Diff_Engine_shell.html

https://github.com/benatkin/wp-docblox-docs
HTML | 255 lines | 240 code | 15 blank | 0 comment | 0 complexity | 1dbb65c7d7f3d793a63173b63acc73ef MD5 | raw file
  1. <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  2. <title>WordPress Trunk</title><link rel="stylesheet" href="css/black-tie/jquery-ui-1.8.2.custom.css" type="text/css"></link><link rel="stylesheet" href="css/jquery.treeview.css" type="text/css"></link><link rel="stylesheet" href="css/theme.css" type="text/css"></link><script type="text/javascript" src="js/jquery-1.4.2.min.js"></script><script type="text/javascript" src="js/jquery-ui-1.8.2.custom.min.js"></script><script type="text/javascript" src="js/jquery.cookie.js"></script><script type="text/javascript" src="js/jquery.treeview.js"></script><script type="text/javascript">
  3. $(document).ready(function() {
  4. $(".filetree").treeview({
  5. collapsed: true,
  6. persist: "cookie"
  7. });
  8. $("#accordion").accordion({
  9. collapsible: true,
  10. autoHeight: false,
  11. fillSpace: true
  12. });
  13. $(".tabs").tabs();
  14. });
  15. </script></head><body><div xmlns="" id="content">
  16. <script type="text/javascript" src="js/menu.js"></script><script>
  17. function filterElements()
  18. {
  19. inherited = !$('a#show-inherited').hasClass('deselected');
  20. public = !$('a#show-public').hasClass('deselected');
  21. protected = !$('a#show-protected').hasClass('deselected');
  22. private = !$('a#show-private').hasClass('deselected');
  23. $('div.public').each(function(index, val) {
  24. $(val).toggle(public && !($(val).hasClass('inherited_from') && !inherited));
  25. });
  26. $('div.protected').each(function(index, val) {
  27. $(val).toggle(protected && !($(val).hasClass('inherited_from') && !inherited));
  28. });
  29. $('div.private').each(function(index, val) {
  30. $(val).toggle(private && !($(val).hasClass('inherited_from') && !inherited));
  31. });
  32. }
  33. $(document).ready(function() {
  34. $('a.gripper').click(function() {
  35. $(this).nextAll('div.code-tabs').slideToggle();
  36. $(this).children('img').toggle();
  37. return false;
  38. });
  39. $('div.method code span.highlight,div.function code span.highlight,div.constant code span.highlight,div.property code span.highlight').css('cursor', 'pointer');
  40. $('div.method code span.highlight,div.function code span.highlight,div.constant code span.highlight,div.property code span.highlight').click(function() {
  41. $(this).parent().nextAll('div.code-tabs').slideToggle();
  42. $(this).parent().prevAll('a.gripper').children('img').toggle();
  43. return false;
  44. });
  45. $('div.code-tabs').hide();
  46. $('a.gripper').show();
  47. $('div.code-tabs:empty').prevAll('a.gripper').html('');
  48. $('div.file-nav').show();
  49. $('a#show-public, a#show-protected, a#show-private, a#show-inherited').click(function(){
  50. $(this).toggleClass('deselected');
  51. if ($(this).hasClass('deselected')) {
  52. $(this).fadeTo('fast', '0.4');
  53. } else {
  54. $(this).fadeTo('fast', '1.0');
  55. }
  56. filterElements();
  57. return false;
  58. });
  59. $('a#show-protected, a#show-private').click();
  60. });
  61. </script><h1 class="file">wp-includes/Text/Diff/Engine/shell.php</h1>
  62. <div class="file-nav">
  63. <ul id="file-nav">
  64. <li><a href="#top">Global</a></li>
  65. <li>
  66. <a href="#classes"><img src="images/icons/class.png" height="14">
  67. Classes
  68. </a><ul><li><a href="#%5CText_Diff_Engine_shell">\Text_Diff_Engine_shell</a></li></ul>
  69. </li>
  70. </ul>
  71. <div style="float: right;padding-right: 20px;">
  72. Show:
  73. <a href="#" id="show-public"><img src="images/icons/visibility_public.png"></a><a href="#" id="show-protected"><img src="images/icons/visibility_protected.png"></a><a href="#" id="show-private"><img src="images/icons/visibility_private.png"></a><a href="#" id="show-inherited"><span class="attribute">inherited</span></a>
  74. </div>
  75. </div>
  76. <a name="top" class="anchor"></a><div id="file-description">
  77. <p class="short-description">Class used internally by Diff to actually compute the diffs.</p>
  78. <div class="long-description"><p>This class uses the Unix <code>diff</code> program via shell_exec to compute the
  79. differences between the two input arrays.</p>
  80. <p>Copyright 2007-2010 The Horde Project (http://www.horde.org/)</p>
  81. <p>See the enclosed file COPYING for license information (LGPL). If you did
  82. not receive this file, see http://opensource.org/licenses/lgpl-license.php.</p>
  83. </div>
  84. </div>
  85. <dl class="file-info">
  86. <dt>Author</dt>
  87. <dd>
  88. <a href="mailto:mail@milianw.de">Milian Wolff</a>
  89.  
  90. </dd>
  91. <dt>Package</dt>
  92. <dd>Text_Diff
  93.  
  94. </dd>
  95. <dt>Since</dt>
  96. <dd>0.3.0
  97.  
  98. </dd>
  99. </dl>
  100. <a name="classes" class="anchor"></a><a id="\Text_Diff_Engine_shell" class="anchor"></a><h2 class="class">\Text_Diff_Engine_shell<div class="to-top"><a href="#top">jump to top</a></div>
  101. </h2>
  102. <div class="class">
  103. <small class="package"><b>Package: </b>Text\Diff</small><p class="short-description">Class used internally by Diff to actually compute the diffs.</p>
  104. <div class="long-description"><p>This class uses the Unix <code>diff</code> program via shell_exec to compute the
  105. differences between the two input arrays.</p>
  106. <p>Copyright 2007-2010 The Horde Project (http://www.horde.org/)</p>
  107. <p>See the enclosed file COPYING for license information (LGPL). If you did
  108. not receive this file, see http://opensource.org/licenses/lgpl-license.php.</p>
  109. </div>
  110. <dl class="class-info">
  111. <dt>Author</dt>
  112. <dd>
  113. <a href="mailto:mail@milianw.de">Milian Wolff</a>
  114.  
  115. </dd>
  116. <dt>Since</dt>
  117. <dd>0.3.0
  118.  
  119. </dd>
  120. </dl>
  121. <h3>Properties</h3>
  122. <div>
  123. <a id="\Text_Diff_Engine_shell::$_diffCommand" class="anchor"></a><div class="property public">
  124. <a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public">string
  125.  <span class="highlight">$_diffCommand</span>= ''diff''
  126. </code><div class="description">
  127. <p class="short-description">Path to the diff executable</p></div>
  128. <div class="code-tabs">
  129. <div class="long-description">
  130. </div>
  131. <strong>Default value</strong><code>'diff'</code><strong>Details</strong><dl class="property-info">
  132. <dt>Type</dt>
  133. <dd>string</dd>
  134. </dl>
  135. </div>
  136. <div class="clear"></div>
  137. </div>
  138. </div>
  139. <h3>Methods</h3>
  140. <div>
  141. <a id="\Text_Diff_Engine_shell::_getLines()" class="anchor"></a><div class="method public">
  142. <a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">_getLines</span><span class="nb-faded-text">(
  143. array $text_lines, int $line_no, int $end
  144. =
  145. false
  146. )
  147. </span>
  148. :
  149. array</code><div class="description"><p class="short_description">Get lines from either the old or new text</p></div>
  150. <div class="code-tabs">
  151. <div class="long-description">
  152. </div>
  153. <strong>Parameters</strong><table class="argument-info">
  154. <thead><tr>
  155. <th>Name</th>
  156. <th>Type</th>
  157. <th>Description</th>
  158. </tr></thead>
  159. <tr>
  160. <th>$text_lines</th>
  161. <td>array</td>
  162. <td><em><p>&$text_lines Either $from_lines or $to_lines</p>
  163. </em></td>
  164. </tr>
  165. <tr>
  166. <th>$line_no</th>
  167. <td>int</td>
  168. <td><em><p>&$line_no Current line number</p>
  169. </em></td>
  170. </tr>
  171. <tr>
  172. <th>$end</th>
  173. <td>int</td>
  174. <td><em><p>Optional end line, when we want to chop more than one line.</p></em></td>
  175. </tr>
  176. </table>
  177. <strong>Returns</strong><table class="argument-info">
  178. <thead><tr>
  179. <th>Type</th>
  180. <th>Description</th>
  181. </tr></thead>
  182. <tr>
  183. <td>array</td>
  184. <td>The chopped lines</td>
  185. </tr>
  186. </table>
  187. <strong>Details</strong><dl class="function-info">
  188. <dt>Access</dt>
  189. <dd>private
  190.  
  191. </dd>
  192. </dl>
  193. </div>
  194. <div class="clear"></div>
  195. </div>
  196. <a id="\Text_Diff_Engine_shell::diff()" class="anchor"></a><div class="method public">
  197. <a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">diff</span><span class="nb-faded-text">(
  198. array $from_lines, array $to_lines
  199. )
  200. </span>
  201. :
  202. array</code><div class="description"><p class="short_description">Returns the array of differences.</p></div>
  203. <div class="code-tabs">
  204. <div class="long-description">
  205. </div>
  206. <strong>Parameters</strong><table class="argument-info">
  207. <thead><tr>
  208. <th>Name</th>
  209. <th>Type</th>
  210. <th>Description</th>
  211. </tr></thead>
  212. <tr>
  213. <th>$from_lines</th>
  214. <td>array</td>
  215. <td><em><p>lines of text from old file</p></em></td>
  216. </tr>
  217. <tr>
  218. <th>$to_lines</th>
  219. <td>array</td>
  220. <td><em><p>lines of text from new file</p></em></td>
  221. </tr>
  222. </table>
  223. <strong>Returns</strong><table class="argument-info">
  224. <thead><tr>
  225. <th>Type</th>
  226. <th>Description</th>
  227. </tr></thead>
  228. <tr>
  229. <td>array</td>
  230. <td>all changes made (array with Text_Diff_Op_* objects)</td>
  231. </tr>
  232. </table>
  233. </div>
  234. <div class="clear"></div>
  235. </div>
  236. </div>
  237. </div>
  238. </div>
  239. <small xmlns="" class="footer">Documentation was generated by <a href="http://docblox-project.org">DocBlox 0.14.1</a>.
  240. </small></body></html>