/usr/share/perl5/MongoDBx/Class/Reference.pm is in libmongodbx-class-perl 1.030002-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 | package MongoDBx::Class::Reference;
# ABSTRACT: An embedded document representing a reference to a different document (thus establishing a relationship)
our $VERSION = "1.030002";
$VERSION = eval $VERSION;
use Moose;
use namespace::autoclean;
use Carp;
=head1 NAME
MongoDBx::Class::Reference - An embedded document representing a reference to a different document (thus establishing a relationship)
=head1 VERSION
version 1.030002
=head1 CONSUMES
L<MongoDBx::Class::EmbeddedDocument>
=head1 DESCRIPTION
This class represents a reference (or "join") to a MongoDB document.
In L<MongoDBx::Class>, references are expected to be in the DBRef format,
as defined in L<http://www.mongodb.org/display/DOCS/Database+References>,
for example (this is a JSON example):
{ "$ref": "collection_name", "$id": ObjectId("4cbca90d3a41e35916720100") }
=cut
with 'MongoDBx::Class::EmbeddedDocument';
=head1 ATTRIBUTES
Aside from attributes provided by L<MongoDBx::Class::EmbeddedDocument>,
the following attributes are provided:
=head2 ref_coll
A string representing the collection in which the reference document is
stored (translates to the '$ref' hash key above).
=head2 ref_id
A L<MongoDB::OID> object with the internal ID of the referenced document
(translates to the '$id' hash key above).
=cut
has 'ref_coll' => (is => 'ro', isa => 'Str', required => 1);
has 'ref_id' => (is => 'ro', isa => 'MongoDB::OID', required => 1);
=head1 METHODS
Aside from methods provided by L<MongoDBx::Class::EmbeddedDocument>,
the following methods are provided:
=head2 load()
Returns the document referenced by this object, after expansion. This is
mostly used internally, you don't have to worry about it.
=cut
sub load {
my $self = shift;
return $self->_collection->_database->get_collection($self->ref_coll)->find_one($self->ref_id);
}
=head1 AUTHOR
Ido Perlmuter, C<< <ido at ido50.net> >>
=head1 BUGS
Please report any bugs or feature requests to C<bug-mongodbx-class at rt.cpan.org>, or through
the web interface at L<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.
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
perldoc MongoDBx::Class::Reference
You can also look for information at:
=over 4
=item * RT: CPAN's request tracker
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=MongoDBx::Class>
=item * AnnoCPAN: Annotated CPAN documentation
L<http://annocpan.org/dist/MongoDBx::Class>
=item * CPAN Ratings
L<http://cpanratings.perl.org/d/MongoDBx::Class>
=item * Search CPAN
L<http://search.cpan.org/dist/MongoDBx::Class/>
=back
=head1 SEE ALSO
L<MongoDBx::Class::EmbeddedDocument>.
=head1 LICENSE AND COPYRIGHT
Copyright 2010-2014 Ido Perlmuter.
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.
=cut
__PACKAGE__->meta->make_immutable;
|