Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
CGI::Application::PlugUserCContributedGPe:Application::Plugin::Config::YAML(3)

NAME
       CGI::Application::Plugin::Config::YAML -	add Config::YAML support to
       CGI::Application

VERSION
       This documentation refers to CGI::Application::Plugin::Config::YAML
       version 0.01

SYNOPSIS
	   package My::App;

	   use CGI::Application::Plugin::Config::YAML;

	   sub cgiapp_init {
	       my $self	= shift;
	       $self->config_file('ataris.yml');
	   }

	   sub myrunmode{
	       my $self	= shift;

	       my $artist_name = $self->config_param('artist_name');

	       $self->config_param(artist_name => 'ataris');

	       my $new_artist_name = $self->config_param('artist_name');

	       my %data	= (cd => 'So Long, Astoria');
	       $self->config_fold(\%data);

	       my $cd =	$self->config_param('cd');

	       $self->config_read('U2.yml');

		.....
	   }

DESCRIPTION
       This plug-in add	Config::YAML support to	CGI::Application.  The usage
       of this plug-in is almost the same as
       CGI::Application::Plugin::Config::Simple.  This plug-in can be easily
       used instead of CGI::Application::Plugin::Config::Simple.  This plug-in
       refers to CGI::Application::Plugin::Config::Simple.

METHOD
   config_file
	$self->config_file('ataris.yml');

       YAML file is set.  $ENV{CGIAPP_CONFIG_FILE} is used if there is no
       args.

   config_param
	my $name = $self->config_param('artist_name');

       A corresponding value to	the argument is	returned.

	my $config_hash	= $self->config_param();

       The entire config structure will	be returned as a hash ref.

   config
	$self->config;

       This method will	return the Config::YAML's object.  A new
       Config::YAML's object is	made if	there is a change in config_file.

   config_fold
	   my %data = (cd => 'So Long, Astoria');
	   $self->config_fold(\%data);

       Call Config::YAML::fold.

   config_read
	$self->config_read('./U2.yml');

       Call Config::YAML::read.

DEPENDENCIES
       strict

       warnings

       CGI::Application

       Config::YAML

BUGS AND LIMITATIONS
       There are no known bugs in this module.	Please report problems to
       Atsushi Kobayashi (<nekokak@cpan.org>) Patches are welcome.

SEE ALSO
       CGI::Application

       YAML

       Config::YAML

       CGI::Application::Plugin::Config::Simple

Thanks TO
       Michael Peters (CGI::Application::Plugin::Config::Simple's AUTHOR)

AUTHOR
       Atsushi Kobayashi, <nekokak@cpan.org>

COPYRIGHT AND LICENSE
       Copyright (C) 2005 by Atsushi Kobayashi (<nekokak@cpan.org>). All
       rights reserved.

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

perl v5.32.0			  200CGI::Application::Plugin::Config::YAML(3)

NAME | VERSION | SYNOPSIS | DESCRIPTION | METHOD | DEPENDENCIES | BUGS AND LIMITATIONS | SEE ALSO | Thanks TO | AUTHOR | COPYRIGHT AND LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=CGI::Application::Plugin::Config::YAML&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help