Add ability to retrieve site hosting properties

Author: Alexey Filatev

src/PleskX/Api/Operator.php

@@ -62,9 +62,10 @@ protected function _delete($field, $value, $deleteMethodName = 'del')
      * @param string $infoTag
      * @param string|null $field
      * @param integer|string|null $value
+     * @param callable|null $filter
      * @return mixed
      */
-    protected function _getItems($structClass, $infoTag, $field = null, $value = null)
+    protected function _getItems($structClass, $infoTag, $field = null, $value = null, callable $filter = null)
     {
         $packet = $this->_client->getPacket();
         $getTag = $packet->addChild($this->_wrapperTag)->addChild('get');
@@ -80,6 +81,9 @@ protected function _getItems($structClass, $infoTag, $field = null, $value = nul
 
         $items = [];
         foreach ($response->xpath('//result') as $xmlResult) {
+            if (!is_null($filter) && !$filter($xmlResult->data->$infoTag)) {
+                continue;
+            }
             $items[] = new $structClass($xmlResult->data->$infoTag);
         }
 

src/PleskX/Api/Operator/Site.php

@@ -6,6 +6,7 @@
 
 class Site extends \PleskX\Api\Operator
 {
+    const PROPERTIES_HOSTING = 'hosting';
 
     /**
      * @param array $properties
@@ -18,9 +19,22 @@ public function create(array $properties)
 
         $infoGeneral = $info->addChild('gen_setup');
         foreach ($properties as $name => $value) {
+            if (!is_scalar($value)) {
+                continue;
+            }
             $infoGeneral->addChild($name, $value);
         }
 
+        // set hosting properties
+        if (isset($properties[static::PROPERTIES_HOSTING]) && is_array($properties[static::PROPERTIES_HOSTING])) {
+            $hostingNode = $info->addChild('hosting')->addChild('vrt_hst');
+            foreach ($properties[static::PROPERTIES_HOSTING] as $name => $value) {
+                $propertyNode = $hostingNode->addChild('property');
+                $propertyNode->addChild('name', $name);
+                $propertyNode->addChild('value', $value);
+            }
+        }
+
         $response = $this->_client->request($packet);
         return new Struct\Info($response);
     }
@@ -46,6 +60,19 @@ public function get($field, $value)
         return reset($items);
     }
 
+    /**
+     * @param string $field
+     * @param integer|string $value
+     * @return Struct\HostingInfo|null
+     */
+    public function getHosting($field, $value)
+    {
+        $items = $this->_getItems(Struct\HostingInfo::class, 'hosting', $field, $value, function ($node) {
+            return isset($node->vrt_hst);
+        });
+        return empty($items) ? null : reset($items);
+    }
+
     /**
      * @return Struct\GeneralInfo[]
      */

src/PleskX/Api/Struct/Site/HostingInfo.php

@@ -0,0 +1,23 @@
+<?php
+// Copyright 1999-2016. Parallels IP Holdings GmbH.
+
+namespace PleskX\Api\Struct\Site;
+
+class HostingInfo extends \PleskX\Api\Struct
+{
+    /** @var array */
+    public $properties = [];
+
+    /** @var string */
+    public $ipAddress;
+
+    public function __construct($apiResponse)
+    {
+        foreach ($apiResponse->vrt_hst->property as $property) {
+            $this->properties[(string)$property->name] = (string)$property->value;
+        }
+        $this->_initScalarProperties($apiResponse->vrt_hst, [
+            'ip_address',
+        ]);
+    }
+}

tests/SiteTest.php

@@ -20,12 +20,13 @@ public static function tearDownAfterClass()
         static::$_client->webspace()->delete('id', static::$_webspace->id);
     }
 
-    private function _createSite($name)
+    private function _createSite($name, array $properties = [])
     {
-        return static::$_client->site()->create([
+        $properties = array_merge([
             'name' => $name,
             'webspace-id' => static::$_webspace->id,
-        ]);
+        ], $properties);
+        return static::$_client->site()->create($properties);
     }
 
     public function testCreate()
@@ -56,6 +57,32 @@ public function testGet()
         static::$_client->site()->delete('id', $site->id);
     }
 
+    public function testGetHostingWoHosting()
+    {
+        $site = $this->_createSite('addon.dom');
+
+        $siteHosting = static::$_client->site()->getHosting('id', $site->id);
+        $this->assertNull($siteHosting);
+
+        static::$_client->site()->delete('id', $site->id);
+    }
+
+    public function testGetHostingWithHosting()
+    {
+        $properties =  [
+            'hosting' => [
+                'www_root' => 'addon.dom'
+            ]
+        ];
+        $site = $this->_createSite('addon.dom', $properties);
+
+        $siteHosting = static::$_client->site()->getHosting('id', $site->id);
+        $this->assertArrayHasKey('www_root', $siteHosting->properties);
+        $this->assertEquals('addon.dom', basename($siteHosting->properties['www_root']));
+
+        static::$_client->site()->delete('id', $site->id);
+    }
+
     public function testGetAll()
     {
         $site = $this->_createSite('addon.dom');