DigitalOceanV2\Api\Volume

Complexity

Total Complexity

15

Size/Duplication

Total Lines	248
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	getAll()	0	13	2
A	getByNameAndRegion()	0	12	1
A	getById()	0	8	1
A	getSnapshots()	0	14	1
A	create()	0	19	2
A	delete()	0	4	1
A	deleteWithNameAndRegion()	0	4	1
A	attach()	0	14	1
A	detach()	0	14	1
A	resize()	0	14	1
A	snapshot()	0	12	1
A	getActionById()	0	8	1
A	getActions()	0	12	1

<?php

/*
 * This file is part of the DigitalOceanV2 library.
 *
 * (c) Antoine Corcy <contact@sbin.dk>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace DigitalOceanV2\Api;

use DigitalOceanV2\Entity\Action as ActionEntity;
use DigitalOceanV2\Entity\Snapshot as SnapshotEntity;
use DigitalOceanV2\Entity\Volume as VolumeEntity;

/**
 * @author Yassir Hannoun <yassir.hannoun@gmail.com>
 */
class Volume extends AbstractApi
{
    /**
     * @param string $regionSlug restricts results to volumes available in a specific region
     *
     * @return VolumeEntity[] Lists all of the Block Storage volumes available
     */
    public function getAll($regionSlug = null)
    {
        $regionQueryParameter = is_null($regionSlug) ? '' : sprintf('&region=%s', $regionSlug);
        $volumes = $this->adapter->get(sprintf('%s/volumes?per_page=%d%s', $this->endpoint, 200, $regionQueryParameter));

        $volumes = json_decode($volumes);

        $this->extractMeta($volumes);

        return array_map(function ($volume) {
            return new VolumeEntity($volume);
        }, $volumes->volumes);
    }

    /**
     * @param string $driveName  restricts results to volumes with the specified name
     * @param string $regionSlug restricts results to volumes available in a specific region
     *
     * @return VolumeEntity[] Lists all of the Block Storage volumes available
     */
    public function getByNameAndRegion($driveName, $regionSlug)
    {
        $volumes = $this->adapter->get(sprintf('%s/volumes?per_page=%d&region=%s&name=%s', $this->endpoint, 200, $regionSlug, $driveName));

        $volumes = json_decode($volumes);

        $this->extractMeta($volumes);

        return array_map(function ($volume) {
            return new VolumeEntity($volume);
        }, $volumes->volumes);
    }

    /**
     * @param string $id
     *
     * @return VolumeEntity the Block Storage volume with the specified id
     */
    public function getById($id)
    {
        $volume = $this->adapter->get(sprintf('%s/volumes/%s?per_page=%d', $this->endpoint, $id, 200));

        $volume = json_decode($volume);

        return new VolumeEntity($volume->volume);
    }

    /**
     * Get all volume snapshots.
     *
     * @param string $id
     *
     * @return ImageEntity[]
     */
    public function getSnapshots($id)
    {
        $snapshots = $this->adapter->get(sprintf('%s/volumes/%s/snapshots?per_page=%d', $this->endpoint, $id, 200));

        $snapshots = json_decode($snapshots);

        $this->meta = $this->extractMeta($snapshots);

        return array_map(function ($snapshot) {
            $snapshot = new SnapshotEntity($snapshot);

            return $snapshot;
        }, $snapshots->snapshots);
    }

    /**
     * @param string $name            A human-readable name for the Block Storage volume
     * @param string $description     Free-form text field to describe a Block Storage volume
     * @param string $sizeInGigabytes The size of the Block Storage volume in GiB
     * @param string $regionSlug      The region where the Block Storage volume will be created
     * @param string $snapshotId      The unique identifier for the volume snapshot from which to create the volume. Should not be specified with a region_id.
     *
     * @return VolumeEntity
     */
    public function create($name, $description, $sizeInGigabytes, $regionSlug, $snapshotId = null)
    {
        $data = [
            'size_gigabytes' => $sizeInGigabytes,
            'name' => $name,
            'description' => $description,
            'region' => $regionSlug,
        ];

        if($snapshotId !== null) {
            $data['snapshot_id'] = $snapshotId;
        }

        $volume = $this->adapter->post(sprintf('%s/volumes', $this->endpoint), $data);

        $volume = json_decode($volume);

        return new VolumeEntity($volume->volume);
    }

    /**
     * @param string $id
     *
     * @throws HttpException
     */
    public function delete($id)
    {
        $this->adapter->delete(sprintf('%s/volumes/%s', $this->endpoint, $id));
    }

    /**
     * @param string $driveName  restricts the search to volumes with the specified name
     * @param string $regionSlug restricts the search to volumes available in a specific region
     *
     * @throws HttpException
     */
    public function deleteWithNameAndRegion($driveName, $regionSlug)
    {
        $this->adapter->delete(sprintf('%s/volumes?name=%s&region=%s', $this->endpoint, $driveName, $regionSlug));
    }

    /**
     * @param string $id         the id of the volume
     * @param int    $dropletId  the unique identifier for the Droplet the volume will be attached to
     * @param string $regionSlug the slug identifier for the region the volume is located in
     *
     * @return ActionEntity
     */
    public function attach($id, $dropletId, $regionSlug)
    {
        $data = [
            'type' => 'attach',
            'droplet_id' => $dropletId,
            'region' => $regionSlug,
        ];

        $action = $this->adapter->post(sprintf('%s/volumes/%s/actions', $this->endpoint, $id), $data);

        $action = json_decode($action);

        return new ActionEntity($action->action);
    }

    /**
     * @param string $id         the id of the volume
     * @param int    $dropletId  the unique identifier for the Droplet the volume will detach from
     * @param string $regionSlug the slug identifier for the region the volume is located in
     *
     * @return ActionEntity
     */
    public function detach($id, $dropletId, $regionSlug)
    {
        $data = [
            'type' => 'detach',
            'droplet_id' => $dropletId,
            'region' => $regionSlug,
        ];

        $action = $this->adapter->post(sprintf('%s/volumes/%s/actions', $this->endpoint, $id), $data);

        $action = json_decode($action);

        return new ActionEntity($action->action);
    }

    /**
     * @param string $id         the id of the volume
     * @param int    $newSize    the new size of the Block Storage volume in GiB
     * @param string $regionSlug the slug identifier for the region the volume is located in
     *
     * @return ActionEntity
     */
    public function resize($id, $newSize, $regionSlug)
    {
        $data = [
            'type' => 'resize',
            'size_gigabytes' => $newSize,
            'region' => $regionSlug,
        ];

        $action = $this->adapter->post(sprintf('%s/volumes/%s/actions', $this->endpoint, $id), $data);

        $action = json_decode($action);

        return new ActionEntity($action->action);
    }

    /**
     * Create a new snapshot of the volume.
     *
     * @param string $id   the id of the volume
     * @param string $name a human-readable name for the volume snapshot
     *
     * @throws HttpException
     *
     * @return SnapshotEntity
     */
    public function snapshot($id, $name)
    {
        $data = [
            'name' => $name,
        ];

        $snapshot = $this->adapter->post(sprintf('%s/volumes/%s/snapshots', $this->endpoint, $id), $data);

        $snapshot = json_decode($snapshot);

        return new SnapshotEntity($snapshot->snapshot);
    }

    /**
     * @param string $id
     * @param int    $actionId
     *
     * @return ActionEntity
     */
    public function getActionById($id, $actionId)
    {
        $action = $this->adapter->get(sprintf('%s/volumes/%s/actions/%d', $this->endpoint, $id, $actionId));

        $action = json_decode($action);

        return new ActionEntity($action->action);
    }

    /**
     * @param string $id
     *
     * @return ActionEntity[]
     */
    public function getActions($id)
    {
        $actions = $this->adapter->get(sprintf('%s/volumes/%s/actions?per_page=%d', $this->endpoint, $id, 200));

        $actions = json_decode($actions);

        $this->meta = $this->extractMeta($actions);

        return array_map(function ($action) {
            return new ActionEntity($action);
        }, $actions->actions);
    }
}