fernando/luos
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Adding Rest Api Service Support

Browse Source 
Rest Service on plugins
-----------------------

1. enable service

add the following line in plugin __constructor main class
$this->enableRestService(true);

2. Create the sources directory structure by example:
if you plugin is named myPlugin

myPlugin
    |--src
        |--Services
             |--Api
                 |--MyPlugin
                      |--Test.php

Where Test.php is a Restler class
This commit is contained in:
Erik Amaru Ortiz
2013-12-03 17:10:18 -04:00
parent 47e4cc0ef1
commit b25efdd866
11 changed files with 203 additions and 113 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
workflow/engine/classes/class.api.php
View File

@@ -1,39 +0,0 @@
<?php
namespace ProcessMaker;
class Api
{
private static $workspace;
private static $userId;
const STAT_CREATED = 201;
const STAT_APP_EXCEPTION = 400;
public function __costruct()
{
self::$workspace = null;
}
public static function setWorkspace($workspace)
{
self::$workspace = $workspace;
}
public function getWorkspace()
{
return self::$workspace;
}
public static function setUserId($userId)
{
self::$userId = $userId;
}
public function getUserId()
{
//return self::$userId;
return \Api\OAuth2\Server::getUserId();
}
}

10
workflow/engine/classes/class.plugin.php
View File

@@ -341,10 +341,10 @@ class PMPlugin
* @param array/string $pluginJsFile
* @return void
*/
function registerRestService($classname, $path = '')
function registerRestService()
{
$oPluginRegistry =& PMPluginRegistry::getSingleton();
$oPluginRegistry->registerRestService($this->sNamespace, $classname, $path);
$oPluginRegistry->registerRestService($this->sNamespace);
}
/**
@@ -360,6 +360,12 @@ class PMPlugin
$oPluginRegistry =& PMPluginRegistry::getSingleton();
$oPluginRegistry->unregisterRestService($this->sNamespace, $classname, $path);
}
function enableRestService($enable)
{
$oPluginRegistry =& PMPluginRegistry::getSingleton();
$oPluginRegistry->enableRestService($this->sNamespace, $enable);
}
}
class menuDetail

98
workflow/engine/classes/class.pluginRegistry.php
View File

@@ -108,6 +108,8 @@ class PMPluginRegistry
*/
private $_restServices = array ();
private $_restServiceEnabled = array();
private static $instance = null;
/**
@@ -240,6 +242,27 @@ class PMPluginRegistry
if (method_exists( $oPlugin, 'enable' )) {
$oPlugin->enable();
}
/*
* 1. register <plugin-dir>/src directory for autoloading
* 2. verify if rest service is enabled
* 3. register rest service directory
*/
$pluginSrcDir = PATH_PLUGINS . $detail->sNamespace . PATH_SEP . 'src';
if (is_dir($pluginSrcDir)) {
Bootstrap::registerDir($detail->sNamespace.'/src', $pluginSrcDir);
}
if (array_key_exists($detail->sNamespace, $this->_restServiceEnabled)
&& $this->_restServiceEnabled[$detail->sNamespace] == true
) {
$oPlugin->registerRestService();
ProcessMaker\Util\Logger::log("plugin ".$detail->sNamespace." -> rest enabled");
} else {
ProcessMaker\Util\Logger::log("plugin ".$detail->sNamespace." -> rest not enabled");
}
return true;
}
}
@@ -1339,27 +1362,39 @@ class PMPluginRegistry
* @param string $path (optional) the class file path, if it is not set the system will try resolve the
* file path from its classname.
*/
public function registerRestService ($sNamespace, $classname, $path = '')
public function registerRestService($sNamespace)
{
$restService = new StdClass();
$restService->sNamespace = $sNamespace;
$restService->classname = $classname;
$baseSrcPluginPath = PATH_PLUGINS . $sNamespace . PATH_SEP . "src";
$apiPath = PATH_SEP . "Services" . PATH_SEP . "Api" . PATH_SEP . ucfirst($sNamespace);
$classesList = Bootstrap::rglob('*', 0, $baseSrcPluginPath . $apiPath);
if (empty( $path )) {
$path = PATH_PLUGINS . $restService->sNamespace . "/services/rest/$classname.php";
foreach ($classesList as $classFile) {
if (pathinfo($classFile, PATHINFO_EXTENSION) === 'php') {
if (! file_exists( $path )) {
$path = PATH_PLUGINS . $restService->sNamespace . "/services/rest/crud/$classname.php";
$ns = str_replace(
DIRECTORY_SEPARATOR,
'\\',
str_replace('.php', '', str_replace($baseSrcPluginPath, '', $classFile))
);
ProcessMaker\Util\Logger::log("Namespace found: " . $ns);
// Ensure that is registering only existent classes.
if (class_exists($ns)) {
$this->_restServices[strtolower($sNamespace)][] = array(
"filepath" => $classFile,
"namespace" => $ns
);
ProcessMaker\Util\Logger::log("class exists: YES");
} else {
ProcessMaker\Util\Logger::log("class exists: NO");
}
ProcessMaker\Util\Logger::log($this->_restServices);
}
}
if (! file_exists( $path )) {
return false;
}
$restService->path = $path;
$this->_restServices[] = $restService;
return true;
}
@@ -1370,31 +1405,14 @@ class PMPluginRegistry
*/
public function unregisterRestService ($sNamespace)
{
foreach ($this->_restServices as $i => $service) {
if ($sNamespace == $service->sNamespace) {
unset( $this->_restServices[$i] );
}
}
// Re-index when all js were unregistered
$this->_restServices = array_values( $this->_restServices );
unset($this->_restServices[$sNamespace]);
}
public function getRegisteredRestServices ()
public function getRegisteredRestServices()
{
return $this->_restServices;
}
public function getRegisteredRestClassFiles ()
{
$restClassFiles = array ();
foreach ($this->_restServices as $restService) {
$restClassFiles[] = $restService->path;
}
return $restClassFiles;
}
/**
* return all dashboard pages
*
@@ -1435,6 +1453,16 @@ class PMPluginRegistry
}
$language->updateLanguagePlugin($namePlugin, SYS_LANG);
}
}
}
/**
* Function to enable rest service for plugins
* @param string $sNamespace
* @param bool $enable
*/
function enableRestService($sNamespace, $enable)
{
$this->_restServiceEnabled[$sNamespace] = $enable;
}
}