Skip to content

Commit cae5590

Browse files
dbudbu
authored
Merge pull request #882 from doctrine/naming-cleanup
naming cleanup of metadata parameter
2 parents abc20ac + 5d4b429 commit cae5590

File tree

13 files changed

+233
-247
lines changed

13 files changed

+233
-247
lines changed

‎lib/Doctrine/ODM/PHPCR/DocumentRepository.php‎

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -26,18 +26,15 @@ class DocumentRepository implements ObjectRepository
2626
{
2727
public const QUERY_REPLACE_WITH_FIELDNAMES = 1;
2828

29-
protected DocumentManagerInterface $dm;
30-
protected ClassMetadata $class;
3129
protected UnitOfWork $uow;
3230
protected string $className;
3331

34-
public function __construct(DocumentManagerInterface $dm, ClassMetadata $class)
35-
{
36-
$this->dm = $dm;
37-
$this->class = $class;
38-
32+
public function __construct(
33+
private readonly DocumentManagerInterface $dm,
34+
private readonly ClassMetadata $metadata,
35+
) {
3936
$this->uow = $this->dm->getUnitOfWork();
40-
$this->className = $class->name;
37+
$this->className = $metadata->name;
4138
}
4239

4340
/**
@@ -141,7 +138,7 @@ public function findBy(array $criteria, ?array $orderBy = null, ?int $limit = nu
141138
*/
142139
protected function constraintField(ConstraintFactory $where, string $field, mixed $value, string $alias): void
143140
{
144-
if ($field === $this->class->nodename) {
141+
if ($field === $this->metadata->nodename) {
145142
$where->eq()->name($alias)->literal($value);
146143
} else {
147144
$where->eq()->field($alias.'.'.$field)->literal($value);
@@ -189,7 +186,7 @@ public function getDocumentManager(): DocumentManagerInterface
189186

190187
public function getClassMetadata(): ClassMetadata
191188
{
192-
return $this->class;
189+
return $this->metadata;
193190
}
194191

195192
/**
@@ -232,7 +229,7 @@ public function createQuery(string $statement, string $language, $options = 0):
232229
$column = reset($columns);
233230
if ('*' === $column->getColumnName() && null === $column->getPropertyName()) {
234231
$qb->setColumns([]);
235-
foreach ($this->class->getFieldNames() as $name) {
232+
foreach ($this->metadata->getFieldNames() as $name) {
236233
$qb->addSelect('a', $name);
237234
}
238235
}

‎lib/Doctrine/ODM/PHPCR/Id/AssignedIdGenerator.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ class AssignedIdGenerator extends IdGenerator
1515
*
1616
* {@inheritdoc}
1717
*/
18-
public function generate(object $document, ClassMetadata $class, DocumentManagerInterface $dm, ?object $parent = null): string
18+
public function generate(object $document, ClassMetadata $metadata, DocumentManagerInterface $dm, ?object $parent = null): string
1919
{
20-
if (!$class->identifier || !$id = $class->getFieldValue($document, $class->identifier)) {
20+
if (!$metadata->identifier || !$id = $metadata->getFieldValue($document, $metadata->identifier)) {
2121
throw new IdException('ID could not be read from the document instance using the AssignedIdGenerator.');
2222
}
2323

‎lib/Doctrine/ODM/PHPCR/Id/AutoIdGenerator.php‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ class AutoIdGenerator extends ParentIdGenerator
1717
*
1818
* {@inheritdoc}
1919
*/
20-
public function generate(object $document, ClassMetadata $class, DocumentManagerInterface $dm, ?object $parent = null): string
20+
public function generate(object $document, ClassMetadata $metadata, DocumentManagerInterface $dm, ?object $parent = null): string
2121
{
2222
if (null === $parent) {
23-
$parent = $class->parentMapping ? $class->getFieldValue($document, $class->parentMapping) : null;
23+
$parent = $metadata->parentMapping ? $metadata->getFieldValue($document, $metadata->parentMapping) : null;
2424
}
2525

26-
$id = $class->identifier ? $class->getFieldValue($document, $class->identifier) : null;
26+
$id = $metadata->identifier ? $metadata->getFieldValue($document, $metadata->identifier) : null;
2727
if (empty($id) && null === $parent) {
28-
throw IdException::noIdNoParent($document, $class->parentMapping);
28+
throw IdException::noIdNoParent($document, $metadata->parentMapping);
2929
}
3030

3131
if (empty($parent)) {
@@ -46,6 +46,6 @@ public function generate(object $document, ClassMetadata $class, DocumentManager
4646
''
4747
);
4848

49-
return $this->buildName($document, $class, $dm, $parent, $name);
49+
return $this->buildName($document, $metadata, $dm, $parent, $name);
5050
}
5151
}

‎lib/Doctrine/ODM/PHPCR/Id/IdGenerator.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,5 +44,5 @@ public static function create(int $generatorType): IdGenerator
4444
/**
4545
* Generate the actual id, to be overwritten by extending classes.
4646
*/
47-
abstract public function generate(object $document, ClassMetadata $class, DocumentManagerInterface $dm, ?object $parent = null): string;
47+
abstract public function generate(object $document, ClassMetadata $metadata, DocumentManagerInterface $dm, ?object $parent = null): string;
4848
}

‎lib/Doctrine/ODM/PHPCR/Id/ParentIdGenerator.php‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,26 +16,26 @@ class ParentIdGenerator extends IdGenerator
1616
*
1717
* {@inheritdoc}
1818
*/
19-
public function generate(object $document, ClassMetadata $class, DocumentManagerInterface $dm, ?object $parent = null): string
19+
public function generate(object $document, ClassMetadata $metadata, DocumentManagerInterface $dm, ?object $parent = null): string
2020
{
2121
if (null === $parent) {
22-
$parent = $class->parentMapping ? $class->getFieldValue($document, $class->parentMapping) : null;
22+
$parent = $metadata->parentMapping ? $metadata->getFieldValue($document, $metadata->parentMapping) : null;
2323
}
2424

25-
$name = $class->nodename ? $class->getFieldValue($document, $class->nodename) : null;
26-
$id = $class->identifier ? $class->getFieldValue($document, $class->identifier) : null;
25+
$name = $metadata->nodename ? $metadata->getFieldValue($document, $metadata->nodename) : null;
26+
$id = $metadata->identifier ? $metadata->getFieldValue($document, $metadata->identifier) : null;
2727

2828
if (empty($id)) {
2929
if (empty($name) && empty($parent)) {
30-
throw IdException::noIdentificationParameters($document, $class->parentMapping, $class->nodename);
30+
throw IdException::noIdentificationParameters($document, $metadata->parentMapping, $metadata->nodename);
3131
}
3232

3333
if (empty($parent)) {
34-
throw IdException::noIdNoParent($document, $class->parentMapping);
34+
throw IdException::noIdNoParent($document, $metadata->parentMapping);
3535
}
3636

3737
if (empty($name)) {
38-
throw IdException::noIdNoName($document, $class->nodename);
38+
throw IdException::noIdNoName($document, $metadata->nodename);
3939
}
4040
}
4141

@@ -44,20 +44,20 @@ public function generate(object $document, ClassMetadata $class, DocumentManager
4444
return $id;
4545
}
4646

47-
if ($class->isValidNodename($name)) {
48-
throw IdException::illegalName($document, $class->nodename, $name);
47+
if ($metadata->isValidNodename($name)) {
48+
throw IdException::illegalName($document, $metadata->nodename, $name);
4949
}
5050

5151
// determine ID based on the path and the node name
52-
return $this->buildName($document, $class, $dm, $parent, $name);
52+
return $this->buildName($document, $metadata, $dm, $parent, $name);
5353
}
5454

55-
protected function buildName(object $document, ClassMetadata $class, DocumentManagerInterface $dm, object $parent, string $name): string
55+
protected function buildName(object $document, ClassMetadata $metadata, DocumentManagerInterface $dm, object $parent, string $name): string
5656
{
5757
// get the id of the parent document
5858
$id = $dm->getUnitOfWork()->getDocumentId($parent);
5959
if (!$id) {
60-
throw IdException::parentIdCouldNotBeDetermined($document, $class->parentMapping, $parent);
60+
throw IdException::parentIdCouldNotBeDetermined($document, $metadata->parentMapping, $parent);
6161
}
6262

6363
// edge case parent is root

‎lib/Doctrine/ODM/PHPCR/Id/RepositoryIdGenerator.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ class RepositoryIdGenerator extends IdGenerator
1313
*
1414
* {@inheritdoc}
1515
*/
16-
public function generate(object $document, ClassMetadata $class, DocumentManagerInterface $dm, ?object $parent = null): string
16+
public function generate(object $document, ClassMetadata $metadata, DocumentManagerInterface $dm, ?object $parent = null): string
1717
{
1818
if (null === $parent) {
19-
$parent = $class->parentMapping ? $class->getFieldValue($document, $class->parentMapping) : null;
19+
$parent = $metadata->parentMapping ? $metadata->getFieldValue($document, $metadata->parentMapping) : null;
2020
}
21-
$repository = $dm->getRepository($class->name);
21+
$repository = $dm->getRepository($metadata->name);
2222
if (!($repository instanceof RepositoryIdInterface)) {
2323
throw new IdException("ID could not be determined. Make sure the that the Repository '".ClassUtils::getClass($repository)."' implements RepositoryIdInterface");
2424
}

‎lib/Doctrine/ODM/PHPCR/Mapping/ClassMetadataFactory.php‎

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -188,19 +188,14 @@ private function addInheritedFields(ClassMetadata $subClass, ClassMetadata $pare
188188
*
189189
* @throws MappingException
190190
*/
191-
protected function validateRuntimeMetadata(ClassMetadata $class, $parent): void
191+
protected function validateRuntimeMetadata(ClassMetadata $metadata, $parent): void
192192
{
193-
if (!$class->reflClass) {
194-
// only validate if there is a reflection class instance
195-
return;
196-
}
197-
198-
$class->validateIdentifier();
199-
$class->validateReferenceable();
200-
$class->validateReferences();
201-
$class->validateChildClasses();
202-
$class->validateLifecycleCallbacks($this->getReflectionService());
203-
$class->validateTranslatables();
193+
$metadata->validateIdentifier();
194+
$metadata->validateReferenceable();
195+
$metadata->validateReferences();
196+
$metadata->validateChildClasses();
197+
$metadata->validateLifecycleCallbacks($this->getReflectionService());
198+
$metadata->validateTranslatables();
204199

205200
// TODO: verify inheritance
206201
}

‎lib/Doctrine/ODM/PHPCR/Mapping/Driver/BuiltinDocumentsDriver.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,15 @@ public function __construct(MappingDriver $wrappedDriver)
2929
$this->builtinDriver = new AttributeDriver([realpath(__DIR__.'/../../Document')]);
3030
}
3131

32-
public function loadMetadataForClass($className, ClassMetadata $class): void
32+
public function loadMetadataForClass($className, ClassMetadata $metadata): void
3333
{
3434
if (str_starts_with($className, self::NAME_SPACE)) {
35-
$this->builtinDriver->loadMetadataForClass($className, $class);
35+
$this->builtinDriver->loadMetadataForClass($className, $metadata);
3636

3737
return;
3838
}
3939

40-
$this->wrappedDriver->loadMetadataForClass($className, $class);
40+
$this->wrappedDriver->loadMetadataForClass($className, $metadata);
4141
}
4242

4343
public function getAllClassNames(): array

0 commit comments

Comments
 (0)