1 | <?php |
---|
2 | /* |
---|
3 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
---|
4 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
---|
5 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
---|
6 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
---|
7 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
---|
8 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
---|
9 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
---|
10 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
---|
11 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
---|
12 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
---|
13 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
---|
14 | * |
---|
15 | * This software consists of voluntary contributions made by many individuals |
---|
16 | * and is licensed under the LGPL. For more information, see |
---|
17 | * <http://www.doctrine-project.org>. |
---|
18 | */ |
---|
19 | |
---|
20 | namespace Doctrine\Common\Persistence\Mapping\Driver; |
---|
21 | |
---|
22 | use Doctrine\Common\Persistence\Mapping\ClassMetadata; |
---|
23 | |
---|
24 | /** |
---|
25 | * Contract for metadata drivers. |
---|
26 | * |
---|
27 | * @since 2.2 |
---|
28 | * @author Jonathan H. Wage <jonwage@gmail.com> |
---|
29 | */ |
---|
30 | interface MappingDriver |
---|
31 | { |
---|
32 | /** |
---|
33 | * Loads the metadata for the specified class into the provided container. |
---|
34 | * |
---|
35 | * @param string $className |
---|
36 | * @param ClassMetadata $metadata |
---|
37 | */ |
---|
38 | function loadMetadataForClass($className, ClassMetadata $metadata); |
---|
39 | |
---|
40 | /** |
---|
41 | * Gets the names of all mapped classes known to this driver. |
---|
42 | * |
---|
43 | * @return array The names of all mapped classes known to this driver. |
---|
44 | */ |
---|
45 | function getAllClassNames(); |
---|
46 | |
---|
47 | /** |
---|
48 | * Whether the class with the specified name should have its metadata loaded. |
---|
49 | * This is only the case if it is either mapped as an Entity or a |
---|
50 | * MappedSuperclass. |
---|
51 | * |
---|
52 | * @param string $className |
---|
53 | * @return boolean |
---|
54 | */ |
---|
55 | function isTransient($className); |
---|
56 | } |
---|