svn::web::x(3pm) [debian man page]

SVN::Web::X(3pm)					User Contributed Perl Documentation					  SVN::Web::X(3pm)

NAME

       SVN::Web::X - exceptions for SVN::Web

SYNOPSIS

	 use SVN::Web::X;

	 ...

	 SVN::Web::X->throw(error => '(error message %1)',
			    vars => [$var_to_interpolate]);

DESCRIPTION

       SVN::Web::X implements exceptions for SVN::Web.	Derived from Exception::Class, It provides a simple mechanism for throwing exceptions,
       catching them, and ensuring that friendly, localised error messages are generated and sent to the user's browser.

USAGE IN SVN
::Web ACTIONS
       If an SVN::Web action that you are writing needs to stop processing and raise an error, throw an SVN::Web::X exception.

       "throw()" takes a hash with two mandatory keys.

       "error"
	   A string describing the error.  This string should be short, and key to a longer internationalised message.

	   This string may contain placeholders; %1, %2, %3, and so on.  These will be replaced by the values of the variables passed in the
	   "vars" key.

	   By convention this string should be enclosed in parentheses, "(" and ")".  This helps make them stand out in the interface, if
	   localised versions of the error message have not yet been written.

       "vars"
	   An array reference.	The first entry in the array will replace the %1 placeholder in "error", the second entry will replace the %2
	   placeholder, and so on.

	   If there are no placeholders then pass a reference to an empty array.

EXAMPLES

   A simple exception, with no placeholders.
       In the action:

	 sub run {
	     ...
	     if(! frob_repo()) {
		 SVN::Web::X->throw(error => '(frob failed)',
				    vars  => []);
	     }
	     ...
	 }

       In the en.po file for the localised text.

	 msgid "(frob failed)"
	 msgstr "There was a problem trying to frob the repository.  This "
	 "probably indicates a permissions problem."

   An exception with placeholders
       In the action:

	 sub run {
	     ...
	     # $path is a repo path, $rev is a repo revision
	     my $root = $fs->revision_root($rev);
	     my $kind = $root->check_path($path);

	     if($kind == $SVN::Node::none) {
		 SVN::Web::X->throw(error => '(path %1 does not exist in rev %2)',
				    vars  => [$path, $rev]);
	     }
	 }

       In the en.po file for the localised text.

	 msgid "(path %1 does not exist in rev %2)"
	 msgstr "The path <tt>%1</tt> could not be found in the repository "
	 "at revision %2.  This may be a typo in the path or the revision "
	 "number.  SVN::Web should never normally generate a link like this. "
	 "If you followed a link from SVN::Web (rather than from an e-mail,
	 "or similar) please report this as a bug."

       As you can see, the localised text can be much friendlier and more informative to the user than the error message.

COPYRIGHT

       Copyright 2003-2004 by Chia-liang Kao "<clkao@clkao.org>".

       Copyright 2005-2007 by Nik Clayton "<nik@FreeBSD.org>".

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

       See <http://www.perl.com/perl/misc/Artistic.html>

perl v5.14.2							    2012-06-11							  SVN::Web::X(3pm)

Check Out this Related Man Page

SVN::Web::ConfigData(3pm)				User Contributed Perl Documentation				 SVN::Web::ConfigData(3pm)

NAME

       SVN::Web::ConfigData - Configuration for SVN::Web

SYNOPSIS

	 use SVN::Web::ConfigData;
	 $value = SVN::Web::ConfigData->config('foo');
	 $value = SVN::Web::ConfigData->feature('bar');

	 @names = SVN::Web::ConfigData->config_names;
	 @names = SVN::Web::ConfigData->feature_names;

	 SVN::Web::ConfigData->set_config(foo => $new_value);
	 SVN::Web::ConfigData->set_feature(bar => $new_value);
	 SVN::Web::ConfigData->write;  # Save changes

DESCRIPTION

       This module holds the configuration data for the "SVN::Web" module.  It also provides a programmatic interface for getting or setting that
       configuration data.  Note that in order to actually make changes, you'll have to have write access to the "SVN::Web::ConfigData" module,
       and you should attempt to understand the repercussions of your actions.

METHODS

       config($name)
	   Given a string argument, returns the value of the configuration item by that name, or "undef" if no such item exists.

       feature($name)
	   Given a string argument, returns the value of the feature by that name, or "undef" if no such feature exists.

       set_config($name, $value)
	   Sets the configuration item with the given name to the given value.	The value may be any Perl scalar that will serialize correctly
	   using "Data::Dumper".  This includes references, objects (usually), and complex data structures.  It probably does not include
	   transient things like filehandles or sockets.

       set_feature($name, $value)
	   Sets the feature with the given name to the given boolean value.  The value will be converted to 0 or 1 automatically.

       config_names()
	   Returns a list of all the names of config items currently defined in "SVN::Web::ConfigData", or in scalar context the number of items.

       feature_names()
	   Returns a list of all the names of features currently defined in "SVN::Web::ConfigData", or in scalar context the number of features.

       auto_feature_names()
	   Returns a list of all the names of features whose availability is dynamically determined, or in scalar context the number of such
	   features.  Does not include such features that have later been set to a fixed value.

       write()
	   Commits any changes from "set_config()" and "set_feature()" to disk.  Requires write access to the "SVN::Web::ConfigData" module.

AUTHOR

       "SVN::Web::ConfigData" was automatically created using "Module::Build".	"Module::Build" was written by Ken Williams, but he holds no
       authorship claim or copyright claim to the contents of "SVN::Web::ConfigData".

perl v5.14.2							    2012-06-11						 SVN::Web::ConfigData(3pm)

Linux and UNIX Man Pages

svn::web::x(3pm) [debian man page]

Check Out this Related Man Page