The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

App::TMS::Client - Template Management System

SYNOPSIS

EXPORTS

Nothing exported by default

DEPENDENCIES

This module requires these other modules and libraries:

    Error::Programatic
    Perl::Module
    File::Spec
    List::Util
    Error
    Data::Format::Hash
    App::TMS::Common
    Error::Simple
    Parse::Template::Standard
    Data::Hub::Util
    App::TMS::Debug
    Data::OrderedHash
    Data::Compare
    Data::Hub
    Data::Hub::FileSystem::Node
    Cwd

DESCRIPTION

PUBLIC INTERFACE

new

Construct a new instance

connect

Connect to a repository

options:

  -force                        # Connect even when already connected

persist

Create a persistent connection to the repository

status

update

Update the targets for all instances of modified templates

compile

Compile a template

where:

  @vars                     # Key/value pairs formatted as: key=value

options:

  -force => 1               # Generate even if target exists
  -use => \@files           # Colon-separated list of data files

If $filename is omitted, output is written to STDOUT and the entry is not recorded in the instance database.

PACKAGE INTERNALS

_ping_repository

Test that the repository is reachable

_validate_connection

Ensure the repository is valid

_validate_persistent_connection

Ensure proper connection to the repository

_get_instance

Return an entry from the instances db

_get_instances

Return an instance entry for each target address

_addr_to_key

Return the instance db key for a given address

_compile

Compile according to the provided instance

where:

  $instance = {
    template => $template_addr,
    target => $target_addr || undef,
    vars => \%vars,
    use => \@paths,
  }

If $target_addr is defined, the result will be written there. Otherwise the result will be printed to STDOUT.

_set_statuses

Query and set status for each instance

_get_status

AUTHORS

    Ryan Gies <ryangies@cpan.org>

COPYRIGHT

    Copyright (C) 2014-2016 by Ryan Gies. All rights reserved.
    Copyright (C) 2006-2013 by Livesite Networks, LLC. All rights reserved.
    Copyright (C) 2000-2005 by Ryan Gies. All rights reserved.
    Redistribution and use in source and binary forms, with or without 
    modification, are permitted provided that the following conditions are met:
    * Redistributions of source code must retain the above copyright notice, 
    this list of conditions and the following disclaimer.
    * The origin of this software must not be misrepresented; you must not 
    claim that you wrote the original software. If you use this software in a 
    product, an acknowledgment in the product documentation would be 
    appreciated but is not required.
    * Altered source versions must be plainly marked as such, and must not be 
    misrepresented as being the original software.
    * The name of the author may not be used to endorse or promote products 
    derived from this software without specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED 
    WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
    MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO 
    EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
    OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
    IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
    OF SUCH DAMAGE.
    To the best of our knowledge, no patented algorithms have been used. However, we
    do not have the resources to carry out a patent search, and therefore cannot 
    give any guarantee of the above statement.