File_SearchReplace

Using

With SearchReplace, you can replace a text in as many as desired files by another.

$files = array( "test1.txt",
                    "test2.txt",
                    "test3.txt" ) ;
    $ignoreline = array( "#", ":") ;

    $snr = File_SearchReplace( "Yes", "No", $files, "/mail/", false,
                               $ignoreline) ;
    $snr -> doSearch() ;

The example replaces all occurences of "Yes" with "No" in the given $files in the directory "/mail/". If a line in a file starts with one of the chars in $ignoreline, possible matches will be ignored.

You can do a new search without creating a new instance of the class.

...
    // string to search
    $snr -> setFind( "Er") ;
    // string to find
    $snr -> setReplace( "Sie") ;
    // look in this files
    $snr -> setFiles( $files) ;
    // look in this directories
    $snr -> setDirectories( array( "/neue_briefe/")) ;
    // look in the subdirectories too
    $snr -> setIncludeSubdir( true) ;
    // ignore lines in the files starting with this chars
    $snr -> setIgnoreLines( array( "::", "#")) ;
    // restart search'n'replace
    $snr -> doSearch() ;

Types of search functions

File_SearchReplace supports different kinds of search functions. The type directly influence the format of the required $find-parameter

File_SearchReplace::File_SearchReplace

Constructor - sets the search and replace query

Parameter

• $find - the string/regex to find

• $replace - the string/regex to replace $find

• $files - the file(s) to perform this operation on.

• $directories - the directories to perform this operation on.

• $include_subdir - if performing on directories, whether to traverse subdirectories.

• $ignore_lines - ignore lines beginning with any of the strings in this array. This feature only works with the "normal" search.

File_SearchReplace::getNumOccurences

Accessor to return the number of occurences found.

Returns

• integer - Number of occurences found

File_SearchReplace::doSearch

This starts the search/replace off. Call this to do the search. First do whatever files are specified, and/or if directories are specified do those too.

File_SearchReplace::setFind

Accessor for setting find variable.

Parameter

• $find - the string/regex to find

File_SearchReplace::setReplace

Accessor for setting replace variable.

Parameter

• $replace - the string/regex to replace the find string/regex with.

File_SearchReplace::setFiles

Accessor for setting files variable.

Parameter

• $files - the file(s) to perform this operation on.

File_SearchReplace::setDirectories

Accessor for setting directories variable.

Parameter

• $directories - the directories to perform this operation on.

File_SearchReplace::setIncludeSubdir

Accessor for setting include_subdir variable.

Parameter

• $inlude_subdir - Whether to traverse subdirectories or not.

File_SearchReplace::setIgnoreLines

Accessor for setting ignore_lines variable.

Parameter

• $ignore_lines - Ignore lines beginning with any of the strings in this array. This feature only works with the "normal" search.

File_SearchReplace::setSearchFunction

Function to determine which search function is used.

Parameter

• $search_function - The search function that should be used. See "Types of search functions"