Catalyst::Controller::DBIC::API::RPC - Provides an RPC interface to DBIx::Class

Catalyst-Controller-DBIC-API documentation Contained in the Catalyst-Controller-DBIC-API distribution.

Index

Code Index:

NAME

Top

Catalyst::Controller::DBIC::API::RPC - Provides an RPC interface to DBIx::Class

VERSION

Top

version 2.003002

DESCRIPTION

Top

Provides an RPC API interface to the functionality described in Catalyst::Controller::DBIC::API.

By default provides the following endpoints:

  $base/create
  $base/list
  $base/id/[identifier]
  $base/id/[identifier]/delete
  $base/id/[identifier]/update

Where $base is the URI described by setup, the chain root of the controller.

PROTECTED_METHODS

Top

setup

Chained: override PathPart: override CaptureArgs: 0

As described in setup in Catalyst::Controller::DBIC::API, this action is the chain root of the controller but has no pathpart or chain parent defined by default, so these must be defined in order for the controller to function. The neatest way is normally to define these using the controller's config.

  __PACKAGE__->config
    ( action => { setup => { PathPart => 'track', Chained => '/api/rpc/rpc_base' } },
	...
  );

create

Chained: objects_no_id PathPart: create CaptureArgs: 0

Provides an endpoint to the functionality described in update_or_create in Catalyst::Controller::DBIC::API.

list

Chained: deserialize PathPart: list CaptureArgs: 0

Provides an endpoint to the functionality described in list in Catalyst::Controller::DBIC::API.

item

Chained: object_with_id PathPart: '' Args: 0

Provides an endpoint to the functionality described in item in Catalyst::Controller::DBIC::API.

update

Chained: object_with_id PathPart: update Args: 0

Provides an endpoint to the functionality described in update_or_create in Catalyst::Controller::DBIC::API.

delete

Chained: object_with_id PathPart: delete Args: 0

Provides an endpoint to the functionality described in delete in Catalyst::Controller::DBIC::API.

update_bulk

Chained: objects_no_id PathPart: update Args: 0

Provides an endpoint to the functionality described in update_or_create in Catalyst::Controller::DBIC::API for multiple objects.

delete_bulk

Chained: objects_no_id PathPart: delete Args: 0

Provides an endpoint to the functionality described in delete in Catalyst::Controller::DBIC::API for multiple objects.

AUTHORS

Top

COPYRIGHT AND LICENSE

Top

This software is copyright (c) 2011 by Luke Saunders, Nicholas Perez, Alexander Hartmaier, et al..

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

Catalyst-Controller-DBIC-API documentation Contained in the Catalyst-Controller-DBIC-API distribution. 
package Catalyst::Controller::DBIC::API::RPC;
BEGIN {
  $Catalyst::Controller::DBIC::API::RPC::VERSION = '2.003002';
}
#ABSTRACT: Provides an RPC interface to DBIx::Class

use Moose;
BEGIN { extends 'Catalyst::Controller::DBIC::API'; }

__PACKAGE__->config(
    'action'    => { object_with_id => { PathPart => 'id' } },
    'default'   => 'application/json',
    'stash_key' => 'response',
    'map'       => {
        'application/x-www-form-urlencoded' => 'JSON',
        'application/json'                  => 'JSON',
    },
);



sub create :Chained('objects_no_id') :PathPart('create') :Args(0)
{
	my ($self, $c) = @_;
    $self->update_or_create($c);
}


sub list :Chained('deserialize') :PathPart('list') :Args(0)
{
	my ($self, $c) = @_;
    $self->next::method($c);
}


sub item :Chained('object_with_id') :PathPart('') :Args(0)
{
    my ($self, $c) = @_;
    $self->next::method($c);
}


sub update :Chained('object_with_id') :PathPart('update') :Args(0)
{
    my ($self, $c) = @_;
    $self->update_or_create($c);
}


sub delete :Chained('object_with_id') :PathPart('delete') :Args(0)
{
    my ($self, $c) = @_;
    $self->next::method($c);
}


sub update_bulk :Chained('objects_no_id') :PathPart('update') :Args(0)
{
    my ($self, $c) = @_;
    $self->update_or_create($c);
}


sub delete_bulk :Chained('objects_no_id') :PathPart('delete') :Args(0)
{
    my ($self, $c) = @_;
    $self->delete($c);
}

1;

__END__