.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Dancer::Object 3pm"
.TH Dancer::Object 3pm "2023-02-10" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Dancer::Object \- Objects base class for Dancer
.SH "VERSION"
.IX Header "VERSION"
version 1.3521
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    package My::Dancer::Extension;
\&
\&    use strict;
\&    use warnings;
\&    use base \*(AqDancer::Object\*(Aq;
\&
\&    _\|_PACKAGE_\|_\->attributes( qw/name value this that/ );
\&
\&    sub init {
\&        # our initialization code, if we need one
\&    }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
While we \fBlove\fR Moose, we can't use it for Dancer and still keep Dancer
minimal, so we wrote Dancer::Object instead.
.PP
It provides you with attributes and an initializer.
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
Creates a new object of whatever is based off Dancer::Object. This is a generic
\&\f(CW\*(C`new\*(C'\fR method so you don't have to write one yourself when extending
\&\f(CW\*(C`Dancer::Object\*(C'\fR.
.PP
It accepts arguments in a hash and runs an additional \f(CW\*(C`init\*(C'\fR method (described
below) which you should implement.
.SS "init"
.IX Subsection "init"
Exists but does nothing. This is so you won't have to write an initializer if
you don't want to.
.SS "clone"
.IX Subsection "clone"
Creates and returns a clone of the object using Clone, which is loaded
dynamically. If we cannot load Clone, we throw an exception.
.SS "get_attributes"
.IX Subsection "get_attributes"
Get the attributes of the specific class.
.SS "attributes"
.IX Subsection "attributes"
Generates attributes for whatever object is extending Dancer::Object and saves
them in an internal hashref so they can be later fetched using
\&\f(CW\*(C`get_attributes\*(C'\fR.
.PP
For each defined attribute you can access its value using:
.PP
.Vb 1
\&  $self\->your_attribute_name;
.Ve
.PP
To set a value use
.PP
.Vb 1
\&  $self\->your_attribute_name($value);
.Ve
.PP
Nevertheless, you can continue to use these attributes as hash keys,
as usual with blessed hash references:
.PP
.Vb 1
\&  $self\->{your_attribute_name} = $value;
.Ve
.PP
Although this is possible we defend you should use the method
approach, as it maintains compatibility in case \f(CW\*(C`Dancer::Object\*(C'\fR
structure changes in the future.
.SS "attributes_defaults"
.IX Subsection "attributes_defaults"
.Vb 1
\&  $self\->attributes_defaults(length => 2);
.Ve
.PP
given a hash (not a hashref), makes sure an object has the given attributes
default values. Usually called from within an \f(CW\*(C`init\*(C'\fR function.
.SH "AUTHOR"
.IX Header "AUTHOR"
Dancer Core Developers
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2010 by Alexis Sukrieh.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.