1 | <?php |
||
25 | class Configuration |
||
26 | { |
||
27 | /** |
||
28 | * Array of attributes for this configuration instance. |
||
29 | * |
||
30 | * @var array $attributes |
||
31 | */ |
||
32 | private $attributes = array( |
||
33 | 'designDocuments' => array( |
||
34 | 'doctrine_associations' => array( |
||
35 | 'className' => 'Doctrine\ODM\CouchDB\View\DoctrineAssociations', |
||
36 | 'options' => array(), |
||
37 | ), |
||
38 | 'doctrine_repositories' => array( |
||
39 | 'className' => 'Doctrine\ODM\CouchDB\View\DoctrineRepository', |
||
40 | 'options' => array(), |
||
41 | ), |
||
42 | ), |
||
43 | 'writeDoctrineMetadata' => true, |
||
44 | 'validateDoctrineMetadata' => true, |
||
45 | 'UUIDGenerationBufferSize' => 20, |
||
46 | 'proxyNamespace' => 'MyCouchDBProxyNS', |
||
47 | 'allOrNothingFlush' => true, |
||
48 | 'luceneHandlerName' => false, |
||
49 | 'metadataResolver' => null, |
||
50 | 'autoGenerateProxyClasses' => false, |
||
51 | ); |
||
52 | |||
53 | /** |
||
54 | * Sets the default UUID Generator buffer size |
||
55 | * |
||
56 | * @param integer $UUIDGenerationBufferSize |
||
57 | */ |
||
58 | public function setUUIDGenerationBufferSize($UUIDGenerationBufferSize) |
||
62 | |||
63 | /** |
||
64 | * Gets the default UUID Generator buffer size |
||
65 | * |
||
66 | * @return integer |
||
67 | */ |
||
68 | public function getUUIDGenerationBufferSize() |
||
72 | /** |
||
73 | * Sets if all CouchDB document metadata should be validated on read |
||
74 | * |
||
75 | * @param boolean $validateDoctrineMetadata |
||
76 | */ |
||
77 | public function setValidateDoctrineMetadata($validateDoctrineMetadata) |
||
81 | |||
82 | /** |
||
83 | * Gets if all CouchDB document metadata should be validated on read |
||
84 | * |
||
85 | * @return boolean |
||
86 | */ |
||
87 | public function getValidateDoctrineMetadata() |
||
91 | |||
92 | /** |
||
93 | * Adds a namespace under a certain alias. |
||
94 | * |
||
95 | * @param string $alias |
||
96 | * @param string $namespace |
||
97 | */ |
||
98 | public function addDocumentNamespace($alias, $namespace) |
||
102 | |||
103 | /** |
||
104 | * Resolves a registered namespace alias to the full namespace. |
||
105 | * |
||
106 | * @param string $documentNamespaceAlias |
||
107 | * @return string |
||
108 | * @throws CouchDBException |
||
109 | */ |
||
110 | public function getDocumentNamespace($documentNamespaceAlias) |
||
118 | |||
119 | /** |
||
120 | * Set the document alias map |
||
121 | * |
||
122 | * @param array $documentNamespaces |
||
123 | * @return void |
||
124 | */ |
||
125 | public function setDocumentNamespaces(array $documentNamespaces) |
||
129 | |||
130 | /** |
||
131 | * Sets the cache driver implementation that is used for metadata caching. |
||
132 | * |
||
133 | * @param MappingDriver $driverImpl |
||
134 | * @todo Force parameter to be a Closure to ensure lazy evaluation |
||
135 | * (as soon as a metadata cache is in effect, the driver never needs to initialize). |
||
136 | */ |
||
137 | public function setMetadataDriverImpl(MappingDriver $driverImpl) |
||
141 | |||
142 | /** |
||
143 | * Add a new default annotation driver with a correctly configured annotation reader. |
||
144 | * |
||
145 | * @param array $paths |
||
146 | * @return Mapping\Driver\AnnotationDriver |
||
147 | */ |
||
148 | public function newDefaultAnnotationDriver($paths = array()) |
||
155 | |||
156 | public function setMetadataResolverImpl(MetadataResolver $resolver) |
||
160 | |||
161 | public function getMetadataResolverImpl() |
||
168 | |||
169 | /** |
||
170 | * Gets the cache driver implementation that is used for the mapping metadata. |
||
171 | * |
||
172 | * @return MappingDriver |
||
173 | */ |
||
174 | public function getMetadataDriverImpl() |
||
181 | |||
182 | /** |
||
183 | * Gets the cache driver implementation that is used for metadata caching. |
||
184 | * |
||
185 | * @return \Doctrine\Common\Cache\Cache |
||
186 | */ |
||
187 | public function getMetadataCacheImpl() |
||
192 | |||
193 | /** |
||
194 | * Sets the cache driver implementation that is used for metadata caching. |
||
195 | * |
||
196 | * @param \Doctrine\Common\Cache\Cache $cacheImpl |
||
197 | */ |
||
198 | public function setMetadataCacheImpl(Cache $cacheImpl) |
||
202 | |||
203 | /** |
||
204 | * Sets the directory where Doctrine generates any necessary proxy class files. |
||
205 | * |
||
206 | * @param string $dir |
||
207 | */ |
||
208 | public function setProxyDir($dir) |
||
212 | |||
213 | /** |
||
214 | * Gets the directory where Doctrine generates any necessary proxy class files. |
||
215 | * |
||
216 | * @return string |
||
217 | */ |
||
218 | public function getProxyDir() |
||
226 | |||
227 | /** |
||
228 | * Sets the namespace for Doctrine proxy class files. |
||
229 | * |
||
230 | * @param string $namespace |
||
231 | */ |
||
232 | public function setProxyNamespace($namespace) |
||
236 | |||
237 | /** |
||
238 | * Gets the namespace for Doctrine proxy class files. |
||
239 | * |
||
240 | * @return string |
||
241 | */ |
||
242 | public function getProxyNamespace() |
||
246 | |||
247 | public function setAutoGenerateProxyClasses($bool) |
||
251 | |||
252 | public function getAutoGenerateProxyClasses() |
||
256 | |||
257 | /** |
||
258 | * @param string $name |
||
259 | * @param string $className |
||
260 | * @param array $options |
||
261 | */ |
||
262 | public function addDesignDocument($name, $className, $options) |
||
269 | |||
270 | /** |
||
271 | * @return array |
||
272 | */ |
||
273 | public function getDesignDocumentNames() |
||
277 | |||
278 | /** |
||
279 | * @param string $name |
||
280 | * @return array |
||
281 | */ |
||
282 | public function getDesignDocument($name) |
||
289 | |||
290 | /** |
||
291 | * @param bool $allOrNothing |
||
292 | */ |
||
293 | public function setAllOrNothingFlush($allOrNothing) |
||
297 | |||
298 | /** |
||
299 | * @return bool |
||
300 | */ |
||
301 | public function getAllOrNothingFlush() |
||
305 | |||
306 | public function setLuceneHandlerName($handlerName = '_fti') |
||
310 | |||
311 | public function getLuceneHandlerName() |
||
319 | |||
320 | /** |
||
321 | * @return \Doctrine\ODM\CouchDB\Migrations\NullMigration; |
||
|
|||
322 | */ |
||
323 | public function getMigrations() |
||
331 | |||
332 | /** |
||
333 | * @param DocumentMigration $migration |
||
334 | */ |
||
335 | public function setMigrations(DocumentMigration $migration) |
||
339 | } |
||
340 |
This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.