README 2.3KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. PHP Diff Class
  2. --------------
  3. Introduction
  4. ------------
  5. A comprehensive library for generating differences between
  6. two hashable objects (strings or arrays). Generated differences can be
  7. rendered in all of the standard formats including:
  8. * Unified
  9. * Context
  10. * Inline HTML
  11. * Side by Side HTML
  12. The logic behind the core of the diff engine (ie, the sequence matcher)
  13. is primarily based on the Python difflib package. The reason for doing
  14. so is primarily because of its high degree of accuracy.
  15. Example Use
  16. -----------
  17. A quick usage example can be found in the example/ directory and under
  18. example.php.
  19. More complete documentation will be available shortly.
  20. Todo
  21. ----
  22. * Ability to ignore blank line changes
  23. * 3 way diff support
  24. * Performance optimizations
  25. License (BSD License)
  26. ---------------------
  27. Copyright (c) 2009 Chris Boulton <chris.boulton@interspire.com>
  28. All rights reserved.
  29. Redistribution and use in source and binary forms, with or without
  30. modification, are permitted provided that the following conditions are met:
  31. - Redistributions of source code must retain the above copyright notice,
  32. this list of conditions and the following disclaimer.
  33. - Redistributions in binary form must reproduce the above copyright notice,
  34. this list of conditions and the following disclaimer in the documentation
  35. and/or other materials provided with the distribution.
  36. - Neither the name of the Chris Boulton nor the names of its contributors
  37. may be used to endorse or promote products derived from this software
  38. without specific prior written permission.
  39. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  40. AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  41. IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  42. ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  43. LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  44. CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  45. SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  46. INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  47. CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  48. ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  49. POSSIBILITY OF SUCH DAMAGE.