Create a basic structure for the Push driver system

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

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;
}