NAME

Krang::Desk - Krang Desk API

SYNOPSIS

    use Krang::ClassLoader 'Desk';

    # add a new desk, defaulting to next available slot in order
    my $desk = pkg('Desk')->new( name => 'Publish');

    # return desk id
    my $desk_id = $desk->desk_id;

    # return desk order
    my $desk_order = $desk->order;

    # create another desk, this time choosing order of
    # another desk, effectively making order of other
    # desk + 1
    my $desk2 = pkg('Desk')->new( name => 'Print', order => $desk->order );

    # return desk objects with name 'Publish'
    my @desks = pkg('Desk')->find( name => 'Publish' );

    # reorder desks (in this case switch order of the two we have created)
    pkg('Desk')->reorder(   $desk[0]->desk_id => $desk2->order,
                            $desk2->desk_id => $desk[0]->order );

    $desk->delete();

DESCRIPTION

Krang::Desk provides methods to create, delete, find and reorder desks.

INTERFACE

METHODS

• new()
  
Add a new desk and save it. Takes the following parameters.
• name
  
name of desk (required)
• order
  
position in order of desks for this desk. defaults to next available slot in desk order.

• desk_id()
  
Return desk id for desk object.
• name()
  
Return desk name
• order()
  
Return desk order. Please note that if desk order is shuffled in the database, you will have to reload the desk object to get an accurate order.
• reorder()
  
Reorder desks as specified. Takes hash of desk_id => order pairs.
• find()
  
Returns a list of desk objects, desk_ids, or count based on search parameters. Valid params below:
• name
  
• order
  
• desk_id
  
• count
  
If this argument is specified, the method will return a count of the desks matching criteria.
• ids_only
  
Returns only desk_ids for the results found in the DB, not objects.
• order_by
  
Specify the field by means of which the results will be sorted. Defaults to 'order'.
• order_desc
  
If this is set to true, results will be sorted as descending (default is ascending).
• limit
  
Limit the number of results returned.

• delete()
  
Delete a desk. Takes a desk_id as argument if called as class method.
• $desk->serialize_xml(writer => $writer, set => $set)
  
Serialize as XML. See Krang::DataSet for details.
• $desk = Krang::Desk->deserialize_xml(xml => $xml, set => $set, no_update => 0)
  
Deserialize XML. See Krang::DataSet for details.

If an incoming desk has the same name as an existing desk then an update will occur, unless no_update is set.