.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" 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 turned on, 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "MongoDBx::Class::EmbeddedDocument 3pm"
.TH MongoDBx::Class::EmbeddedDocument 3pm "2014-02-04" "perl v5.18.2" "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"
MongoDBx::Class::EmbeddedDocument \- A MongoDBx::Class embedded (sub\-)document role
.SH "VERSION"
.IX Header "VERSION"
version 1.030002
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&        # create an embedded document class
\&        package MyApp::Schema::PersonName;
\&
\&        use MongoDBx::Class::Moose; # use this instead of Moose
\&        use namespace::autoclean;
\&        
\&        with \*(AqMongoDBx::Class::EmbeddedDocument\*(Aq;
\&
\&        has \*(Aqfirst_name\*(Aq => (is => \*(Aqro\*(Aq, isa => \*(AqStr\*(Aq, required => 1, writer => \*(Aqset_first_name\*(Aq);
\&        
\&        has \*(Aqmiddle_name\*(Aq => (is => \*(Aqro\*(Aq, isa => \*(AqStr\*(Aq, predicate => \*(Aqhas_middle_name\*(Aq, writer => \*(Aqset_middle_name\*(Aq);
\&
\&        has \*(Aqlast_name\*(Aq => (is => \*(Aqro\*(Aq, isa => \*(AqStr\*(Aq, required => 1, writer => \*(Aqset_last_name\*(Aq);
\&
\&        sub name {
\&                my $self = shift;
\&
\&                my $name = $self\->first_name;
\&                $name .= \*(Aq \*(Aq.$self\->middle_name.\*(Aq \*(Aq if $self\->has_middle_name;
\&                $name .= $self\->last_name;
\&
\&                return $name;
\&        }
\&
\&        _\|_PACKAGE_\|_\->meta\->make_immutable;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
MongoDBx::Class::EmbeddedDocument is a Moose role meant
to be consumed by document classes representing embedded documents. These
are documents that are entirely contained within parent MongoDB documents.
.PP
The role provides expanded embedded documents with some common attributes
and useful methods.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.SS "_collection"
.IX Subsection "_collection"
The MongoDBx::Class::Collection object representing the MongoDB collection
in which this embedded document is stored (more correctly, the collection
in which the MongoDBx::Class::Document holding this embedded document
is stored). This is a required attribute.
.SS "_class"
.IX Subsection "_class"
A string. The name of the document class of this embedded document.
A required attribute.
.SH "METHODS"
.IX Header "METHODS"
The following methods are provided:
.SS "\fIas_hashref()\fP"
.IX Subsection "as_hashref()"
Returns the embedded document as a hash reference, without the _collection
and _class attributes (if they exist).
.SH "INTERNAL METHODS"
.IX Header "INTERNAL METHODS"
.SS "\fI_database()\fP"
.IX Subsection "_database()"
Convenience shortcut for running \f(CW\*(C`$embd_doc\->_collection\->_database\*(C'\fR.
.SS "\fI_attributes()\fP"
.IX Subsection "_attributes()"
Returns a list of names of all attributes the embedded document object has,
minus '_collection' and '_class', sorted alphabetically.
.SH "AUTHOR"
.IX Header "AUTHOR"
Ido Perlmuter, \f(CW\*(C`<ido at ido50.net>\*(C'\fR
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests to \f(CW\*(C`bug\-mongodbx\-class at rt.cpan.org\*(C'\fR, or through
the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=MongoDBx\-Class>. I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.
.SH "SUPPORT"
.IX Header "SUPPORT"
You can find documentation for this module with the perldoc command.
.PP
.Vb 1
\&        perldoc MongoDBx::Class::EmbeddedDocument
.Ve
.PP
You can also look for information at:
.IP "\(bu" 4
\&\s-1RT: CPAN\s0's request tracker
.Sp
<http://rt.cpan.org/NoAuth/Bugs.html?Dist=MongoDBx::Class>
.IP "\(bu" 4
AnnoCPAN: Annotated \s-1CPAN\s0 documentation
.Sp
<http://annocpan.org/dist/MongoDBx::Class>
.IP "\(bu" 4
\&\s-1CPAN\s0 Ratings
.Sp
<http://cpanratings.perl.org/d/MongoDBx::Class>
.IP "\(bu" 4
Search \s-1CPAN\s0
.Sp
<http://search.cpan.org/dist/MongoDBx::Class/>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
MongoDBx::Class::Moose, MongoDBx::Class::Document.
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright 2010\-2014 Ido Perlmuter.
.PP
This program is free software; you can redistribute it and/or modify it
under the terms of either: the \s-1GNU\s0 General Public License as published
by the Free Software Foundation; or the Artistic License.
.PP
See http://dev.perl.org/licenses/ for more information.