Merge pull request #160 from php-api-clients/pass-certain-information-on-to-file-templating

Pass certain information on to file templating

Author: WyriHaximus

example/templates/README.md

@@ -8,3 +8,37 @@
 [![License](https://poser.pugx.org/api-clients/{{ packageName }}/license.png)](https://packagist.org/packages/api-clients/{{ packageName }})
 
 Non-Blocking first {{ fullName }} client, this is a read only sub split, see [`github-root`](https://github.com/php-api-clients/github-root).
+
+{% if client.configuration.entryPoints.call == true or client.configuration.entryPoints.operations == true %}
+## Supported operations
+
+{% for operation in client.operations %}
+
+### {{ operation.operationId }}
+
+{{ operation.summary }}
+
+{% if client.configuration.entryPoints.call == true %}
+Using the `call` method:
+```php
+$client->call('{{ operation.matchMethod }} {{ operation.path }}'{% if operation.parameters|length > 0 %}, [
+{% for parameter in operation.parameters %}        '{{ parameter.targetName }}' => {% if parameter.type == 'string' %}'{% endif %}{{ parameter.example.raw }}{% if parameter.type == 'string' %}'{% endif %},
+{% endfor %}]{% endif %});
+```
+{% endif %}
+
+{% if client.configuration.entryPoints.operations == true %}
+Operations method:
+```php
+$client->operations()->{{ operation.groupCamel }}()->{{ operation.nameCamel }}({% if operation.parameters|length > 0 %}
+{% for parameter in operation.parameters %}        {{ parameter.targetName }}: {% if parameter.type == 'string' %}'{% endif %}{{ parameter.example.raw }}{% if parameter.type == 'string' %}'{% endif %},
+{% endfor %}{% endif %});
+```
+{% endif %}
+
+{% if operation.externalDocs != null %}
+You can find more about this operation over at the [{{ operation.externalDocs.description }}]({{ operation.externalDocs.url }}).
+{% endif %}
+
+{% endfor %}
+{% endif %}

src/Gatherer/Operation.php

@@ -150,15 +150,22 @@ public static function gather(
             $returnType[] = '\\' . ResponseInterface::class;
         }
 
+        $name = lcfirst(trim(Utils::basename($className), '\\'));
+        $group = strlen(trim(trim(Utils::dirname($className), '\\'), '.')) > 0 ? trim(Utils::dirname($className), '\\') : 'Fallback';
+
         return new \ApiClients\Tools\OpenApiClientGenerator\Representation\Operation(
             ClassString::factory($baseNamespace, 'Operation\\' . Utils::fixKeyword($className)),
             ClassString::factory($baseNamespace, $classNameSanitized),
             ClassString::factory($baseNamespace, 'Operator\\' . Utils::fixKeyword($className)),
-            lcfirst(trim(Utils::basename($className), '\\')),
-            strlen(trim(trim(Utils::dirname($className), '\\'), '.')) > 0 ? trim(Utils::dirname($className), '\\') : 'Fallback',
+            $name,
+            (new Convert($name))->toCamel(),
+            $group,
+            (new Convert($group))->toCamel(),
             $operation->operationId,
             strtoupper($matchMethod),
             strtoupper($method),
+            $operation->summary,
+            $operation->externalDocs,
             $path,
             $metaData,
             array_unique($returnType),

src/Generator.php

@@ -570,12 +570,23 @@ private function oneClient(
         \WyriHaximus\SubSplitTools\Files::setUp(
             $configurationLocation . $this->configuration->templates->dir,
             $configurationLocation . $this->configuration->destination->root . DIRECTORY_SEPARATOR,
-            (static function (string $namespace, ?array $variables): array {
+            (static function (string $namespace, ?array $variables, array $operations, array $webHooks, Configuration $configuration): array {
                 $vars              = $variables ?? [];
                 $vars['namespace'] = $namespace;
+                $vars['client'] = [
+                    'configuration' => $configuration,
+                    'operations' => $operations,
+                    'webHooks' => $webHooks,
+                ];
 
                 return $vars;
-            })($this->configuration->namespace->source . '\\', $this->configuration->templates->variables),
+            })(
+                $this->configuration->namespace->source . '\\',
+                $this->configuration->templates->variables,
+                $operations,
+                $webHooks,
+                $this->configuration,
+            ),
         );
         $this->statusOutput->markStepDone('generating_templated_files');
     }
@@ -727,12 +738,6 @@ private function subSplitClient(
         $this->statusOutput->itemForStep('generating_schemas', count($schemas));
         foreach ($schemas as $schema) {
             if ($throwableSchemaRegistry->has($schema->className->relative)) {
-                yield from Schema::generate(
-                    $this->configuration->subSplit->subSplitsDestination . DIRECTORY_SEPARATOR . $this->splitPathPrefix($this->configuration->subSplit->sectionPackage, 'common') . $this->configuration->destination->source,
-                    $schema,
-                    [...$schemaRegistry->aliasesForClassName($schema->className->relative)],
-                );
-
                 yield from Error::generate(
                     $this->configuration->subSplit->subSplitsDestination . DIRECTORY_SEPARATOR . $this->splitPathPrefix($this->configuration->subSplit->sectionPackage, 'common') . $this->configuration->destination->source,
                     $schema,

src/Representation/Operation.php

@@ -5,6 +5,7 @@
 namespace ApiClients\Tools\OpenApiClientGenerator\Representation;
 
 use ApiClients\Tools\OpenApiClientGenerator\ClassString;
+use cebe\openapi\spec\ExternalDocumentation;
 
 final readonly class Operation
 {
@@ -21,10 +22,14 @@ public function __construct(
         public ClassString $classNameSanitized,
         public ClassString $operatorClassName,
         public string $name,
+        public string $nameCamel,
         public string $group,
+        public string $groupCamel,
         public string $operationId,
         public string $matchMethod,
         public string $method,
+        public string $summary,
+        public ?ExternalDocumentation $externalDocs,
         public string $path,
         /** @var array<mixed> $metaData */
         public array $metaData,