Bric::SOAP::PreferenceUser Contributed Perl DocumentBric::SOAP::Preference(3p)



NAME
       Bric::SOAP::Preference - SOAP interface to Bricolage preferences

VERSION
       $LastChangedRevision$

DATE
       $LastChangedDate: 2004-09-14 02:48:55 +0200 (Tue, 14 Sep 2004) $

SYNOPSIS
         use SOAP::Lite;
         import SOAP::Data 'name';

         # setup soap object to login with
         my $soap = new SOAP::Lite
           uri      => 'http://bricolage.sourceforge.net/Bric/SOAP/Auth',
           readable => DEBUG;
         $soap->proxy('http://localhost/soap',
                      cookie_jar => HTTP::Cookies->new(ignore_discard => 1));
         # login
         $soap->login(name(username => USER),
                      name(password => PASSWORD));

         # set uri for Preference module
         $soap->uri('http://bricolage.sourceforge.net/Bric/SOAP/Preference');

         # get a list of all preference IDs
         my $ids = $soap->list_ids()->result;

DESCRIPTION
       This module provides a SOAP interface to manipulating Bricolage
       preferences.  Note that per-user preferences are not handled here
       (probably should be added to the User module).

INTERFACE
   Public Class Methods
       list_ids
           This method queries the database for matching preferences and
           returns a list of ids.  If none are found, an empty list will be
           returned.

           This method can accept the following named parameters to specify
           the search.  Some fields support matching and are marked with an
           (M).  The value for these fields will be interpreted as an SQL
           match expression and will be matched case-insensitively.  Other
           fields must specify an exact string to match.  Match fields combine
           to narrow the search results (via ANDs in an SQL WHERE clause).

           name (M)
               The preference's name.

           description (M)
               The preference's description.

           default (M)
               The preference's default value. Note: for values listed as
               "Off" or "On" in the UI, this will be "0" or "1".

           value (M)
               The preference's value. Note: for values listed as "Off" or
               "On" in the UI, this will be "0" or "1". See "val_name".

           val_name (M)
               The name of the preference's value. This is what's displayed in
               the UI.  See "value".

           manual
               Boolean indicating whether a value can be manually entered by
               the user, rather than selected from a list.

           can_be_overridden
               Boolean indicating whether or not users can override the global
               preference value.

           opt_type
               The preference option type. Current possibilities are: select,
               radio, text.  (I think (from displayFormElement.mc) in
               principle also: password, textarea, checkbox, single_rad, date;
               and codeselect could be easily added.  No preferences currently
               have any of these types, however.)

           Throws:

           Exception::AP

           Side Effects: NONE

           Notes: NONE

       export
           The export method retrieves a set of assets from the database,
           serializes them and returns them as a single XML document.  See
           Bric::SOAP for the schema of the returned document.

           Accepted paramters are:

           pref_id
               Specifies a single pref to be retrieved.

           pref_ids
               Specifies a list of pref_ids.  The value for this option should
               be an array of integer "pref_id" assets.

           Throws:

           Exception::AP

           Side Effects: NONE

           Notes: NONE

       create
           This method is unavailable for preferences, since they aren't
           createable.

       update
           The update method updates an asset using the data in an XML
           document of the format created by export().  A common use of
           update() is to export() a selected object, make changes to one or
           more fields and then submit the changes with update().

           Returns a list of new ids created in the order of the assets in the
           document.

           Takes the following options:

           document (required)
               The XML document where the objects to be updated can be found.
               The document must contain at least one asset and may contain
               any number of related asset objects.

           update_ids (required)
               A list of "pref_id" integers for the assets to be updated.
               These must match id attributes on asset elements in the
               document.  If you include objects in the document that are not
               listed in update_ids then they will be treated as in create().
               For that reason an update() with an empty update_ids list is
               equivalent to a create().

           Throws:

           Exception::AP

           Side Effects: NONE

           Notes: Most information output by "export" will be ignored on
           update.  For example, you can't change the list of possible values,
           or whether a preference is "manual". Those are things that are
           hardcoded into Bricolage. See the "register_fields" call in
           Bric::Util::Pref for which fields are "RDWR" (currently "value" and
           "can_be_overridden").

       delete
           This method is unavailable for preferences, since they aren't
           deleteable.

       $self->module
           Returns the module name, that is the first argument passed to
           bric_soap.

       is_allowed_param
       $pkg->is_allowed_param($param, $method)
           Returns true if $param is an allowed parameter to the $method
           method.

   Private Class Methods
       $pkg->load_asset($args)
           This method provides the meat of update().

       $pkg->serialize_asset( writer   => $writer, pref_id  => $id, args
       => $args)
           Serializes a single pref object into a <pref> pref using the given
           writer and args.

AUTHOR
       Scott Lanning <slanning@cpan.org>

SEE ALSO
       Bric::SOAP, Bric::SOAP::Asset



perl v5.12.2                      2006-03-15        Bric::SOAP::Preference(3p)
