Skip to content

Commit

Permalink
adds some php doc
Browse files Browse the repository at this point in the history
  • Loading branch information
schmittjoh committed Jan 2, 2012
1 parent 3fa5b86 commit f1ebcc7
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions src/Metadata/MetadataFactoryInterface.php
Expand Up @@ -18,7 +18,23 @@

namespace Metadata;

/**
* Interface for Metadata Factory implementations.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
interface MetadataFactoryInterface
{
/**
* Returns the gathered metadata for the given class name.
*
* If the drivers return instances of MergeableClassMetadata, these will be
* merged prior to returning. Otherwise, all metadata for the inheritance
* hierarchy will be returned as ClassHierarchyMetadata unmerged.
*
* If no metadata is available, null is returned.
*
* @return ClassHierarchyMetadata|MergeableClassMetadata|null
*/
function getMetadataForClass($className);
}

0 comments on commit f1ebcc7

Please sign in to comment.