| 1 |
lars |
1 |
; Example INI File
|
|
|
2 |
|
|
|
3 |
[DB]
|
|
|
4 |
|
|
|
5 |
|
|
|
6 |
;portability = 15
|
|
|
7 |
; if you are working with oracle (or plan to) - this will do things
|
|
|
8 |
; like force lowercase table names (see the PEAR DB manual
|
|
|
9 |
|
|
|
10 |
[DB_DataObject]
|
|
|
11 |
|
|
|
12 |
database = mysql://username:password@localhost/database
|
|
|
13 |
; the default database dsn see pear spec for more details
|
|
|
14 |
|
|
|
15 |
|
|
|
16 |
|
|
|
17 |
schema_location = /home/me/Projects/myapplication/DataObjects
|
|
|
18 |
;directory where the database ini files are..
|
|
|
19 |
|
|
|
20 |
; ini_{databaseName} = /path/to/ini/file.ini:/path/to_another_ini/file.ini
|
|
|
21 |
; you can also configure manually the ini_file location
|
|
|
22 |
; (and the links is expected to be in the
|
|
|
23 |
; same location) for each database by using the syntax
|
|
|
24 |
; use a PATH_SEPERATOR to load multiple files.
|
|
|
25 |
; BEST USED WITH database_{databasename} = dsn...
|
|
|
26 |
|
|
|
27 |
|
|
|
28 |
; links_{databaseName} = /path/to/databases/links.ini
|
|
|
29 |
; allows you to specify a specific links.ini file for a database
|
|
|
30 |
; or project.
|
|
|
31 |
|
|
|
32 |
class_location = /home/me/Projects/myapplication/DataObjects
|
|
|
33 |
; directory where the Table classes are..
|
|
|
34 |
; you can also use the format
|
|
|
35 |
; /home/me/Projects/myapplication/DataObjects_%s.php
|
|
|
36 |
; and %s gets replaced with the tablename.
|
|
|
37 |
; to use multiple search paths use the PATH_SEPERATOR
|
|
|
38 |
|
|
|
39 |
require_prefix = DataObjects/
|
|
|
40 |
; prefix for the 'require statement'
|
|
|
41 |
|
|
|
42 |
class_prefix = DataObjects_
|
|
|
43 |
; Prefix Mapping of table name to PHP Class
|
|
|
44 |
; to use multiple prefixes seperate them with PATH_SEPERATOR
|
|
|
45 |
|
|
|
46 |
;table_example = example
|
|
|
47 |
; use database example for table example
|
|
|
48 |
|
|
|
49 |
;database_example = mysql://username:password@host/database
|
|
|
50 |
; use this dsn for database example
|
|
|
51 |
|
|
|
52 |
|
|
|
53 |
;db_driver = DB
|
|
|
54 |
; can be set to MDB2 or DB
|
|
|
55 |
; uses MDB2 backend rather than PEAR DB
|
|
|
56 |
|
|
|
57 |
|
|
|
58 |
|
|
|
59 |
;disable_null_strings = false
|
|
|
60 |
; DataObjects will convert the text value 'null' to NULL when building queries
|
|
|
61 |
; this may cause problems! Setting to true will turn off this feature.
|
|
|
62 |
; you can use DB_DataObject_Cast::SQL('NULL'); in where you have to turn this off.
|
|
|
63 |
;
|
|
|
64 |
; can also be set to 'full' however - this may delete data quietly if properties are
|
|
|
65 |
; not fetched and are set *** Highly recommended not to use this..
|
|
|
66 |
|
|
|
67 |
; the generator settings (optional)
|
|
|
68 |
|
|
|
69 |
;extends_location =
|
|
|
70 |
; string added to php file for 'include('DB/DataObject');'
|
|
|
71 |
; usefull if you want to add an extra layer - eg. a table level auth scheme..
|
|
|
72 |
; optional :: default = DB/DataObject.php
|
|
|
73 |
|
|
|
74 |
|
|
|
75 |
;extends =
|
|
|
76 |
; string used in Table_XXX extends YYYY {
|
|
|
77 |
; usefull if you want to add an extra layer - eg. a table level auth scheme..
|
|
|
78 |
; optional :: default = DB_DataObject
|
|
|
79 |
|
|
|
80 |
;generator_class_rewrite =
|
|
|
81 |
|
|
|
82 |
; alter the extends field when updating a class (defaults to only replacing DB_DataObject)
|
|
|
83 |
; use ANY to will replace all extends with either DB_DataObject or the value of extends (above)
|
|
|
84 |
; use specific_name to replace 'specific_name' with either DB_DataObject or the value of extends (above)
|
|
|
85 |
|
|
|
86 |
|
|
|
87 |
|
|
|
88 |
;generator_novars =
|
|
|
89 |
; (True) prevents writing of private/var's so you can overload get/set
|
|
|
90 |
; note: this has the downside of making code less clear... (alot of magic!!)
|
|
|
91 |
|
|
|
92 |
;generator_var_keyword = 'var'
|
|
|
93 |
; var|public - (or private if you want to break things)
|
|
|
94 |
; The variable prefix that is used when class properties are created
|
|
|
95 |
; the default is public for PHP5, and var for PHP4
|
|
|
96 |
|
|
|
97 |
|
|
|
98 |
;generator_add_validate_stubs =
|
|
|
99 |
; (True) will insert / (or add to existing files) stubs for validate methods
|
|
|
100 |
|
|
|
101 |
;generator_no_ini =
|
|
|
102 |
; (True) will generate the methods table() ,keys(), sequenceKeys() and defaults()
|
|
|
103 |
; methods in the generated classes
|
|
|
104 |
; and not generate any ini file to describe the table.
|
|
|
105 |
|
|
|
106 |
;generator_add_defaults =
|
|
|
107 |
; (True) will generate defaults() method in generated classes
|
|
|
108 |
; returning an array of the defaults column values for the table.
|
|
|
109 |
|
|
|
110 |
;generator_omit_database_var
|
|
|
111 |
; (false) will prevent generation of $database line in generated files
|
|
|
112 |
|
|
|
113 |
|
|
|
114 |
;generate_links = false
|
|
|
115 |
; (true) will create the links.ini from the table definition
|
|
|
116 |
; Only available with mysql / mysqli at present.
|
|
|
117 |
|
|
|
118 |
;generate_setters = false
|
|
|
119 |
; (true) will generate setXXXX() methods for you.
|
|
|
120 |
|
|
|
121 |
|
|
|
122 |
;generate_getters = false
|
|
|
123 |
; (true) will generate getXXXX() methods for you.
|
|
|
124 |
|
|
|
125 |
|
|
|
126 |
|
|
|
127 |
|
|
|
128 |
|
|
|
129 |
|
|
|
130 |
debug = 0
|
|
|
131 |
; default debugging level
|
|
|
132 |
|
|
|
133 |
debug_ignore_updates = 0
|
|
|
134 |
; behaviour changed in > 0.10 so that you have to manually turn of updates
|
|
|
135 |
; rather than it automatically being done by setting debug to > 1
|
|
|
136 |
|
|
|
137 |
|
|
|
138 |
dont_die = 0
|
|
|
139 |
; if you set this to true or 1, then dataobjects will not die
|
|
|
140 |
; on major errors like database connection etc. or programming errors
|
|
|
141 |
; - you probably want to do this on a live server - and
|
|
|
142 |
; write a pear error handler.. - to send you an email!
|
|
|
143 |
|
|
|
144 |
;quote_identifiers = 0
|
|
|
145 |
; Quote table and column names when building queries - this relies on the
|
|
|
146 |
; quoteIdentifier method being available in PEAR::DB (it should be introduced in 1.5 final or 1.6)
|
|
|
147 |
|
|
|
148 |
;quote_identifiers_tableinfo = 0
|
|
|
149 |
; Quote table and column names when generator sends tableinfo to request schema
|
|
|
150 |
; Note - this can be on for most databases, but must be off for Oracle (see bug #10112)
|
|
|
151 |
|
|
|
152 |
|
|
|
153 |
;keep_query_after_fetch = 0
|
|
|
154 |
; From 1.4 on the query building will be cleared after a fetch(1.5), or find(1.4)
|
|
|
155 |
; To disable this behavior set this to 1
|
|
|
156 |
|
|
|
157 |
|
|
|
158 |
|
|
|
159 |
|
|
|
160 |
dont_use_pear_sequences = 0
|
|
|
161 |
; If a table does not have a Native (autoincrement etc.) - and it has a primary
|
|
|
162 |
; key, it is assumed that the table should use pear's getNextID to
|
|
|
163 |
; emulate sequences.. - if this is not required set this to 1
|
|
|
164 |
|
|
|
165 |
|
|
|
166 |
;generator_include_regex = /^FOO_.*/i
|
|
|
167 |
;generator_exclude_regex = /^tmp_.*/i
|
|
|
168 |
; include and exclude tables from being read by the generator
|
|
|
169 |
|
|
|
170 |
build_views = 0
|
|
|
171 |
;for postgres, you can build dataobjects for views as well
|
|
|
172 |
; I believe it postgres also supports updating on views (nice feature)
|
|
|
173 |
; *** NOTE *** You will have to manually define keys() / sequenceKeys()
|
|
|
174 |
; As the generator can not recognize these automatically
|
|
|
175 |
|
|
|
176 |
|
|
|
177 |
;generator_strip_schema = 1
|
|
|
178 |
; postgres has a wierd concept of schema's which end up prefixed to
|
|
|
179 |
; the list of tables. - this makes a mess of class/schema generation
|
|
|
180 |
; setting this to 1, makes the generator strip the schema from the table name.
|
|
|
181 |
|
|
|
182 |
;generator_secondary_key_match = primary|unique
|
|
|
183 |
; set to false to prevent generation of any unique or primary keys that are not autoincrement/nextval()
|
|
|
184 |
|
|
|
185 |
|
|
|
186 |
; ---------- DEPRECIATED --------------
|
|
|
187 |
|
|
|
188 |
|
|
|
189 |
;ignore_sequence_keys =
|
|
|
190 |
; THIS IS DEPRECIATED NOW - define the method sequenceKey() to return array(false,false)
|
|
|
191 |
; to stop useage of sequence keys.
|
|
|
192 |
; see sequenceKey Manual page for more details.
|
|
|
193 |
|
|
|
194 |
|
|
|
195 |
;sequence_{tablename} = {column}
|
|
|
196 |
; THIS IS DEPRECIATED NOW - define the method sequenceKey() to return array(false,false)
|
|
|
197 |
; specify which column is autoincremented/nextval'd
|
|
|
198 |
;sequence_{tablename} = {column}:{sequence_name}
|
|
|
199 |
; THIS IS DEPRECIATED NOW - define the method sequenceKey() to return array(false,false)
|
|
|
200 |
; specify which column is nextval'd, and the sequence name to use for the column.
|
|
|
201 |
|