You are here

Home » API reference » Search and Replace Scanner 7

README.txt in Search and Replace Scanner 7

Same filename and directory in other branches
  1. 5.2 README.txt
  2. 6 README.txt
Scanner Search and Replace
--------------------------

I. DESCRIPTION:

The Search and Replace Scanner can do regular expression matches
against a configurable list of title, body and text fields.
This is useful for finding html strings that Drupal's normal search will
ignore. It can also replace the matched text. Very handy if you are changing
the name of your company, or are changing the URL of a link included
multiple times in multiple nodes.


II. LIMITATIONS:

1. A user can only have one instance of Search and Replace Scanner running at a time.
Attempting to open Scanner in two separate windows to perform replacements at the
same time can lead to unknown errors if you encounter a timeout.

2. Only works on sites using a MySQL database.

3. Large search and replace actions may not be completed on sites that are
hosted in environments where PHP's max_execution_time variable can't be
dynamically expanded. The module automatically attempts to expand the
maximum execution time of a script to 10 minutes. (It's often set at 2 minutes.)
If your Web host doesn't let you adjust this variable dynamically, you may be
able to ask your hosting provider to make the change for your account.


III. WARNING:

This is a very powerful tool, and as such is very dangerous. You can easily
destroy your entire site with it. Be sure to backup your database before using
it. No, really.


IV. FEATURES:

1. Plain text search and replace.

2. Regular expression search and replace.

3. Case sensitive search option.

4. Plain text search allows 'whole word' matching option. For example,
searching for "run" with the whole word option selected will filter out
"running" and "runs", but will match "run!".

5. You can specify text that should precede or follow the search text in order for a match to be valid.

6. Can limit search and replace to published nodes only.

7. Can search and replace on text fields, in addition to the node title.

8. Searches can be limited to specific fields in specific node types.

9. Searches can be further limited by nodes containing specific taxonomy terms.

10. Will save a new node revision when a replacement is made, in case you want
to revert a change.

11. Provides an Undo option that lets you revert all nodes that were udpated in
a specific replacement action.

12. Updates summary part of text fields that use 'Text area with a summary' widget.

13. Will dynamically expand PHP's maximum execution time for scripts up to
10 minutes on servers that support it. This allows complex queries on large
bodies of content.

14. Search results for searches and replacements can be themed.


V. INSTALLATION AND ADMINISTRATION:

See INSTALL.txt for installation and administration instructions.


VI. CREDITS:

Version 7.x-1.x by:
  - Brett Birschbach
    Drupal username: HitmanInWis
  - Eric Rasmussen
    Drupal username: ericras

Version 7.x-dev by:
  - Michael Rossetti
    Drupal username: MikeyR
    rossetti [at] mit.edu

Version 6.x-dev by:
  - Amit Asaravala
    Drupal username: aasarava
    http://www.returncontrol.com
    amit [at] returncontrol.com

Version 5.x-2.0 by:
  - Amit Asaravala
    Drupal username: aasarava
    http://www.returncontrol.com
    amit [at] returncontrol.com
  - Jason Salter
    Drupal username: jpsalter
    http://www.fivepaths.com
    jason [at] fivepaths.com
  - Sponsored by Five Paths Consulting
    http://www.fivepaths.com

Version 5.x-1.0 by:
  - Tao Starbow
    Drupal username: starbow
    http://www.starbowconsulting.com
    tao [at] starbowconsulting.com

File

README.txt
View source 
  1. Scanner Search and Replace

  2. --------------------------

  3. 

  4. I. DESCRIPTION:

  5. 

  6. The Search and Replace Scanner can do regular expression matches

  7. against a configurable list of title, body and text fields.

  8. This is useful for finding html strings that Drupal's normal search will

  9. ignore. It can also replace the matched text. Very handy if you are changing

  10. the name of your company, or are changing the URL of a link included

  11. multiple times in multiple nodes.

  12. 

  13. 

  14. II. LIMITATIONS:

  15. 

  16. 1. A user can only have one instance of Search and Replace Scanner running at a time.

  17. Attempting to open Scanner in two separate windows to perform replacements at the

  18. same time can lead to unknown errors if you encounter a timeout.

  19. 

  20. 2. Only works on sites using a MySQL database.

  21. 

  22. 3. Large search and replace actions may not be completed on sites that are

  23. hosted in environments where PHP's max_execution_time variable can't be

  24. dynamically expanded. The module automatically attempts to expand the

  25. maximum execution time of a script to 10 minutes. (It's often set at 2 minutes.)

  26. If your Web host doesn't let you adjust this variable dynamically, you may be

  27. able to ask your hosting provider to make the change for your account.

  28. 

  29. 

  30. III. WARNING:

  31. 

  32. This is a very powerful tool, and as such is very dangerous. You can easily

  33. destroy your entire site with it. Be sure to backup your database before using

  34. it. No, really.

  35. 

  36. 

  37. IV. FEATURES:

  38. 

  39. 1. Plain text search and replace.

  40. 

  41. 2. Regular expression search and replace.

  42. 

  43. 3. Case sensitive search option.

  44. 

  45. 4. Plain text search allows 'whole word' matching option. For example,

  46. searching for "run" with the whole word option selected will filter out

  47. "running" and "runs", but will match "run!".

  48. 

  49. 5. You can specify text that should precede or follow the search text in order for a match to be valid.

  50. 

  51. 6. Can limit search and replace to published nodes only.

  52. 

  53. 7. Can search and replace on text fields, in addition to the node title.

  54. 

  55. 8. Searches can be limited to specific fields in specific node types.

  56. 

  57. 9. Searches can be further limited by nodes containing specific taxonomy terms.

  58. 

  59. 10. Will save a new node revision when a replacement is made, in case you want

  60. to revert a change.

  61. 

  62. 11. Provides an Undo option that lets you revert all nodes that were udpated in

  63. a specific replacement action.

  64. 

  65. 12. Updates summary part of text fields that use 'Text area with a summary' widget.

  66. 

  67. 13. Will dynamically expand PHP's maximum execution time for scripts up to

  68. 10 minutes on servers that support it. This allows complex queries on large

  69. bodies of content.

  70. 

  71. 14. Search results for searches and replacements can be themed.

  72. 

  73. 

  74. V. INSTALLATION AND ADMINISTRATION:

  75. 

  76. See INSTALL.txt for installation and administration instructions.

  77. 

  78. 

  79. VI. CREDITS:

  80. 

  81. Version 7.x-1.x by:

  82.   - Brett Birschbach

  83.     Drupal username: HitmanInWis

  84.   - Eric Rasmussen

  85.     Drupal username: ericras

  86. 

  87. Version 7.x-dev by:

  88.   - Michael Rossetti

  89.     Drupal username: MikeyR

  90.     rossetti [at] mit.edu

  91. 

  92. Version 6.x-dev by:

  93.   - Amit Asaravala

  94.     Drupal username: aasarava

  95.     http://www.returncontrol.com

  96.     amit [at] returncontrol.com

  97. 

  98. Version 5.x-2.0 by:

  99.   - Amit Asaravala

  100.     Drupal username: aasarava

  101.     http://www.returncontrol.com

  102.     amit [at] returncontrol.com

  103.   - Jason Salter

  104.     Drupal username: jpsalter

  105.     http://www.fivepaths.com

  106.     jason [at] fivepaths.com

  107.   - Sponsored by Five Paths Consulting

  108.     http://www.fivepaths.com

  109. 

  110. Version 5.x-1.0 by:

  111.   - Tao Starbow

  112.     Drupal username: starbow

  113.     http://www.starbowconsulting.com

  114.     tao [at] starbowconsulting.com