File Coverage

blib/lib/Excel/Writer/XLSX/Package/Metadata.pm

Criterion	Covered	Total	%
statement	68	68	100.0
branch			n/a
condition			n/a
subroutine	15	15	100.0
pod	0	1	0.0
total	83	84	98.8

###############################################################################
#
# Metadata - A class for writing the Excel XLSX metadata.xml file.
#
# Used in conjunction with Excel::Writer::XLSX
#
# Copyright 2000-2021, John McNamara, [e-mail]
#
# Documentation after __END__
#

# perltidy with the following options: -mbl=2 -pt=0 -nola

use 5.008002;
use strict;
use warnings;
use Carp;
use Excel::Writer::XLSX::Package::XMLwriter;

our @ISA     = qw(Excel::Writer::XLSX::Package::XMLwriter);
our $VERSION = '1.09';


###############################################################################
#
# Public and private API methods.
#
###############################################################################


###############################################################################
#
# new()
#
# Constructor.
#

    my $class = shift;
    my $fh    = shift;
    my $self  = Excel::Writer::XLSX::Package::XMLwriter->new( $fh );

    bless $self, $class;

    return $self;
}


###############################################################################
#
# _assemble_xml_file()
#
# Assemble and write the XML file.
#

    my $self = shift;

    $self->xml_declaration;

    # Write the metadata element.
    $self->_write_metadata();

    # Write the metadataTypes element.
    $self->_write_metadata_types();

    # Write the futureMetadata element.
    $self->_write_future_metadata();

    # Write the cellMetadata element.
    $self->_write_cell_metadata();

    $self->xml_end_tag( 'metadata' );

    # Close the XML writer filehandle.
    $self->xml_get_fh()->close();
}


###############################################################################
#
# XML writing methods.
#
###############################################################################


##############################################################################
#
# _write_metadata()
#
# Write the <metadata> element.
#

    my $self  = shift;
    my $xmlns = 'http://schemas.openxmlformats.org/spreadsheetml/2006/main';
    my $xmlns_xda =
      'http://schemas.microsoft.com/office/spreadsheetml/2017/dynamicarray';

    my @attributes = (
        'xmlns'     => $xmlns,
        'xmlns:xda' => $xmlns_xda,
    );

    $self->xml_start_tag( 'metadata', @attributes );
}


##############################################################################
#
# _write_metadata_types()
#
# Write the <metadataTypes> element.
#

    my $self  = shift;

    my @attributes = ( 'count' => 1 );

    $self->xml_start_tag( 'metadataTypes', @attributes );

    # Write the metadataType element.
    $self->_write_metadata_type();

    $self->xml_end_tag( 'metadataTypes' );
}


##############################################################################
#
# _write_metadata_type()
#
# Write the <metadataType> element.
#

    my $self = shift;

    my @attributes = (
        'name'                => 'XLDAPR',
        'minSupportedVersion' => 120000,
        'copy'                => 1,
        'pasteAll'            => 1,
        'pasteValues'         => 1,
        'merge'               => 1,
        'splitFirst'          => 1,
        'rowColShift'         => 1,
        'clearFormats'        => 1,
        'clearComments'       => 1,
        'assign'              => 1,
        'coerce'              => 1,
        'cellMeta'            => 1,
    );

    $self->xml_empty_tag( 'metadataType', @attributes );
}


##############################################################################
#
# _write_future_metadata()
#
# Write the <futureMetadata> element.
#

    my $self  = shift;

    my @attributes = (
        'name'  => 'XLDAPR',
        'count' => 1,
    );

    $self->xml_start_tag( 'futureMetadata', @attributes );
    $self->xml_start_tag( 'bk' );
    $self->xml_start_tag( 'extLst' );

    # Write the ext element.
    $self->_write_ext();

    $self->xml_end_tag( 'ext' );
    $self->xml_end_tag( 'extLst' );
    $self->xml_end_tag( 'bk' );

    $self->xml_end_tag( 'futureMetadata' );
}


##############################################################################
#
# _write_ext()
#
# Write the <ext> element.
#

    my $self = shift;

    my @attributes = ( 'uri' => '{bdbb8cdc-fa1e-496e-a857-3c3f30c029c3}' );

    $self->xml_start_tag( 'ext', @attributes );

    # Write the xda:dynamicArrayProperties element.
    $self->_write_xda_dynamic_array_properties();
}


##############################################################################
#
# _write_xda_dynamic_array_properties()
#
# Write the <xda:dynamicArrayProperties> element.
#

    my $self        = shift;

    my @attributes = (
        'fDynamic'   => 1,
        'fCollapsed' => 0,
    );

    $self->xml_empty_tag( 'xda:dynamicArrayProperties', @attributes );
}


##############################################################################
#
# _write_cell_metadata()
#
# Write the <cellMetadata> element.
#

    my $self  = shift;
    my $count = 1;

    my @attributes = ( 'count' => $count, );

    $self->xml_start_tag( 'cellMetadata', @attributes );
    $self->xml_start_tag( 'bk' );

    # Write the rc element.
    $self->_write_rc();

    $self->xml_end_tag( 'bk' );
    $self->xml_end_tag( 'cellMetadata' );
}


##############################################################################
#
# _write_rc()
#
# Write the <rc> element.
#

    my $self = shift;

    my @attributes = (
        't' => 1,
        'v' => 0,
    );

    $self->xml_empty_tag( 'rc', @attributes );
}


1;



=pod

=head1 NAME

Metadata - A class for writing the Excel XLSX metadata.xml file.

=head1 SYNOPSIS

See the documentation for L<Excel::Writer::XLSX>.

=head1 DESCRIPTION

This module is used in conjunction with L<Excel::Writer::XLSX>.

=head1 AUTHOR

John McNamara [e-mail]

=head1 COPYRIGHT

(c) MM-MMXXI, John McNamara.

All Rights Reserved. This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself.

=head1 LICENSE

Either the Perl Artistic Licence L<http://dev.perl.org/licenses/artistic.html> or the GPL L<http://www.opensource.org/licenses/gpl-license.php>.

=head1 DISCLAIMER OF WARRANTY

See the documentation for L<Excel::Writer::XLSX>.

=cut