added a new feature to scan folders where entities are located #3283

flug · 2019-11-21T15:05:03Z

Q	A
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tickets	fixes #...
License	MIT
Doc PR	api-platform/docs#...

teohhanhui · 2019-11-23T09:50:16Z

What is this for? We already support loading from directories, be it XML, YAML or annotations.

flug · 2019-11-23T14:52:51Z

@soyuka wanted me to bring this feature to see with him and @dunglas

dunglas · 2019-11-23T15:06:16Z

@teohhanhui Basically with this and defaults, you don't need the any annotations to expose a simple API, just pure PHP classes.

alanpoulain · 2019-11-23T18:09:47Z

src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php

-                            ->prototype('scalar')->end()
-                        ->end()
+                        ->prototype('scalar')->end()
+                    ->end()


Bad indentation.

alanpoulain · 2019-11-23T18:10:25Z

src/Bridge/Symfony/Bundle/Resources/config/metadata/directory.xml

+    <services>
+        <service id="api_platform.metadata.resource.name_collection_factory.directory" decorates="api_platform.metadata.resource.name_collection_factory"
+                 class="ApiPlatform\Core\Metadata\Resource\Factory\DirectoryResourceNameCollectionFactory" public="false">
+           <argument>%api_platform.resource_class_directories%</argument>


Suggested change

<argument>%api_platform.resource_class_directories%</argument>

<argument>%api_platform.resource_class_directories%</argument>

alanpoulain · 2019-11-23T18:11:32Z

src/Metadata/Extractor/ClassExtractor.php

+use Doctrine\ORM\Mapping as ORM;
+use Psr\Container\ContainerInterface;
+
+class ClassExtractor extends AbstractExtractor


alanpoulain · 2019-11-23T18:12:48Z

src/Metadata/Extractor/ClassExtractor.php

+
+    protected function extractPath(string $path)
+    {
+        try {


alanpoulain · 2019-11-23T18:13:08Z

src/Metadata/Extractor/ClassExtractor.php

+        parent::__construct($paths, $container);
+    }
+
+    protected function extractPath(string $path)


Suggested change

protected function extractPath(string $path)

protected function extractPath(string $path): void

alanpoulain · 2019-11-23T18:13:46Z

src/Metadata/Extractor/ClassExtractor.php

+            return;
+        }
+        /**
+         * @var string


soyuka · 2019-12-02T14:38:58Z

src/Metadata/Resource/Factory/DirectoryResourceMetadataFactory.php

+     */
+    private function update(ResourceMetadata $resourceMetadata, array $metadata): ResourceMetadata
+    {
+        foreach (['shortName'] as $property) {


do we really need this if there's one property? Let's simplify the code.

soyuka · 2019-12-02T15:41:43Z

src/Metadata/Resource/Factory/DirectoryResourceMetadataFactory.php

+        }
+        $resource['shortName'] = (new \ReflectionClass($resourceClass))->getShortName();
+
+        return $this->update($parentResourceMetadata ?: new ResourceMetadata(), $resource);


$resourceMetadata = $parentResourceMetadata ?: new ResourceMetadata(); if (null !== $resourceMetadata->getShortname()) { return $resourceMetadata; } return $resourceMetadata->withShortname((new \ReflectionClass($resourceClass))->getShortName());

update method isn't required, as isn't the array

soyuka · 2019-12-03T11:25:22Z

src/Bridge/Symfony/Bundle/Resources/config/metadata/metadata.xml

@@ -14,6 +14,7 @@
        <service id="ApiPlatform\Core\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface" alias="api_platform.metadata.resource.name_collection_factory" />

        <!-- Resource metadata -->
+


empty line can be removed

soyuka

Code looks good to me, we just need to validate the new configuration name (auto_mapping), ping @dunglas

stale · 2022-11-04T22:03:55Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale · 2023-01-03T23:05:59Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

flug changed the title ~~added a new feature to scan folders where entities are located~~ [WIP] added a new feature to scan folders where entities are located Nov 21, 2019

flug force-pushed the feature/add/scan-entities/directory branch 19 times, most recently from 9c897ae to 2c04a58 Compare November 22, 2019 13:00

flug changed the title ~~[WIP] added a new feature to scan folders where entities are located~~ added a new feature to scan folders where entities are located Nov 22, 2019

alanpoulain reviewed Nov 23, 2019

View reviewed changes

src/Metadata/Extractor/ClassExtractor.php Outdated

protected function extractPath(string $path)

{

try {

Copy link

Member

alanpoulain Nov 23, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

?

alanpoulain reviewed Nov 23, 2019

View reviewed changes

src/Metadata/Extractor/ClassExtractor.php Outdated

return;

}

/**

* @var string

Copy link

Member

alanpoulain Nov 23, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To remove.

flug force-pushed the feature/add/scan-entities/directory branch 10 times, most recently from 955badc to 457ca33 Compare December 2, 2019 09:08

soyuka reviewed Dec 2, 2019

View reviewed changes

flug force-pushed the feature/add/scan-entities/directory branch 2 times, most recently from c82f0ff to 932e93b Compare December 2, 2019 15:41

soyuka reviewed Dec 2, 2019

View reviewed changes

flug force-pushed the feature/add/scan-entities/directory branch from 932e93b to 71366ef Compare December 2, 2019 15:43

flug added 3 commits December 2, 2019 17:15

added a new feature to scan folders where entities are located

95bccd3

fix cs

d3fc249

adapt code

93da381

flug force-pushed the feature/add/scan-entities/directory branch from 71366ef to 00bcfed Compare December 2, 2019 16:16

soyuka reviewed Dec 3, 2019

View reviewed changes

soyuka approved these changes Dec 3, 2019

View reviewed changes

add tests

8ad7f4b

flug force-pushed the feature/add/scan-entities/directory branch from 00bcfed to 8ad7f4b Compare December 5, 2019 12:10

flug mentioned this pull request Dec 5, 2019

fix key value relationship and embedded #3298

Closed

Base automatically changed from master to main January 23, 2021 21:59

stale bot added the wontfix label Nov 4, 2022

stale bot added the stale label Jan 3, 2023

stale bot closed this Jan 10, 2023

	<argument>%api_platform.resource_class_directories%</argument>
	<argument>%api_platform.resource_class_directories%</argument>

	protected function extractPath(string $path)
	protected function extractPath(string $path): void

		@@ -14,6 +14,7 @@
		<service id="ApiPlatform\Core\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface" alias="api_platform.metadata.resource.name_collection_factory" />

		<!-- Resource metadata -->

Uh oh!

added a new feature to scan folders where entities are located #3283

added a new feature to scan folders where entities are located #3283

Uh oh!

Conversation

flug commented Nov 21, 2019

Uh oh!

teohhanhui commented Nov 23, 2019

Uh oh!

flug commented Nov 23, 2019

Uh oh!

dunglas commented Nov 23, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

soyuka left a comment

Choose a reason for hiding this comment

Uh oh!

stale bot commented Nov 4, 2022

Uh oh!

stale bot commented Jan 3, 2023

Uh oh!

Uh oh!