Current File : /home/opti/optisoftcom-new/perl/usr/lib/perl5/BSON/Code.pm
use 5.010001;
use strict;
use warnings;
package BSON::Code;
# ABSTRACT: BSON type wrapper for Javascript code
use version;
our $VERSION = 'v1.10.2';
use Carp ();
use Tie::IxHash;
use Moo;
#pod =attr code
#pod
#pod A string containing Javascript code. Defaults to the empty string.
#pod
#pod =attr scope
#pod
#pod An optional hash reference containing variables in the scope of C<code>.
#pod Defaults to C<undef>.
#pod
#pod =cut
has [ qw/code scope/ ] => (
is => 'ro'
);
use namespace::clean -except => 'meta';
#pod =method length
#pod
#pod Returns the length of the C<code> attribute.
#pod
#pod =cut
sub length {
length( $_[0]->code );
}
# Support legacy constructor shortcut
sub BUILDARGS {
my ($class) = shift;
my %args;
if ( @_ && $_[0] !~ /^[c|s]/ ) {
$args{code} = $_[0];
$args{scope} = $_[1] if defined $_[1];
}
else {
Carp::croak( __PACKAGE__ . "::new called with an odd number of elements\n" )
unless @_ % 2 == 0;
%args = @_;
}
return \%args;
}
sub BUILD {
my ($self) = @_;
$self->{code} = '' unless defined $self->{code};
Carp::croak( __PACKAGE__ . " scope must be hash reference, not $self->{scope}")
if exists($self->{scope}) && ref($self->{scope}) ne 'HASH';
return;
}
#pod =method TO_JSON
#pod
#pod If the C<BSON_EXTJSON> option is true, returns a hashref compatible with
#pod MongoDB's L<extended JSON|https://github.com/mongodb/specifications/blob/master/source/extended-json.rst>
#pod format, which represents it as a document as follows:
#pod
#pod {"$code" : "<code>"}
#pod {"$code" : "<code>", "$scope" : { ... } }
#pod
#pod If the C<BSON_EXTJSON> option is false, an error is thrown, as this value
#pod can't otherwise be represented in JSON.
#pod
#pod =cut
sub TO_JSON {
require BSON;
if ( $ENV{BSON_EXTJSON} ) {
my %data;
tie( %data, 'Tie::IxHash' );
$data{'$code'} = $_[0]->{code};
$data{'$scope'} = BSON->perl_to_extjson($_[0]->{scope})
if defined $_[0]->{scope};
return \%data;
}
Carp::croak( "The value '$_[0]' is illegal in JSON" );
}
1;
=pod
=encoding UTF-8
=head1 NAME
BSON::Code - BSON type wrapper for Javascript code
=head1 VERSION
version v1.10.2
=head1 SYNOPSIS
use BSON::Types ':all';
$code = bson_code( $javascript );
$code = bson_code( $javascript, $scope );
=head1 DESCRIPTION
This module provides a BSON type wrapper for the "Javascript code" type
and the "Javascript with Scope" BSON types.
=head1 ATTRIBUTES
=head2 code
A string containing Javascript code. Defaults to the empty string.
=head2 scope
An optional hash reference containing variables in the scope of C<code>.
Defaults to C<undef>.
=head1 METHODS
=head2 length
Returns the length of the C<code> attribute.
=head2 TO_JSON
If the C<BSON_EXTJSON> option is true, returns a hashref compatible with
MongoDB's L<extended JSON|https://github.com/mongodb/specifications/blob/master/source/extended-json.rst>
format, which represents it as a document as follows:
{"$code" : "<code>"}
{"$code" : "<code>", "$scope" : { ... } }
If the C<BSON_EXTJSON> option is false, an error is thrown, as this value
can't otherwise be represented in JSON.
=for Pod::Coverage BUILD BUILDARGS
=head1 AUTHORS
=over 4
=item *
David Golden <david@mongodb.com>
=item *
Stefan G. <minimalist@lavabit.com>
=back
=head1 COPYRIGHT AND LICENSE
This software is Copyright (c) 2018 by Stefan G. and MongoDB, Inc.
This is free software, licensed under:
The Apache License, Version 2.0, January 2004
=cut
__END__
# vim: set ts=4 sts=4 sw=4 et tw=75:
Mini Shell