Renamed class Object to BaseObject

Author: mrwogu

samples/object_store/v1/objects/create.php

@@ -17,7 +17,7 @@
     'content' => '{objectContent}',
 ];
 
-/** @var \OpenStack\ObjectStore\v1\Models\Object $object */
+/** @var \OpenStack\ObjectStore\v1\Models\BaseObject $object */
 $object = $openstack->objectStoreV1()
                     ->getContainer('{containerName}')
                     ->createObject($options);

samples/object_store/v1/objects/create_from_stream.php

@@ -22,7 +22,7 @@
     'stream' => $stream,
 ];
 
-/** @var \OpenStack\ObjectStore\v1\Models\Object $object */
+/** @var \OpenStack\ObjectStore\v1\Models\BaseObject $object */
 $object = $openstack->objectStoreV1()
     ->getContainer('{containerName}')
     ->createObject($options);

samples/object_store/v1/objects/create_large_object.php

@@ -27,7 +27,7 @@
 $options['segmentContainer'] = 'test_segments';
 
 
-/** @var \OpenStack\ObjectStore\v1\Models\Object $object */
+/** @var \OpenStack\ObjectStore\v1\Models\BaseObject $object */
 $object = $openstack->objectStoreV1()
                     ->getContainer('test')
                     ->createLargeObject($options);

samples/object_store/v1/objects/get.php

@@ -12,7 +12,7 @@
     'scope'   => ['project' => ['id' => '{projectId}']]
 ]);
 
-/** @var \OpenStack\ObjectStore\v1\Models\Object $object */
+/** @var \OpenStack\ObjectStore\v1\Models\BaseObject $object */
 $object = $openstack->objectStoreV1()
                     ->getContainer('{containerName}')
                     ->getObject('{objectName}');

samples/object_store/v1/objects/list.php

@@ -16,5 +16,5 @@
                        ->getContainer('{containerName}');
 
 foreach ($container->listObjects() as $object) {
-    /** @var \OpenStack\ObjectStore\v1\Models\Object $object */
+    /** @var \OpenStack\ObjectStore\v1\Models\BaseObject $object */
 }

src/ObjectStore/v1/Models/Object.php src/ObjectStore/v1/Models/BaseObject.phpsrc/ObjectStore/v1/Models/Object.php renamed to src/ObjectStore/v1/Models/BaseObject.php

@@ -14,7 +14,7 @@
 /**
  * @property \OpenStack\ObjectStore\v1\Api $api
  */
-class Object extends OperatorResource implements Creatable, Deletable, HasMetadata
+class BaseObject extends OperatorResource implements Creatable, Deletable, HasMetadata
 {
     use MetadataTrait;
 

src/ObjectStore/v1/Models/Container.php

@@ -61,7 +61,7 @@ public function populateFromResponse(ResponseInterface $response): self
     public function listObjects(array $options = [], callable $mapFn = null): \Generator
     {
         $options = array_merge($options, ['name' => $this->name, 'format' => 'json']);
-        return $this->model(Object::class)->enumerate($this->api->getContainer(), $options, $mapFn);
+        return $this->model(BaseObject::class)->enumerate($this->api->getContainer(), $options, $mapFn);
     }
 
     /**
@@ -136,17 +136,17 @@ public function getMetadata(): array
     }
 
     /**
-     * Retrieves an Object and populates its `name` and `containerName` properties according to the name provided and
+     * Retrieves an BaseObject and populates its `name` and `containerName` properties according to the name provided and
      * the name of this container. A HTTP call will not be executed by default - you need to call
-     * {@see Object::retrieve} or {@see Object::download} on the returned Object object to do that.
+     * {@see BaseObject::retrieve} or {@see BaseObject::download} on the returned BaseObject object to do that.
      *
      * @param string $name The name of the object
      *
-     * @return Object
+     * @return BaseObject
      */
-    public function getObject($name): Object
+    public function getObject($name): BaseObject
     {
-        return $this->model(Object::class, ['containerName' => $this->name, 'name' => $name]);
+        return $this->model(BaseObject::class, ['containerName' => $this->name, 'name' => $name]);
     }
 
     /**
@@ -179,13 +179,13 @@ public function objectExists(string $name): bool
      *
      * @return Object
      */
-    public function createObject(array $data): Object
+    public function createObject(array $data): BaseObject
     {
-        return $this->model(Object::class)->create($data + ['containerName' => $this->name]);
+        return $this->model(BaseObject::class)->create($data + ['containerName' => $this->name]);
     }
 
     /**
-     * Creates a Dynamic Large Object by chunking a file into smaller segments and uploading them into a holding
+     * Creates a Dynamic Large BaseObject by chunking a file into smaller segments and uploading them into a holding
      * container. When this completes, a manifest file is uploaded which references the prefix of the segments,
      * allowing concatenation when a request is executed against the manifest.
      *
@@ -195,9 +195,9 @@ public function createObject(array $data): Object
      * @param string $data['segmentPrefix']    The prefix that will come before each segment. If omitted, a default
      *                                         is used: name/timestamp/filesize
      *
-     * @return Object
+     * @return BaseObject
      */
-    public function createLargeObject(array $data): Object
+    public function createLargeObject(array $data): BaseObject
     {
         /** @var \Psr\Http\Message\StreamInterface $stream */
         $stream = $data['stream'];
@@ -218,7 +218,7 @@ public function createLargeObject(array $data): Object
         $count    = 0;
 
         while (!$stream->eof() && $count < round($stream->getSize() / $segmentSize)) {
-            $promises[] = $this->model(Object::class)->createAsync([
+            $promises[] = $this->model(BaseObject::class)->createAsync([
                 'name'          => sprintf("%s/%d", $segmentPrefix, ++$count),
                 'stream'        => new LimitStream($stream, $segmentSize, ($count - 1) * $segmentSize),
                 'containerName' => $segmentContainer,

tests/unit/ObjectStore/v1/Models/ContainerTest.php

@@ -8,7 +8,7 @@
 use OpenStack\Common\Error\BadResponseError;
 use OpenStack\ObjectStore\v1\Api;
 use OpenStack\ObjectStore\v1\Models\Container;
-use OpenStack\ObjectStore\v1\Models\Object;
+use OpenStack\ObjectStore\v1\Models\BaseObject;
 use OpenStack\Test\TestCase;
 use Prophecy\Argument;
 
@@ -95,7 +95,7 @@ public function test_It_Gets_Object()
     {
         $object = $this->container->getObject('foo.txt');
 
-        $this->assertInstanceOf(Object::class, $object);
+        $this->assertInstanceOf(BaseObject::class, $object);
         $this->assertEquals('foo.txt', $object->name);
     }
 
@@ -135,7 +135,7 @@ public function test_it_lists_objects()
             ->willReturn($this->getFixture('GET_Container'));
 
         foreach ($this->container->listObjects(['limit' => 2]) as $object) {
-            $this->assertInstanceOf(Object::class, $object);
+            $this->assertInstanceOf(BaseObject::class, $object);
         }
     }
 

tests/unit/ObjectStore/v1/Models/ObjectTest.php

@@ -5,7 +5,7 @@
 use function GuzzleHttp\Psr7\uri_for;
 use GuzzleHttp\Psr7\Stream;
 use OpenStack\ObjectStore\v1\Api;
-use OpenStack\ObjectStore\v1\Models\Object;
+use OpenStack\ObjectStore\v1\Models\BaseObject;
 use OpenStack\Test\TestCase;
 
 class ObjectTest extends TestCase
@@ -21,7 +21,7 @@ public function setUp()
 
         $this->rootFixturesDir = dirname(__DIR__);
 
-        $this->object = new Object($this->client->reveal(), new Api());
+        $this->object = new BaseObject($this->client->reveal(), new Api());
         $this->object->containerName = self::CONTAINER;
         $this->object->name = self::NAME;
     }