diff --git a/src/BlockStorage/v2/Models/Snapshot.php b/src/BlockStorage/v2/Models/Snapshot.php index f36dbeba2..fbf266c4c 100644 --- a/src/BlockStorage/v2/Models/Snapshot.php +++ b/src/BlockStorage/v2/Models/Snapshot.php @@ -84,6 +84,8 @@ public function retrieve() } /** + * {@inheritdoc} + * * @param array $userOptions {@see \OpenStack\BlockStorage\v2\Api::postSnapshots} */ public function create(array $userOptions): Creatable diff --git a/src/BlockStorage/v2/Models/Volume.php b/src/BlockStorage/v2/Models/Volume.php index 55e886b6e..7e377f678 100644 --- a/src/BlockStorage/v2/Models/Volume.php +++ b/src/BlockStorage/v2/Models/Volume.php @@ -110,6 +110,8 @@ public function retrieve() } /** + * {@inheritdoc} + * * @param array $userOptions {@see \OpenStack\BlockStorage\v2\Api::postVolumes} */ public function create(array $userOptions): Creatable diff --git a/src/BlockStorage/v2/Models/VolumeType.php b/src/BlockStorage/v2/Models/VolumeType.php index c54425e2f..d85ecb937 100644 --- a/src/BlockStorage/v2/Models/VolumeType.php +++ b/src/BlockStorage/v2/Models/VolumeType.php @@ -25,6 +25,8 @@ class VolumeType extends OperatorResource implements Listable, Creatable, Update protected $resourcesKey = 'volume_types'; /** + * {@inheritdoc} + * * @param array $userOptions {@see \OpenStack\BlockStorage\v2\Api::postTypes} */ public function create(array $userOptions): Creatable diff --git a/src/BlockStorage/v2/Service.php b/src/BlockStorage/v2/Service.php index 5df79b550..b731d2c2d 100644 --- a/src/BlockStorage/v2/Service.php +++ b/src/BlockStorage/v2/Service.php @@ -31,6 +31,7 @@ public function createVolume(array $userOptions): Volume * * @param bool $detail if set to TRUE, more information will be returned * @param array $userOptions {@see Api::getVolumes} + * @return \Generator */ public function listVolumes(bool $detail = false, array $userOptions = []): \Generator { @@ -58,6 +59,9 @@ public function createVolumeType(array $userOptions): VolumeType return $this->model(VolumeType::class)->create($userOptions); } + /** + * @return \Generator + */ public function listVolumeTypes(): \Generator { return $this->model(VolumeType::class)->enumerate($this->api->getTypes(), []); @@ -79,6 +83,9 @@ public function createSnapshot(array $userOptions): Snapshot return $this->model(Snapshot::class)->create($userOptions); } + /** + * @return \Generator + */ public function listSnapshots(bool $detail = false, array $userOptions = []): \Generator { $def = (true === $detail) ? $this->api->getSnapshotsDetail() : $this->api->getSnapshots(); diff --git a/src/Common/Resource/AbstractResource.php b/src/Common/Resource/AbstractResource.php index 2dcf5632f..75f2b1bae 100644 --- a/src/Common/Resource/AbstractResource.php +++ b/src/Common/Resource/AbstractResource.php @@ -55,7 +55,7 @@ public function populateFromResponse(ResponseInterface $response) /** * Populates the current resource from a data array. * - * @return mixed|void + * @return self */ public function populateFromArray(array $array) { diff --git a/src/Common/Resource/Creatable.php b/src/Common/Resource/Creatable.php index 80ac7570d..d07280b09 100644 --- a/src/Common/Resource/Creatable.php +++ b/src/Common/Resource/Creatable.php @@ -12,7 +12,7 @@ interface Creatable /** * Create a new resource according to the configuration set in the options. * - * @return self + * @return static */ public function create(array $userOptions): Creatable; } diff --git a/src/Common/Resource/Listable.php b/src/Common/Resource/Listable.php index 9b8744ee7..a19499e3d 100644 --- a/src/Common/Resource/Listable.php +++ b/src/Common/Resource/Listable.php @@ -22,7 +22,7 @@ interface Listable * @param array $userVals The user values * @param callable $mapFn an optional callback that will be executed on every resource iteration * - * @returns void + * @returns \Generator */ public function enumerate(array $def, array $userVals = [], callable $mapFn = null); } diff --git a/src/Common/Resource/OperatorResource.php b/src/Common/Resource/OperatorResource.php index 35cf31864..11414e28e 100644 --- a/src/Common/Resource/OperatorResource.php +++ b/src/Common/Resource/OperatorResource.php @@ -68,7 +68,9 @@ private function getResourcesKey(): string } /** - * {@inheritdoc} + * Creates a generator for enumerating over a collection of resources returned by the request. + * + * @returns \Generator */ public function enumerate(array $def, array $userVals = [], callable $mapFn = null): \Generator { @@ -101,6 +103,11 @@ public function enumerate(array $def, array $userVals = [], callable $mapFn = nu return $iterator(); } + /** + * Extracts multiple instances of the current resource from a response. + * + * @return array + */ public function extractMultipleInstances(ResponseInterface $response, string $key = null): array { $key = $key ?: $this->getResourcesKey(); diff --git a/src/Common/Resource/ResourceInterface.php b/src/Common/Resource/ResourceInterface.php index ae3249dd0..346ec2674 100644 --- a/src/Common/Resource/ResourceInterface.php +++ b/src/Common/Resource/ResourceInterface.php @@ -15,21 +15,23 @@ interface ResourceInterface * All models which represent an API resource should be able to be populated * from a {@see ResponseInterface} object. * + * @param \Psr\Http\Message\ResponseInterface $response * @return self */ public function populateFromResponse(ResponseInterface $response); /** - * @return mixed + * @return self */ public function populateFromArray(array $data); /** - * @param string $name the name of the model class + * @template T of \OpenStack\Common\Resource\ResourceInterface + * @param class-string $class the name of the model class * @param mixed $data either a {@see ResponseInterface} or data array that will populate the newly * created model class * - * @return \OpenStack\Common\Resource\ResourceInterface + * @return T */ public function model(string $class, $data = null): ResourceInterface; } diff --git a/src/Compute/v2/Models/Keypair.php b/src/Compute/v2/Models/Keypair.php index 065052e2c..61c178659 100644 --- a/src/Compute/v2/Models/Keypair.php +++ b/src/Compute/v2/Models/Keypair.php @@ -75,6 +75,9 @@ public function retrieve() $this->populateFromResponse($response); } + /** + * {@inheritdoc} + */ public function create(array $userOptions): Creatable { $response = $this->execute($this->api->postKeypair(), $userOptions); diff --git a/src/Compute/v2/Models/Server.php b/src/Compute/v2/Models/Server.php index e2390fd43..85ab5c353 100644 --- a/src/Compute/v2/Models/Server.php +++ b/src/Compute/v2/Models/Server.php @@ -394,6 +394,8 @@ public function listAddresses(array $options = []): array /** * Returns Generator for InterfaceAttachment. + * + * @return \Generator */ public function listInterfaceAttachments(array $options = []): \Generator { @@ -541,6 +543,8 @@ public function parseMetadata(ResponseInterface $response): array /** * Returns Generator for SecurityGroups. + * + * @return \Generator */ public function listSecurityGroups(): \Generator { @@ -549,6 +553,8 @@ public function listSecurityGroups(): \Generator /** * Returns Generator for VolumeAttachment. + * + * @return \Generator */ public function listVolumeAttachments(): \Generator { diff --git a/src/Compute/v2/Service.php b/src/Compute/v2/Service.php index a67e33eb3..3d39c3de1 100644 --- a/src/Compute/v2/Service.php +++ b/src/Compute/v2/Service.php @@ -41,6 +41,7 @@ public function createServer(array $options): Server * the ID, name and links attributes are returned, saving bandwidth. * @param array $options {@see \OpenStack\Compute\v2\Api::getServers} * @param callable $mapFn a callable function that will be invoked on every iteration of the list + * @return \Generator */ public function listServers(bool $detailed = false, array $options = [], callable $mapFn = null): \Generator { @@ -73,6 +74,7 @@ public function getServer(array $options = []): Server * @param array $options {@see \OpenStack\Compute\v2\Api::getFlavors} * @param callable $mapFn a callable function that will be invoked on every iteration of the list * @param bool $detailed set to true to fetch flavors' details + * @return \Generator */ public function listFlavors(array $options = [], callable $mapFn = null, bool $detailed = false): \Generator { @@ -112,6 +114,7 @@ public function createFlavor(array $options = []): Flavor * * @param array $options {@see \OpenStack\Compute\v2\Api::getImages} * @param callable $mapFn a callable function that will be invoked on every iteration of the list + * @return \Generator */ public function listImages(array $options = [], callable $mapFn = null): \Generator { @@ -139,6 +142,7 @@ public function getImage(array $options = []): Image * * @param array $options {@see \OpenStack\Compute\v2\Api::getKeyPairs} * @param callable $mapFn a callable function that will be invoked on every iteration of the list + * @return \Generator */ public function listKeypairs(array $options = [], callable $mapFn = null): \Generator { @@ -193,6 +197,7 @@ public function getHypervisorStatistics(): HypervisorStatistic * the ID, name and links attributes are returned, saving bandwidth. * @param array $options {@see \OpenStack\Compute\v2\Api::getHypervisors} * @param callable $mapFn a callable function that will be invoked on every iteration of the list + * @return \Generator */ public function listHypervisors(bool $detailed = false, array $options = [], callable $mapFn = null): \Generator { @@ -216,6 +221,7 @@ public function getHypervisor(array $options = []): Hypervisor * * @param array $options {@see \OpenStack\Compute\v2\Api::getHosts} * @param callable $mapFn a callable function that will be invoked on every iteration of the list + * @return \Generator */ public function listHosts(array $options = [], callable $mapFn = null): \Generator { @@ -245,6 +251,7 @@ public function getHost(array $options = []): Host * * @param array $options {@see \OpenStack\Compute\v2\Api::getAvailabilityZones} * @param callable $mapFn a callable function that will be invoked on every iteration of the list + * @return \Generator */ public function listAvailabilityZones(array $options = [], callable $mapFn = null): \Generator { diff --git a/src/Identity/v3/Models/Domain.php b/src/Identity/v3/Models/Domain.php index 9118d38f9..83263ef99 100644 --- a/src/Identity/v3/Models/Domain.php +++ b/src/Identity/v3/Models/Domain.php @@ -75,6 +75,7 @@ public function delete() /** * @param array $options {@see \OpenStack\Identity\v3\Api::getUserRoles} + * @return \Generator */ public function listUserRoles(array $options = []): \Generator { @@ -115,6 +116,7 @@ public function revokeUserRole(array $options = []) /** * @param array $options {@see \OpenStack\Identity\v3\Api::getGroupRoles} + * @return \Generator */ public function listGroupRoles(array $options = []): \Generator { diff --git a/src/Identity/v3/Models/Group.php b/src/Identity/v3/Models/Group.php index 8bfee36b3..2854a92aa 100644 --- a/src/Identity/v3/Models/Group.php +++ b/src/Identity/v3/Models/Group.php @@ -77,6 +77,7 @@ public function delete() /** * @param array $options {@see \OpenStack\Identity\v3\Api::getGroupUsers} + * @return \Generator */ public function listUsers(array $options = []): \Generator { diff --git a/src/Identity/v3/Models/Project.php b/src/Identity/v3/Models/Project.php index 62041c69e..68beb3ce8 100644 --- a/src/Identity/v3/Models/Project.php +++ b/src/Identity/v3/Models/Project.php @@ -87,6 +87,7 @@ public function delete() /** * @param array $options {@see \OpenStack\Identity\v3\Api::getProjectUserRoles} + * @return \Generator */ public function listUserRoles(array $options = []): \Generator { @@ -127,6 +128,7 @@ public function revokeUserRole(array $options) /** * @param array $options {@see \OpenStack\Identity\v3\Api::getProjectGroupRoles} + * @return \Generator */ public function listGroupRoles(array $options = []): \Generator { diff --git a/src/Identity/v3/Models/User.php b/src/Identity/v3/Models/User.php index 81aa561e6..fb9480a1f 100644 --- a/src/Identity/v3/Models/User.php +++ b/src/Identity/v3/Models/User.php @@ -86,6 +86,9 @@ public function delete() $this->execute($this->api->deleteUser(), ['id' => $this->id]); } + /** + * @return \Generator + */ public function listGroups(): \Generator { $options['id'] = $this->id; @@ -93,6 +96,9 @@ public function listGroups(): \Generator return $this->model(Group::class)->enumerate($this->api->getUserGroups(), $options); } + /** + * @return \Generator + */ public function listProjects(): \Generator { return $this->model(Project::class)->enumerate($this->api->getUserProjects(), ['id' => $this->id]); diff --git a/src/Identity/v3/Service.php b/src/Identity/v3/Service.php index ca16aac59..fd6fa07e9 100644 --- a/src/Identity/v3/Service.php +++ b/src/Identity/v3/Service.php @@ -128,6 +128,7 @@ public function createService(array $options): Models\Service * will need to use retrieve() to pull in the full state of the remote resource from the API. * * @param array $options {@see \OpenStack\Identity\v3\Api::getServices} + * @return \Generator */ public function listServices(array $options = []): \Generator { @@ -172,6 +173,7 @@ public function getEndpoint(string $id): Models\Endpoint * will need to use retrieve() to pull in the full state of the remote resource from the API. * * @param array $options {@see \OpenStack\Identity\v3\Api::getEndpoints} + * @return \Generator */ public function listEndpoints(array $options = []): \Generator { @@ -194,6 +196,7 @@ public function createDomain(array $options): Models\Domain * will need to use retrieve() to pull in the full state of the remote resource from the API. * * @param array $options {@see \OpenStack\Identity\v3\Api::getDomains} + * @return \Generator */ public function listDomains(array $options = []): \Generator { @@ -227,6 +230,7 @@ public function createProject(array $options): Models\Project * will need to use retrieve() to pull in the full state of the remote resource from the API. * * @param array $options {@see \OpenStack\Identity\v3\Api::getProjects} + * @return \Generator */ public function listProjects(array $options = []): \Generator { @@ -260,6 +264,7 @@ public function createUser(array $options): Models\User * will need to use retrieve() to pull in the full state of the remote resource from the API. * * @param array $options {@see \OpenStack\Identity\v3\Api::getUsers} + * @return \Generator */ public function listUsers(array $options = []): \Generator { @@ -293,6 +298,7 @@ public function createGroup(array $options): Models\Group * will need to use retrieve() to pull in the full state of the remote resource from the API. * * @param array $options {@see \OpenStack\Identity\v3\Api::getGroups} + * @return \Generator */ public function listGroups(array $options = []): \Generator { @@ -324,6 +330,8 @@ public function createCredential(array $options): Models\Credential * Returns a generator which will yield a collection of credential objects. The elements which generators yield can * be accessed using a foreach loop. Often the API will not return the full state of the resource in collections; * you will need to use retrieve() to pull in the full state of the remote resource from the API. + * + * @return \Generator */ public function listCredentials(): \Generator { @@ -357,6 +365,7 @@ public function createRole(array $options): Models\Role * will need to use retrieve() to pull in the full state of the remote resource from the API. * * @param array $options {@see \OpenStack\Identity\v3\Api::getRoles} + * @return \Generator */ public function listRoles(array $options = []): \Generator { @@ -369,6 +378,7 @@ public function listRoles(array $options = []): \Generator * collections; you will need to use retrieve() to pull in the full state of the remote resource from the API. * * @param array $options {@see \OpenStack\Identity\v3\Api::getRoleAssignments} + * @return \Generator */ public function listRoleAssignments(array $options = []): \Generator { @@ -391,6 +401,7 @@ public function createPolicy(array $options): Models\Policy * will need to use retrieve() to pull in the full state of the remote resource from the API. * * @param array $options {@see \OpenStack\Identity\v3\Api::getPolicies} + * @return \Generator */ public function listPolicies(array $options = []): \Generator { diff --git a/src/Images/v2/Models/Image.php b/src/Images/v2/Models/Image.php index 8c0e88628..6cf172cfd 100644 --- a/src/Images/v2/Models/Image.php +++ b/src/Images/v2/Models/Image.php @@ -115,6 +115,9 @@ public function populateFromArray(array $data): self return $this; } + /** + * {@inheritdoc} + */ public function create(array $data): Creatable { $response = $this->execute($this->api->postImages(), $data); @@ -213,6 +216,9 @@ public function addMember($memberId): Member return $this->model(Member::class, ['imageId' => $this->id, 'id' => $memberId])->create([]); } + /** + * @return \Generator + */ public function listMembers(): \Generator { return $this->model(Member::class)->enumerate($this->api->getImageMembers(), ['imageId' => $this->id]); diff --git a/src/Images/v2/Models/Member.php b/src/Images/v2/Models/Member.php index c3cb00b7b..4b6c6dbb7 100644 --- a/src/Images/v2/Models/Member.php +++ b/src/Images/v2/Models/Member.php @@ -54,6 +54,9 @@ protected function getAliases(): array ]; } + /** + * {@inheritdoc} + */ public function create(array $userOptions): Creatable { $response = $this->executeWithState($this->api->postImageMembers()); diff --git a/src/Images/v2/Service.php b/src/Images/v2/Service.php index 9c977cf25..bcb8f4349 100644 --- a/src/Images/v2/Service.php +++ b/src/Images/v2/Service.php @@ -17,6 +17,9 @@ public function createImage(array $data): Image return $this->model(Image::class)->create($data); } + /** + * @return \Generator + */ public function listImages(array $data = []): \Generator { return $this->model(Image::class)->enumerate($this->api->getImages(), $data); diff --git a/src/Metric/v1/Gnocchi/Models/Resource.php b/src/Metric/v1/Gnocchi/Models/Resource.php index 33c39d89a..c6041dcd3 100644 --- a/src/Metric/v1/Gnocchi/Models/Resource.php +++ b/src/Metric/v1/Gnocchi/Models/Resource.php @@ -138,6 +138,7 @@ public function getMetricMeasures(array $options = []): array /** * @param array $options {@see \OpenStack\Metric\v1\Gnocchi\Api::getResourceMetrics} + * @return \Generator */ public function listResourceMetrics(array $options = []): \Generator { diff --git a/src/Metric/v1/Gnocchi/Service.php b/src/Metric/v1/Gnocchi/Service.php index c44dfafb5..6e418b146 100644 --- a/src/Metric/v1/Gnocchi/Service.php +++ b/src/Metric/v1/Gnocchi/Service.php @@ -18,6 +18,7 @@ class Service extends AbstractService { /** * Retrieves a collection of \OpenStack\Metric\v1\Gnocchi\Models\ResourceType type in a generator format. + * @return \Generator */ public function listResourceTypes(): \Generator { @@ -28,6 +29,7 @@ public function listResourceTypes(): \Generator * Retrieves a collection of \OpenStack\Metric\v1\Gnocchi\Models\Resource type in a generator format. * * @param array $options {@see \OpenStack\Metric\v1\Gnocchi\Api::getResources} + * @return \Generator */ public function listResources(array $options = []): \Generator { @@ -55,6 +57,7 @@ public function getResource(array $options = []): Resource * Retrieves a collection of \OpenStack\Metric\v1\Gnocchi\Models\Resource type in a generator format. * * @param array $options {@see \OpenStack\Metric\v1\Gnocchi\Api::searchResources} + * @return \Generator */ public function searchResources(array $options = []): \Generator { @@ -94,6 +97,7 @@ public function getMetric(string $id): Metric * Retrieves a collection of Metric type in a generator format. * * @param array $options {@see \OpenStack\Metric\v1\Gnocchi\Api::getMetrics} + * @return \Generator */ public function listMetrics(array $options = []): \Generator { diff --git a/src/Networking/v2/Extensions/Layer3/Models/FloatingIp.php b/src/Networking/v2/Extensions/Layer3/Models/FloatingIp.php index 07dc0ddba..048b942b2 100644 --- a/src/Networking/v2/Extensions/Layer3/Models/FloatingIp.php +++ b/src/Networking/v2/Extensions/Layer3/Models/FloatingIp.php @@ -51,6 +51,9 @@ class FloatingIp extends OperatorResource implements Listable, Creatable, Retrie protected $resourceKey = 'floatingip'; protected $resourcesKey = 'floatingips'; + /** + * {@inheritdoc} + */ public function create(array $userOptions): Creatable { $response = $this->execute($this->api->postFloatingIps(), $userOptions); diff --git a/src/Networking/v2/Extensions/Layer3/Models/Router.php b/src/Networking/v2/Extensions/Layer3/Models/Router.php index f3e701756..63e89bbe4 100644 --- a/src/Networking/v2/Extensions/Layer3/Models/Router.php +++ b/src/Networking/v2/Extensions/Layer3/Models/Router.php @@ -57,6 +57,9 @@ protected function getAliases(): array ]; } + /** + * {@inheritdoc} + */ public function create(array $userOptions): Creatable { $response = $this->execute($this->api->postRouters(), $userOptions); diff --git a/src/Networking/v2/Extensions/Layer3/Service.php b/src/Networking/v2/Extensions/Layer3/Service.php index 9f9b04de1..c033c4b7f 100644 --- a/src/Networking/v2/Extensions/Layer3/Service.php +++ b/src/Networking/v2/Extensions/Layer3/Service.php @@ -31,6 +31,9 @@ public function getFloatingIp($id): FloatingIp return $this->floatingIp(['id' => $id]); } + /** + * @return \Generator + */ public function listFloatingIps(array $options = []): \Generator { return $this->floatingIp()->enumerate($this->api->getFloatingIps(), $options); @@ -46,6 +49,9 @@ public function getRouter($id): Router return $this->router(['id' => $id]); } + /** + * @return \Generator + */ public function listRouters(array $options = []): \Generator { return $this->router()->enumerate($this->api->getRouters(), $options); diff --git a/src/Networking/v2/Extensions/SecurityGroups/Service.php b/src/Networking/v2/Extensions/SecurityGroups/Service.php index cf10b733b..088efd152 100644 --- a/src/Networking/v2/Extensions/SecurityGroups/Service.php +++ b/src/Networking/v2/Extensions/SecurityGroups/Service.php @@ -21,6 +21,10 @@ private function securityGroupRule(array $info = []): SecurityGroupRule return $this->model(SecurityGroupRule::class, $info); } + /** + * @param array $options + * @return \Generator + */ public function listSecurityGroups(array $options = []): \Generator { return $this->securityGroup()->enumerate($this->api->getSecurityGroups(), $options); @@ -36,6 +40,9 @@ public function getSecurityGroup(string $id): SecurityGroup return $this->securityGroup(['id' => $id]); } + /** + * @return \Generator + */ public function listSecurityGroupRules(): \Generator { return $this->securityGroupRule()->enumerate($this->api->getSecurityRules()); diff --git a/src/Networking/v2/Service.php b/src/Networking/v2/Service.php index 2e1f7169d..e99c6176a 100644 --- a/src/Networking/v2/Service.php +++ b/src/Networking/v2/Service.php @@ -57,6 +57,7 @@ public function getNetwork(string $id): Network * List networks. * * @param array $options {@see \OpenStack\Networking\v2\Api::getNetworks} + * @return \Generator */ public function listNetworks(array $options = []): \Generator { @@ -99,6 +100,7 @@ public function getSubnet(string $id): Subnet * List subnets. * * @param array $options {@see \OpenStack\Networking\v2\Api::getSubnets} + * @return \Generator */ public function listSubnets(array $options = []): \Generator { @@ -141,6 +143,7 @@ public function getPort(string $id): Port * List ports. * * @param array $options {@see \OpenStack\Networking\v2\Api::getPorts} + * @return \Generator */ public function listPorts(array $options = []): \Generator { @@ -149,6 +152,8 @@ public function listPorts(array $options = []): \Generator /** * Lists quotas for projects with non-default quota values. + * + * @return \Generator */ public function listQuotas(): \Generator { @@ -180,6 +185,8 @@ public function getDefaultQuota(string $tenantId): Quota /** * Lists loadbalancers for projects. + * + * @return \Generator */ public function listLoadBalancers(): \Generator { @@ -206,6 +213,8 @@ public function createLoadBalancer(array $options): LoadBalancer /** * Lists loadbalancer listeners. + * + * @return \Generator */ public function listLoadBalancerListeners(): \Generator { @@ -232,6 +241,8 @@ public function createLoadBalancerListener(array $options): LoadBalancerListener /** * Lists loadbalancer pools. + * + * @return \Generator */ public function listLoadBalancerPools(): \Generator { @@ -258,6 +269,8 @@ public function createLoadBalancerPool(array $options): LoadBalancerPool /** * Lists loadbalancer members. + * + * @return \Generator */ public function listLoadBalancerMembers(string $poolId): \Generator { @@ -284,6 +297,8 @@ public function createLoadBalancerMember(array $options): LoadBalancerMember /** * Lists loadbalancer healthmonitors. + * + * @return \Generator */ public function listLoadBalancerHealthMonitors(): \Generator { diff --git a/src/ObjectStore/v1/Models/Container.php b/src/ObjectStore/v1/Models/Container.php index 4736d2a1e..6501bfd90 100644 --- a/src/ObjectStore/v1/Models/Container.php +++ b/src/ObjectStore/v1/Models/Container.php @@ -57,6 +57,7 @@ public function populateFromResponse(ResponseInterface $response): self * * @param array $options {@see \OpenStack\ObjectStore\v1\Api::getContainer} * @param callable|null $mapFn allows a function to be mapped over each element + * @return \Generator */ public function listObjects(array $options = [], callable $mapFn = null): \Generator { @@ -82,9 +83,9 @@ public function retrieve() } /** - * @param array $data {@see \OpenStack\ObjectStore\v1\Api::putContainer} + * {@inheritdoc} * - * @return $this + * @param array $data {@see \OpenStack\ObjectStore\v1\Api::putContainer} */ public function create(array $data): Creatable { diff --git a/src/ObjectStore/v1/Models/StorageObject.php b/src/ObjectStore/v1/Models/StorageObject.php index be4f2c8c1..d639a0cd9 100644 --- a/src/ObjectStore/v1/Models/StorageObject.php +++ b/src/ObjectStore/v1/Models/StorageObject.php @@ -97,9 +97,9 @@ public function getPublicUri(): Uri } /** - * @param array $data {@see \OpenStack\ObjectStore\v1\Api::putObject} + * {@inheritdoc} * - * @return $this + * @param array $data {@see \OpenStack\ObjectStore\v1\Api::putObject} */ public function create(array $data): Creatable { diff --git a/src/ObjectStore/v1/Service.php b/src/ObjectStore/v1/Service.php index 0f41da3bd..ce029479f 100644 --- a/src/ObjectStore/v1/Service.php +++ b/src/ObjectStore/v1/Service.php @@ -27,6 +27,7 @@ public function getAccount(): Account * * @param array $options {@see \OpenStack\ObjectStore\v1\Api::getAccount} * @param callable|null $mapFn allows a function to be mapped over each element in the collection + * @return \Generator */ public function listContainers(array $options = [], callable $mapFn = null): \Generator {