alle/kohana-jsend

This package is abandoned and no longer maintained. No replacement package was suggested.

JSend model for Kohana 3.3 (consistent JSON responses)

dev-master 2014-01-07 14:31 UTC

Requires

• php: >=5.3.3
• composer/installers: ~1.0
• kohana/core: >=3.3

MMIT

• Kemal Delalic
• Alessandro Frangioni

• framework
• json
• module
• kohana

README

Author: Kemal Delalic

See: http://labs.omniti.com/labs/jsend

Example multiple scenario action

public function action_create()
{
	$json = new JSend;
	$post = new Model_Post;
	
	if ($this->request->method() === Request::POST)
	{
		try
		{
			$post->values($this->request->post())
				->create();
				
			$json->data('post', $post); // success is default anyways
		}
		catch (ORM_Validation_Exception $e)
		{
			// Errors are extracted
			// from ORM_Validation_Exception objects
			$json->status(JSend::FAIL)
				->data('errors', $e); 
		}
		catch (Exception $e)
		{
			// Exception message will be extracted
			// and status will be set to JSend::ERROR
			// because only error responses support messages
			$json->message($e); 
		}
	}
	
	$json->render_into($this->response);
}

Example data retrieval action

public function action_posts()
{
	// Success is the default JSend status
	JSend::factory(array('posts' => ORM::factory('post')->find_all()))
		->render_into($this->response);
}

Example jQuery response handling

$.post('/posts', {from: 1337}, function(jsend) {
	if (jsend.status === 'success') {
		$.each(jsend.data.posts, function(key, post) {
			$('#posts').append('<a href="' + post.url + '">' + post.title + '</a>')
		})
	}
	else if (jsend.status === 'fail') {
		$.each(jsend.data.errors, function(field, error) {
			$('#form').find('#' + field).append('<span class="error">' + error + '</span>')
		})
	}
	else {
		$('#posts').addClass('error').text('Internal error: ' + post.message)
	}
});

This can also be overriden on more 'global' level, by overriding or adding jQuery methods.