.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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 "DBIx::Class::IntrospectableM2M 3pm"
.TH DBIx::Class::IntrospectableM2M 3pm "2021-01-05" "perl v5.32.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"
DBIx::Class::IntrospectableM2M \- Introspect many\-to\-many shortcuts
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
In your DBIx::Class Result class
(sometimes erroneously referred to as the 'table' class):
.PP
.Vb 1
\&  _\|_PACKAGE_\|_\->load_components(qw/IntrospectableM2M ... Core/);
\&
\&  #Digest encoder with hex format and SHA\-1 algorithm
\&  _\|_PACKAGE_\|_\->many_to_many(roles => user_roles => \*(Aqrole);
.Ve
.PP
When you want to introspect this data
.PP
.Vb 10
\&   my $metadata = $result_class\->_m2m_metadata\->{roles};
\&   #  $metadata\->{accessor} method name e.g. \*(Aqroles\*(Aq
\&   #  $metadata\->{relation} maping relation e.g. \*(Aquser_roles\*(Aq
\&   #  $metadata\->{foreign_relation} far\-side relation e.g. \*(Aqrole
\&   #  $metadata\->{attrs}  relationship attributes, if any
\&   # Convenience methods created by DBIx::Class
\&   #  $metadata\->{rs_method}     \*(Aqroles_rs\*(Aq
\&   #  $metadata\->{add_method}    \*(Aqadd_to_roles\*(Aq,
\&   #  $metadata\->{set_method}    \*(Aqset_roles\*(Aq,
\&   #  $metadata\->{remove_method} \*(Aqremove_from_roles\*(Aq
.Ve
.PP
\&\fBNote:\fR The component needs to be loaded \fIbefore\fR Core.
.SH "COMPATIBILITY NOTICE"
.IX Header "COMPATIBILITY NOTICE"
This module is fairly esoteric and, unless you are dynamically creating
something out of a \s-1DBIC\s0 Schema, is probably the wrong solution for
whatever it is you are trying to do. Please be advised that compatibility
is not guaranteed for DBIx::Class 0.09000+. We will try to manitain all
compatibility, but internal changes might make it impossible.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Because the many-to-many relationships are not real relationships, they can not
be introspected with DBIx::Class. Many-to-many relationships are actually just
a collection of convenience methods installed to bridge two relationships.
This DBIx::Class component can be used to store all relevant information
about these non-relationships so they can later be introspected and examined.
.SH "METHODS"
.IX Header "METHODS"
.SS "many_to_many"
.IX Subsection "many_to_many"
Extended to store all relevant information in the \f(CW\*(C`_m2m_metadata\*(C'\fR \s-1HASH\s0 ref.
.SS "_m2m_metadata"
.IX Subsection "_m2m_metadata"
Accessor to a \s-1HASH\s0 ref where the keys are the names of m2m relationships and
the value is a \s-1HASH\s0 ref as described in the \s-1SYNOPSIS.\s0
.SH "AUTHOR"
.IX Header "AUTHOR"
Guillermo Roditi (groditi) <groditi@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2008 by Guillermo Roditi
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.