Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

dancer::object(3pm) [debian man page]

Dancer::Object(3pm)					User Contributed Perl Documentation				       Dancer::Object(3pm)

NAME

       Dancer::Object - Objects base class for Dancer

SYNOPSIS

	   package My::Dancer::Extension;

	   use strict;
	   use warnings;
	   use base 'Dancer::Object';

	   __PACKAGE__->attributes( qw/name value this that/ );

	   sub init {
	       # our initialization code, if we need one
	   }

DESCRIPTION

       While we love Moose, we can't use it for Dancer and still keep Dancer minimal, so we wrote Dancer::Object instead.

       It provides you with attributes and an initializer.

METHODS

   new
       Creates a new object of whatever is based off Dancer::Object. This is a generic "new" method so you don't have to write one yourself when
       extending "Dancer::Object".

       It accepts arguments in a hash and runs an additional "init" method (described below) which you should implement.

   init
       Exists but does nothing. This is so you won't have to write an initializer if you don't want to.

   clone
       Creates and returns a clone of the object using Clone, which is loaded dynamically. If we cannot load Clone, we throw an exception.

   get_attributes
       Get the attributes of the specific class.

   attributes
       Generates attributes for whatever object is extending Dancer::Object and saves them in an internal hashref so they can be later fetched
       using "get_attributes".

       For each defined attribute you can access its value using:

	 $self->your_attribute_name;

       To set a value use

	 $self->your_attribute_name($value);

       Nevertheless, you can continue to use these attributes as hash keys, as usual with blessed hash references:

	 $self->{your_attribute_name} = $value;

       Although this is possible we defend you should use the method approach, as it maintains compatibility in case "Dancer::Object" structure
       changes in the future.

   attributes_defaults
	 $self->attributes_defaults(length => 2);

       given a hash (not a hashref), makes sure an object has the given attributes default values. Usually called from within an "init" function.

AUTHOR

       Alexis Sukrieh

LICENSE AND COPYRIGHT

       Copyright 2009-2010 Alexis Sukrieh.

       This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as
       published by the Free Software Foundation; or the Artistic License.

       See http://dev.perl.org/licenses/ for more information.

perl v5.14.2							    2011-11-30						       Dancer::Object(3pm)

Check Out this Related Man Page

Dancer::Cookie(3pm)					User Contributed Perl Documentation				       Dancer::Cookie(3pm)

NAME

       Dancer::Cookie - class representing cookies

SYNOPSIS

	   use Dancer::Cookie;

	   my $cookie = Dancer::Cookie->new(
	       name => $cookie_name, value => $cookie_value
	   );

DESCRIPTION

       Dancer::Cookie provides a HTTP cookie object to work with cookies.

ATTRIBUTES

   name
       The cookie's name.

   value
       The cookie's value.

   expires
       The cookie's expiration date.  There are several formats.

       Unix epoch time like 1288817656 to mean "Wed, 03-Nov-2010 20:54:16 GMT"

       A human readable offset from the current time such as "2 hours".  It currently understands...

	   s second seconds sec secs
	   m minute minutes min mins
	   h hr hour hours
	   d day days
	   w week weeks
	   M month months
	   y year years

       Months and years are currently fixed at 30 and 365 days.  This may change.

       Anything else is used verbatim.

   domain
       The cookie's domain.

   path
       The cookie's path.

   secure
       If true, it instructs the client to only serve the cookie over secure connections such as https.

   http_only
       By default, cookies are created with a property, named "HttpOnly", that can be used for security, forcing the cookie to be used only by the
       server (via HTTP) and not by any JavaScript code.

       If your cookie is meant to be used by some JavaScript code, set this attribute to 0.

METHODS
/SUBROUTINES
   new
       Create a new Dancer::Cookie object.

       You can set any attribute described in the ATTRIBUTES section above.

   init
       Runs an expiration test and sets a default path if not set.

   to_header
       Creates a proper HTTP cookie header from the content.

AUTHOR

       Alexis Sukrieh

LICENSE AND COPYRIGHT

       Copyright 2009-2010 Alexis Sukrieh.

       This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as
       published by the Free Software Foundation; or the Artistic License.

       See http://dev.perl.org/licenses/ for more information.

perl v5.14.2							    2011-11-30						       Dancer::Cookie(3pm)
Man Page