Files
2025-12-19 18:55:49 -08:00

137 lines
3.2 KiB
PHP

<?php
/**
* @brief Share Services Abstract Class
* @author <a href='https://www.invisioncommunity.com'>Invision Power Services, Inc.</a>
* @copyright (c) Invision Power Services, Inc.
* @license https://www.invisioncommunity.com/legal/standards/
* @package Invision Community
* @since 21 Aug 2018
*/
namespace IPS\Content;
/* To prevent PHP errors (extending class does not exist) revealing path */
use InvalidArgumentException;
use IPS\Application;
use IPS\core\ShareLinks\Service;
use IPS\Helpers\Form;
use IPS\Http\Url;
use function defined;
if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
{
header( ( $_SERVER['SERVER_PROTOCOL'] ?? 'HTTP/1.0' ) . ' 403 Forbidden' );
exit;
}
/**
* Share Services Abstract Class
*/
abstract class ShareServices
{
/**
* Get services
*
* @return array
*/
public static function services(): array
{
$return = [
'Bluesky' => 'IPS\Content\ShareServices\Bluesky',
'Facebook' => 'IPS\Content\ShareServices\Facebook',
'Linkedin' => 'IPS\Content\ShareServices\Linkedin',
'Pinterest' => 'IPS\Content\ShareServices\Pinterest',
'Reddit' => 'IPS\Content\ShareServices\Reddit',
'Email' => 'IPS\Content\ShareServices\Email',
'X' => 'IPS\Content\ShareServices\X',
];
/* Load any extensions */
foreach ( Application::allExtensions( 'core', 'ShareServices', FALSE, 'core' ) as $key => $extension )
{
$bits = explode( "_", $key );
$return[ $bits[1] ] = $extension::class;
}
return $return;
}
/**
* @brief Cached services
*/
static array|null $services = NULL;
/**
* Helper method to get the class based on the key
*
* @param string $key Service to load
* @return mixed
* @throws InvalidArgumentException
*/
public static function getClassByKey( string $key ): mixed
{
if ( static::$services == NULL )
{
static::$services = static::services();
}
if ( !isset( static::$services[ ucwords($key) ] ) )
{
throw new InvalidArgumentException;
}
return static::$services[ ucwords($key) ];
}
/**
* Determine whether the logged in user has the ability to autoshare
*
* @return boolean
*/
public static function canAutoshare(): bool
{
return FALSE;
}
/**
* Add any additional form elements to the configuration form. These must be setting keys that the service configuration form can save as a setting.
*
* @param Form $form Configuration form for this service
* @param Service $service The service
* @return void
*/
public static function modifyForm( Form &$form, Service $service ): void
{
// Do nothing by default
}
/**
* @brief URL to the content item
*/
protected Url|null $url = NULL;
/**
* @brief Title of the content item
*/
protected string|null $title = NULL;
/**
* Constructor
*
* @param Url|null $url URL to the content [optional - if omitted, some services will figure out on their own]
* @param string|null $title Default text for the content, usually the title [optional - if omitted, some services will figure out on their own]
* @return void
*/
public function __construct( Url|null $url=NULL, string|null $title=NULL )
{
$this->url = $url;
$this->title = $title;
}
/**
* Return the HTML code to show the share link
*
* @return string
*/
abstract public function __toString(): string;
}