Generate the phpdoc for the static create method of objects (#1464)

Author: stof

src/CodeGenerator/src/Generator/InputGenerator.php

@@ -270,11 +270,16 @@ public function generate(Operation $operation): ClassName
         }
 
         // Add named constructor
-        $classBuilder->addMethod('create')
+        $createMethod = $classBuilder->addMethod('create')
             ->setStatic(true)
             ->setReturnType('self')
-            ->setBody('return $input instanceof self ? $input : new self($input);')
-            ->addParameter('input');
+            ->setBody('return $input instanceof self ? $input : new self($input);');
+        $createMethod->addParameter('input');
+        [$doc, $memberClassNames] = $this->typeGenerator->generateDocblock($shape, $className, true, true, false, ['  \'@region\'?: string|null,']);
+        $createMethod->addComment($doc);
+        foreach ($memberClassNames as $memberClassName) {
+            $classBuilder->addUse($memberClassName->getFqdn());
+        }
 
         $constructorBody .= 'parent::__construct($input);';
         $constructor = $classBuilder->addMethod('__construct');

src/CodeGenerator/src/Generator/ObjectGenerator.php

@@ -147,20 +147,30 @@ private function isShapeUsedInput(StructureShape $shape): bool
     private function namedConstructor(StructureShape $shape, ClassBuilder $classBuilder): void
     {
         if (empty($shape->getMembers())) {
-            $classBuilder->addMethod('create')
+            $createMethod = $classBuilder->addMethod('create')
                 ->setStatic(true)
                 ->setReturnType('self')
-                ->setBody('return $input instanceof self ? $input : new self();')
-                ->addParameter('input');
+                ->setBody('return $input instanceof self ? $input : new self();');
+            $createMethod->addParameter('input');
+            [$doc, $memberClassNames] = $this->typeGenerator->generateDocblock($shape, $this->generated[$shape->getName()], true, false, true);
+            $createMethod->addComment($doc);
+            foreach ($memberClassNames as $memberClassName) {
+                $classBuilder->addUse($memberClassName->getFqdn());
+            }
 
             return;
         }
 
-        $classBuilder->addMethod('create')
+        $createMethod = $classBuilder->addMethod('create')
             ->setStatic(true)
             ->setReturnType('self')
-            ->setBody('return $input instanceof self ? $input : new self($input);')
-            ->addParameter('input');
+            ->setBody('return $input instanceof self ? $input : new self($input);');
+        $createMethod->addParameter('input');
+        [$doc, $memberClassNames] = $this->typeGenerator->generateDocblock($shape, $this->generated[$shape->getName()], true, false, true);
+        $createMethod->addComment($doc);
+        foreach ($memberClassNames as $memberClassName) {
+            $classBuilder->addUse($memberClassName->getFqdn());
+        }
 
         // We need a constructor
         $constructor = $classBuilder->addMethod('__construct');

src/Core/src/Sts/Input/AssumeRoleRequest.php

@@ -260,6 +260,22 @@ public function __construct(array $input = [])
         parent::__construct($input);
     }
 
+    /**
+     * @param array{
+     *   RoleArn?: string,
+     *   RoleSessionName?: string,
+     *   PolicyArns?: PolicyDescriptorType[],
+     *   Policy?: string,
+     *   DurationSeconds?: int,
+     *   Tags?: Tag[],
+     *   TransitiveTagKeys?: string[],
+     *   ExternalId?: string,
+     *   SerialNumber?: string,
+     *   TokenCode?: string,
+     *   SourceIdentity?: string,
+     *   '@region'?: string|null,
+     * }|AssumeRoleRequest $input
+     */
     public static function create($input): self
     {
         return $input instanceof self ? $input : new self($input);

src/Core/src/Sts/Input/AssumeRoleWithWebIdentityRequest.php

@@ -153,6 +153,18 @@ public function __construct(array $input = [])
         parent::__construct($input);
     }
 
+    /**
+     * @param array{
+     *   RoleArn?: string,
+     *   RoleSessionName?: string,
+     *   WebIdentityToken?: string,
+     *   ProviderId?: string,
+     *   PolicyArns?: PolicyDescriptorType[],
+     *   Policy?: string,
+     *   DurationSeconds?: int,
+     *   '@region'?: string|null,
+     * }|AssumeRoleWithWebIdentityRequest $input
+     */
     public static function create($input): self
     {
         return $input instanceof self ? $input : new self($input);

src/Core/src/Sts/Input/GetCallerIdentityRequest.php

@@ -18,6 +18,11 @@ public function __construct(array $input = [])
         parent::__construct($input);
     }
 
+    /**
+     * @param array{
+     *   '@region'?: string|null,
+     * }|GetCallerIdentityRequest $input
+     */
     public static function create($input): self
     {
         return $input instanceof self ? $input : new self($input);

src/Core/src/Sts/ValueObject/AssumedRoleUser.php

@@ -33,6 +33,12 @@ public function __construct(array $input)
         $this->arn = $input['Arn'] ?? null;
     }
 
+    /**
+     * @param array{
+     *   AssumedRoleId: string,
+     *   Arn: string,
+     * }|AssumedRoleUser $input
+     */
     public static function create($input): self
     {
         return $input instanceof self ? $input : new self($input);

src/Core/src/Sts/ValueObject/Credentials.php

@@ -43,6 +43,14 @@ public function __construct(array $input)
         $this->expiration = $input['Expiration'] ?? null;
     }
 
+    /**
+     * @param array{
+     *   AccessKeyId: string,
+     *   SecretAccessKey: string,
+     *   SessionToken: string,
+     *   Expiration: \DateTimeImmutable,
+     * }|Credentials $input
+     */
     public static function create($input): self
     {
         return $input instanceof self ? $input : new self($input);

src/Core/src/Sts/ValueObject/PolicyDescriptorType.php

@@ -27,6 +27,11 @@ public function __construct(array $input)
         $this->arn = $input['arn'] ?? null;
     }
 
+    /**
+     * @param array{
+     *   arn?: null|string,
+     * }|PolicyDescriptorType $input
+     */
     public static function create($input): self
     {
         return $input instanceof self ? $input : new self($input);

src/Core/src/Sts/ValueObject/Tag.php

@@ -45,6 +45,12 @@ public function __construct(array $input)
         $this->value = $input['Value'] ?? null;
     }
 
+    /**
+     * @param array{
+     *   Key: string,
+     *   Value: string,
+     * }|Tag $input
+     */
     public static function create($input): self
     {
         return $input instanceof self ? $input : new self($input);

src/Service/AppSync/src/Input/CreateResolverRequest.php

@@ -157,6 +157,24 @@ public function __construct(array $input = [])
         parent::__construct($input);
     }
 
+    /**
+     * @param array{
+     *   apiId?: string,
+     *   typeName?: string,
+     *   fieldName?: string,
+     *   dataSourceName?: string,
+     *   requestMappingTemplate?: string,
+     *   responseMappingTemplate?: string,
+     *   kind?: ResolverKind::*,
+     *   pipelineConfig?: PipelineConfig|array,
+     *   syncConfig?: SyncConfig|array,
+     *   cachingConfig?: CachingConfig|array,
+     *   maxBatchSize?: int,
+     *   runtime?: AppSyncRuntime|array,
+     *   code?: string,
+     *   '@region'?: string|null,
+     * }|CreateResolverRequest $input
+     */
     public static function create($input): self
     {
         return $input instanceof self ? $input : new self($input);