fanbinit/rhymix
1
0
Fork 0
mirror of https://github.com/Lastorder-DC/rhymix.git synced 2026-05-02 16:52:16 +09:00
Code Issues Projects Releases Packages Wiki Activity

Create a basic structure for the Push driver system

Browse source
This commit is contained in:
Kijin Sung 2020-06-12 11:28:32 +09:00
parent f01fb9ae42
commit e23c693446
6 changed files with 599 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

41
common/framework/drivers/push/apns.php Normal file
View file

@ -0,0 +1,41 @@
<?php
namespace Rhymix\Framework\Drivers\Push;
/**
* The APNs (Apple) Push driver.
*/
class APNs extends Base implements \Rhymix\Framework\Drivers\PushInterface
{
/**
* Config keys used by this driver are stored here.
*/
protected static $_required_config = array();
protected static $_optional_config = array();
/**
* Check if the current Push driver is supported on this server.
*
* This method returns true on success and false on failure.
*
* @return bool
*/
public static function isSupported(): bool
{
return true;
}
/**
* Send a message.
*
* This method returns true on success and false on failure.
*
* @param object $message
* @return bool
*/
public function send(\Rhymix\Framework\Push $message): bool
{
// TODO
return false;
}
}

94
common/framework/drivers/push/base.php Normal file
View file

@ -0,0 +1,94 @@
<?php
namespace Rhymix\Framework\Drivers\Push;
/**
* The base class for other Push drivers.
*/
abstract class Base implements \Rhymix\Framework\Drivers\PushInterface
{
/**
* The configuration is stored here.
*/
protected $_config = null;
/**
* Config keys used by this driver are stored here.
*/
protected static $_required_config = array();
protected static $_optional_config = array();
/**
* Direct invocation of the constructor is not permitted.
*/
protected function __construct(array $config): void
{
$this->_config = $config;
}
/**
* Create a new instance of the current Push driver, using the given settings.
*
* @param array $config
* @return object
*/
public static function getInstance(array $config): object
{
return new static($config);
}
/**
* Get the human-readable name of this Push driver.
*
* @return string
*/
public static function getName(): string
{
return class_basename(get_called_class());
}
/**
* Get the list of configuration fields required by this Push driver.
*
* @return array
*/
public static function getRequiredConfig(): array
{
return static::$_required_config;
}
/**
* Get the list of configuration fields optionally used by this Push driver.
*
* @return array
*/
public static function getOptionalConfig(): array
{
return static::$_optional_config;
}
/**
* Check if the current Push driver is supported on this server.
*
* This method returns true on success and false on failure.
*
* @return bool
*/
public static function isSupported(): bool
{
return false;
}
/**
* Send a message.
*
* This method returns true on success and false on failure.
*
* @param object $message
* @return bool
*/
public function send(\Rhymix\Framework\Push $message): bool
{
return false;
}
}

60
common/framework/drivers/push/dummy.php Normal file
View file

@ -0,0 +1,60 @@
<?php
namespace Rhymix\Framework\Drivers\Push;
/**
* The dummy Push driver.
*/
class Dummy extends Base implements \Rhymix\Framework\Drivers\PushInterface
{
/**
* Sent messages are stored here for debugging and testing.
*/
protected $_sent_messages = array();
/**
* Check if the current Push driver is supported on this server.
*
* This method returns true on success and false on failure.
*
* @return bool
*/
public static function isSupported(): bool
{
return true;
}
/**
* Send a message.
*
* This method returns true on success and false on failure.
*
* @param object $message
* @return bool
*/
public function send(\Rhymix\Framework\Push $message): bool
{
$this->_sent_messages[] = $message;
return true;
}
/**
* Get sent messages.
*
* @return array
*/
public function getSentMessages(): array
{
return $this->_sent_messages;
}
/**
* Reset sent messages.
*
* @return void
*/
public function resetSentMessages(): void
{
$this->_sent_messages = array();
}
}

41
common/framework/drivers/push/fcm.php Normal file
View file

@ -0,0 +1,41 @@
<?php
namespace Rhymix\Framework\Drivers\Push;
/**
* The FCM (Google) Push driver.
*/
class FCM extends Base implements \Rhymix\Framework\Drivers\PushInterface
{
/**
* Config keys used by this driver are stored here.
*/
protected static $_required_config = array();
protected static $_optional_config = array();
/**
* Check if the current SMS driver is supported on this server.
*
* This method returns true on success and false on failure.
*
* @return bool
*/
public static function isSupported(): bool
{
return true;
}
/**
* Send a message.
*
* This method returns true on success and false on failure.
*
* @param object $message
* @return bool
*/
public function send(\Rhymix\Framework\Push $message): bool
{
// TODO
return false;
}
}

57
common/framework/drivers/pushinterface.php Normal file
View file

@ -0,0 +1,57 @@
<?php
namespace Rhymix\Framework\Drivers;
/**
* The Push driver interface.
*/
interface PushInterface
{
/**
* Create a new instance of the current Push driver, using the given settings.
*
* @param array $config
* @return void
*/
public static function getInstance(array $config): object;
/**
* Get the human-readable name of this Push driver.
*
* @return string
*/
public static function getName(): string;
/**
* Get the list of configuration fields required by this Push driver.
*
* @return array
*/
public static function getRequiredConfig(): array;
/**
* Get the list of configuration fields optionally used by this Push driver.
*
* @return array
*/
public static function getOptionalConfig(): array;
/**
* Check if the current SMS driver is supported on this server.
*
* This method returns true on success and false on failure.
*
* @return bool
*/
public static function isSupported(): bool;
/**
* Send a message.
*
* This method returns true on success and false on failure.
*
* @param object $message
* @return bool
*/
public function send(\Rhymix\Framework\Push $message): bool;
}