MyShaarli/plugins/wallabag/WallabagInstance.php

74 lines
1.7 KiB
PHP
Raw Permalink Normal View History

<?php
2023-05-24 11:35:15 +02:00
namespace Shaarli\Plugin\Wallabag;
/**
* Class WallabagInstance.
*/
class WallabagInstance
{
/**
* @var array Static reference to differrent WB API versions.
* - key: version ID, must match plugin settings.
* - value: version name.
*/
2023-05-24 11:35:15 +02:00
private static $wallabagVersions = [
1 => '1.x',
2 => '2.x',
2023-05-24 11:35:15 +02:00
];
/**
* @var array Static reference to WB endpoint according to the API version.
* - key: version name.
* - value: endpoint.
*/
2023-05-24 11:35:15 +02:00
private static $wallabagEndpoints = [
'1.x' => '?plainurl=',
'2.x' => 'bookmarklet?url=',
2023-05-24 11:35:15 +02:00
];
/**
* @var string Wallabag user instance URL.
*/
private $instanceUrl;
/**
* @var string Wallabag user instance API version.
*/
private $apiVersion;
public function __construct($instance, $version)
{
if ($this->isVersionAllowed($version)) {
$this->apiVersion = self::$wallabagVersions[$version];
} else {
// Default API version: 1.x.
$this->apiVersion = self::$wallabagVersions[1];
}
$this->instanceUrl = add_trailing_slash($instance);
}
/**
* Build the Wallabag URL to reach from instance URL and API version endpoint.
*
* @return string wallabag url.
*/
public function getWallabagUrl()
{
return $this->instanceUrl . self::$wallabagEndpoints[$this->apiVersion];
}
/**
* Checks version configuration.
*
* @param mixed $version given version ID.
*
* @return bool true if it's valid, false otherwise.
*/
private function isVersionAllowed($version)
{
return isset(self::$wallabagVersions[$version]);
}
}