Skip to content

Commit 8f0df09

Browse files
committed
added description to README
1 parent bd85651 commit 8f0df09

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.rst

+21
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22
README
33
======
44

5+
What is php-dql-tokenizer?
6+
==========================
7+
8+
This extension is for improving performance of Doctrine_Query_Tokenizer.
9+
510
INSTALL
611
=======
712

@@ -17,6 +22,22 @@ Then add the following to your php.ini::
1722
[dql_tokenizer]
1823
extension=dql_tokenizer.so
1924

25+
How To Use
26+
==========
27+
28+
This extension provides functions that corresponds to the methods of the Doctrine_Query_Tokenizer class.
29+
30+
So you need to define a new tokenizer classes to use this extension.
31+
32+
First, you write the following code in your query class::
33+
34+
if (function_exists('dql_tokenize_query'))
35+
{
36+
$this->_tokenizer = new myQueryTokenizer();
37+
}
38+
39+
Next, you define a new tokenizer class. You can get the example class file from "example/myQueryTokenizer.class.php".
40+
2041
Credits
2142
=======
2243

0 commit comments

Comments
 (0)