Development:MNET API - Revision history

Mjollnir: /* send_content_ready */

2008-11-06T08:49:55Z

send_content_ready

← Older revision		Revision as of 08:49, 6 November 2008
Line 190:		Line 190:
	** status: boolean, success or failure		** status: boolean, success or failure
	** type: string, 'queued' or 'complete'		** type: string, 'queued' or 'complete'
			** querystring: string, used for the final 'continue to portfolio' link (eg ?folder=6&file=6 to highlight new files that were added)

	===fetch_file===		===fetch_file===

Jmouneyrac: /* Specific methods */

2008-10-31T01:47:38Z

Specific methods

← Older revision		Revision as of 01:47, 31 October 2008
Line 43:		Line 43:

	=== Specific methods ===		=== Specific methods ===
	Most of the time you don't want to add a system method but a method for a module/service. You ~~wanna~~ to be ~~this display~~ by the "ListMethods" system method.		Most of the time you don't want to add a system method but a method for a module/service. You also want it to be displayed by the "ListMethods" system method.

	Let's implement a function returning "Hello World".		Let's implement a function returning "Hello World".

Jmouneyrac: /* Specific methods */

2008-10-27T06:25:33Z

Specific methods

← Older revision		Revision as of 06:25, 27 October 2008
Line 79:		Line 79:
	}		}
	}		}
	... //below, the retrieved information are saved into the database		...
			///below, the retrieved information are saved into the database
	</code>		</code>

Jmouneyrac: /* Specific methods */

2008-10-27T06:05:39Z

Specific methods

← Older revision		Revision as of 06:05, 27 October 2008
Line 85:		Line 85:
	function upgrade_RPC_functions($returnurl) {		function upgrade_RPC_functions($returnurl) {
	...		...
	/// check ~~example~~ into the ~~code (just above)~~		/// check other mnet_get_functions calls into the same file
	mnet_get_functions('service', null);		mnet_get_functions('service', null);
	}		}

Jmouneyrac: /* Specific methods */

2008-10-27T06:04:57Z

Specific methods

← Older revision		Revision as of 06:04, 27 October 2008
Line 85:		Line 85:
	function upgrade_RPC_functions($returnurl) {		function upgrade_RPC_functions($returnurl) {
	...		...
	/// check ~~above~~ example into the code		/// check example into the code (just above)
	mnet_get_functions('service', null);		mnet_get_functions('service', null);
	}		}

Jmouneyrac: /* Specific methods */

2008-10-27T06:04:14Z

Specific methods

← Older revision		Revision as of 06:04, 27 October 2008
Line 60:		Line 60:

	2. We register this function as a mnet function into the database:<br>		2. We register this function as a mnet function into the database:<br>
	Into admin/mnet/adminlib.php~~::upgrade_RPC_functions()~~, we add this ~~case at the end~~:		Into admin/mnet/adminlib.php, we add this code:
	<code php>		<code php>
	function mnet_get_functions($type, $parentname) {		function mnet_get_functions($type, $parentname) {
	...		...
	else if ('service' == $type) {		else if ('service' == $type) {
			/// we're going to load the service object (after having checked it exists)
			/// and call mnet_publishes function
	$docname = 'services.php';		$docname = 'services.php';
	$relname = '/servicefolder/'. $docname;		$relname = '/servicefolder/'. $docname;
Line 71:		Line 73:
	$class = "services";		$class = "services";
	if (class_exists($class)) {		if (class_exists($class)) {
	$object = new $class();		$object = new $class();
	if (method_exists($object, 'mnet_publishes')) {		if (method_exists($object, 'mnet_publishes')) {
	(array)$publishes = $object->mnet_publishes();		(array)$publishes = $object->mnet_publishes(); //retrieve the service information
	}		}
	}		}
	}		}
	...		... //below, the retrieved information are saved into the database
	</code>		</code>

Line 83:		Line 85:
	function upgrade_RPC_functions($returnurl) {		function upgrade_RPC_functions($returnurl) {
	...		...
	~~$basedir = $CFG->dirroot.'~~/~~servicefolder';~~		/// check above example into the code
	~~if (file_exists($basedir) && filetype($basedir) == 'dir') {~~		mnet_get_functions('service', null);
	~~$dirhandle = opendir($basedir);~~
	~~while (false !== ($dir = readdir($dirhandle))) {~~
	~~$firstchar = substr($dir, 0, 1);~~
	~~if ($firstchar == '.' or $dir == 'CVS' or $dir == '_vti_cnf') {~~
	~~continue;~~
	}
	~~if (filetype($basedir .'/'. $dir) != 'dir') {~~
	~~continue;~~
	}

	mnet_get_functions('service', ~~$dir~~);
	}
	}

	}		}
	*/		*/

Jmouneyrac: /* Specific methods */

2008-10-27T05:56:13Z

Specific methods

← Older revision		Revision as of 05:56, 27 October 2008
Line 62:		Line 62:
	Into admin/mnet/adminlib.php::upgrade_RPC_functions(), we add this case at the end:		Into admin/mnet/adminlib.php::upgrade_RPC_functions(), we add this case at the end:
	<code php>		<code php>
	~~TODO~~		function mnet_get_functions($type, $parentname) {
	/*		...
	else if ('~~repository~~' == $type) {		else if ('service' == $type) {

	$docname = 'services.php';		$docname = 'services.php';
	$relname = '/servicefolder/'. $docname;		$relname = '/servicefolder/'. $docname;
	$filename = $CFG->dirroot . $relname;		$filename = $CFG->dirroot.$relname;
	~~require_once~~($~~CFG->dirroot . '/servicefolder/~~services~~.php'~~);		if (file_exists($filename)) include_once $filename;
	$~~publishes~~ = (~~array~~)~~repository_static_function~~($~~parentname~~, 'mnet_publishes');		$class = "services";
			if (class_exists($class)) {
			$object = new $class();
			if (method_exists($object, 'mnet_publishes')) {
			(array)$publishes = $object->mnet_publishes();
			}
	}		}
	if ($~~plugins~~ = ~~get_list_of_plugins(~~'~~services~~')) {		}
			...
	~~foreach~~ ($~~plugins as~~ $p) {		</code>

	mnet_get_functions('service', $p);		<code php>
			function upgrade_RPC_functions($returnurl) {
			...
			$basedir = $CFG->dirroot.'/servicefolder';
			if (file_exists($basedir) && filetype($basedir) == 'dir') {
			$dirhandle = opendir($basedir);
			while (false !== ($dir = readdir($dirhandle))) {
			$firstchar = substr($dir, 0, 1);
			if ($firstchar == '.' or $dir == 'CVS' or $dir == '_vti_cnf') {
			continue;
			}
			if (filetype($basedir .'/'. $dir) != 'dir') {
			continue;
			}

			mnet_get_functions('service', $dir);
	}		}
	}		}

			}
	*/		*/
	</code>		</code>

Jmouneyrac: /* Specific methods */

2008-10-24T06:07:33Z

Specific methods

← Older revision		Revision as of 06:07, 24 October 2008
Line 82:		Line 82:
	</code>		</code>

	Into servicefolder/services.php, add		Into the ''Service'' class of servicefolder/services.php, add
	<code php>		<code php>
	public static function mnet_publishes() {		public static function mnet_publishes() {

Jmouneyrac: /* Specific methods */

2008-10-24T06:06:16Z

Specific methods

← Older revision		Revision as of 06:06, 24 October 2008
Line 81:		Line 81:
	*/		*/
	</code>		</code>

			Into servicefolder/services.php, add
			<code php>
			public static function mnet_publishes() {
			$service= array();
			$service['name'] = 'service'; // Name & Description go in lang file
			$service['apiversion'] = 1;
			$service['methods'] = array('helloWorld');

			return array($service);
			}
			</code>

	3. The server needs to dispatch		3. The server needs to dispatch
	in mnet/xmlrpc/server.php::mnet_server_dispatch(), we need to add:		in mnet/xmlrpc/server.php::mnet_server_dispatch(), we need to add:
Line 98:		Line 111:
	</code>		</code>

	4. We add the method to the "ListMethods" system method ~~(TODO)~~		4. We add the method to the "ListMethods" system method<br>
			No code is needed. Just go into the Moodle Administration > Networking > Peers. Select the ''Services'' tab from the host server. There, activate your service.

	5. We write some client code<br>		5. We write some client code<br>

Jmouneyrac: /* Specific methods */

2008-10-23T05:42:01Z

Specific methods

← Older revision		Revision as of 05:42, 23 October 2008
Line 105:		Line 105:
	We can now call this method. Change:		We can now call this method. Change:
	<code php>		<code php>
	$client->set_method('system/listMethods');		$client->set_method('system/listMethods');
	</code>		</code>
	For:		For:
	<code php>		<code php>
	$client->set_method('servicefolder/services.php/helloworld');		$client->set_method('servicefolder/services.php/helloworld');
	$client->add_param('Thierry');		$client->add_param('Thierry');
	$client->add_param('Henry');		$client->add_param('Henry');
	</code>		</code>