NAME

Krang::Workspace - data broker for My Workspace CGI

SYNOPSIS

  use Krang::ClassLoader 'Workspace';

  # get a list of objects on the current user's workspace
  @objects = pkg('Workspace')->find();

  # get just the first 10, sorting by url:
  @objects = pkg('Workspace')->find(limit    => 10,
                                    offset   => 0,
                                    order_by => 'url');

DESCRIPTION

This module provides a find() method which returns all objects checked-out to a particular user.

INTERFACE

• @objects = Krang::Workspace->find()
  
• $count = Krang::Workspace->find(count => 1)
  
Finds stories, media and templates checked out to a particular user (the currently logged in user by default). The returned array will contain Krang::Story, Krang::Media and Krang::Template objects.

Since the returned objects do not share single ID-space, the standard ids_only mode is not supported.

Available search options are:

• user_id
  
Find items on a particular user's workspace. This defaults to the currently logged in user if not set.

Options affecting the search and the results returned:

• count
  
Return just a count of the results for this query.
• limit
  
Return no more than this many results.
• offset
  
Start return results at this offset into the result set.
• order_by
  
Output field to sort by. Defaults to 'type' which sorts stories first, then media and finally templates. Other available settings are 'date', 'title', 'url' and 'id'.
• order_desc
  
Results will be in sorted in ascending order unless this is set to 1 (making them descending).