<?php /* vim: set binary expandtab tabstop=4 shiftwidth=4 textwidth=80:
-------------------------------------------------------------------------------
                                    mlib
-------------------------------------------------------------------------------
This file is part of mlib.

mlib is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 2 of the License, or (at your option)
any later version.

mlib is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License; if not,
write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
Boston, MA  02111-1307  USA
-------------------------------------------------------------------------------
Creado: Fri Oct 24 16:34:11 2003
Autor:  Martin Marrese <mmarre@mecon.gov.ar>
-------------------------------------------------------------------------------
$Id$
-----------------------------------------------------------------------------*/

require_once 'MLIB/PDF.php';
require_once 'MLIB/PDF/Separador.php';
require_once 'MLIB/PDF/HeaderDefecto.php';

/**
 * Libreria que crea un marco estandar para los pdfs.
 */
class MLIB_PDF_Marco extends MLIB_PDF {

    /**
     * Objeto MLIB_PDF_Separador que se utilizara por defecto.
     * @var Object $separador
     * @access protected
     */
    var $_separador_defecto;

    /**
     * Array de objetos MLIB_PDF_Contenido
     * @var array $contenido
     * @access protected
     */
    var $_contenido = array();
    
    /**
     * Espacio dispobible en la pagina. Representa la coordenada Y a partir de
     * la cual se puede comenzar a escribir el contenido.
     * @var int $espacioDisponible
     * @access public
     */
    var $espacioDisponible;

    /**
     * Logo.
     * @var string $logo
     * @access public
     */
    var $logo; 

    /**
     * Paginador.
     * @var bool $paginador
     * @access public 
     */
    var $paginador = true;

    /**
     * Fecha. Si es true se pone la fecha del servidor, si es false no se pone
     * nada, en caso contrario se pone lo que haya en esta variable.
     * @var mixed $fecha
     * @access public
     */
    var $fecha = true;
    
    /**
     * Seccion.
     * @var string $seccion
     * @access public 
     */
    var $seccion = '';

    /**
     * SubSeccion.
     * @var string $subseccion
     * @access public 
     */
    var $subseccion = 'Ministerio de Economia';

    /**
     * Titulo.
     * @var string $string
     * @access public 
     */
    var $titulo;

    /**
     * SubTitulo.
     * @var string $subtitulo
     * @access public 
     */
    var $subtitulo;

    /**
     * Excepciones al encabezado
     * @var array $excepciones
     * @access protected
     */
    var $_excepciones = array ();

    /**
     * MLIB_PDF_Header. Objeto que hay que utilizar como enzabezado. Si hay
     * algo aqui se desecha el encabezado por defecto.
     * @var Object $header
     * @access public
     */
    var $header = null;
     
    /**
     * Class constructor.
     *
     * @param string $tam Tamanio de las hojas.
     * @param string $ori Orientacion de las hojaz (portrait o landscape).
     * @param string $nom Nombre del archivo.
     *
     * @return void
     * @access public
     */
    function MLIB_PDF_Marco($tam = "a4", $ori = "portrait", $nom = 'Doc.pdf') {
        $this->MLIB_PDF($tam, $ori, $nom);
        $this->tamanio = $tam;
        $this->_resetConf();
        $this->_separador_defecto =& new MLIB_PDF_Separador();
    }

    /**
     *  Funcion que setea los valores de conf para poder poner las cabeceras
     *  @access private
     *  @param int $pagina numero del la pagina de la que debe setear loa
     *  valores
     *  @return void
     */
    function _resetConf($pagina = null)
    {
        if(is_null($pagina));
            $pagina = $this->numPage();
        $tmp = include 'MLIB/PDF/Marco/medidas.php' ; 
        $tmp = $tmp[$this->tamanio][$this->getOrientation($pagina)];
        $tmp['Xi'] = $this->_config['Xi'];
        $tmp['Yi'] = $this->_config['Yi'];
        $tmp['Xf'] = $this->_config['Xf'];
        $tmp['Yf'] = $this->_config['Yf'];
        $this->_config = $tmp;
    }

    /**
     * Permite agregar nuevas paginas al pdf que se esta armando.
     *
     * @param string $pagina Tipo de pagina que se va a utilizar.
     * @param string $orientacion Orientacion de la hoja
     * @param bool $encabezado Indica si el encabezado debe ponerse en la
     * pagina.
     * @param string $seccion Seccion del encabezado para esta pagina nueva.
     * @param string $subseccion SubSeccion del encabezado para esta pagina 
     * nueva.
     *
     * @return void
     * @access public
     */
    function newPage($pagina = 'a4', $orientacion = null, $encabezado = true, 
            $seccion = null, $subseccion = null) {   
        parent::newPage($pagina, $orientacion);
        $this->_resetConf();
        if ($encabezado) {
            $this->espacioDisponible = $this->header->getAltura() - 27;
            if ($this->countPages() === 1) {
                if ($this->titulo || $this->subtitulo) {
                    $this->espacioDisponible -= 27;
                }
            }
            if (!is_null($seccion)) {
                $this->_excepciones[$this->numPage()]['seccion'] = $seccion;
            }
            if (!is_null($subseccion)) {
                $this->_excepciones[$this->numPage()]['subseccion'] = $subseccion;
            }
        }
        else {
            $this->espacioDisponible = $this->_config['Yf'];
            $this->_excepciones[$this->countPages()]['nova'] = true;
            
        }
    }

    /**
     * Funcion que permite agregar el titulo a una pagina.
     *
     * @return void
     * @access protected
     */
    function _addTitle() {
        $this->_resetConf();
        $conf = $this->_config['titulo'];
        if ($this->titulo) {
            $tmp = $this->strlen($this->titulo, $conf);
            $tmp2 = $this->getWidth();
            if ($tmp >= $tmp2) {
                $this->titulo = $this->wrapLine ($this->titulo, $tmp2,
                        $conf);
                $tmp = $this->strlen($this->titulo, $conf);
            }
            $init = ($tmp2 - $tmp) / 2; 
            $this->addText($init, $conf['Y'], $this->titulo, 
                    $conf);
        }
    }

    /**
     * Funcion que permite agregar el subtitulo a una pagina.
     *
     * @return void
     * @access protected
     */
    function _addSubTitle() {
        $this->_resetConf();
        $conf = $this->_config['subtitulo'];
        if ($this->subtitulo) {
            $tmp = $this->strlen($this->subtitulo, $conf);
            $tmp2 = $this->getWidth();
            if ($tmp >= $tmp2) {
                $this->subtitulo = $this->wrapLine ($this->subtitulo, $tmp2,
                        $conf);
                $tmp = $this->strlen($this->subtitulo, $conf);
            }
            $init = ($tmp2 - $tmp) / 2; 
            $this->addText($init, $conf['Y'], $this->subtitulo, 
                    $conf);
        }
    }
    
    /**
     * Funcion que agrega el encabezado a la pagina actual.      
     *
     * @param bool $title Muetra o no el titulo.
     * @param bool $subtitle Muestra o no el subtitulo.
     *
     * @return void
     * @access protected
     */
    function _buildHeader($title = true, $subtitle = true) {
        //Agrego el header.
        $this->header->toPdf($this);
        if ($title) {
            $this->_addTitle();
        }
        if ($subtitle) {
            $this->_addSubTitle();
        }
    }

    /**
     * Funcion que crea el Header por defecto.
     *
     * @return void
     * @access protected
     */
    function _crearHeaderDefecto() {
        $this->header =& new MLIB_PDF_HeaderDefecto($this->tamanio,
                $this->getOrientation($this->numPage()));
        if (@$this->logo) {
            $this->header->logo = $this->logo;
        }
        $this->header->seccion = $this->seccion;
        $this->header->subseccion = $this->subseccion;
        $this->header->paginador = $this->paginador;
        $this->header->fecha = $this->fecha;
    }
    
    /**
     * Funcion que agrega el contenido al PDF.
     *
     * @return void
     * @access protected
     */
    function _buildContent() {
        $this->_resetConf();
        if ($this->_contenido) {
            foreach ($this->_contenido as $cont) {
                $cont->toPDF($this); 
                //MLIB_PDF_Marco se pasa por referencia para que se agregen las
                //paginas a medida que se van necesitando. Esto permite que varie el
                //tipo de contenido que se agrega.
            }
        }
    }

    /**
     * Funcion que se encarga de transformar la informacion para que se genere
     * el archivo pdf.
     *
     * @return pdffile Archivo PDF.
     * @access public
     */
    function toPDF() {
        //Veo si hay que utilizar o no el header por defecto.
        if (!$this->header) {
            $this->_crearHeaderDefecto();
        }
        
        $this->_buildContent();
        if ($this->getPages()) {
            $t = true;
            foreach ($this->getPages() as $page) {
                $this->_pagina_actual = $page;
                
                $sec = $this->header->seccion;
                $subsec = $this->header->subseccion;
                
                if (@$this->_excepciones[$this->numPage($page)]['seccion']) {
                    $this->header->seccion = 
                        $this->_excepciones[$this->numPage($page)]['seccion'];
                }
                
                if (@$this->_excepciones[$this->numPage($page)]['subseccion']) {
                    $this->header->subseccion = 
                        $this->_excepciones[$this->numPage($page)]['subseccion'];
                }
                
                if (@!$this->_excepciones[$this->numPage($page)]['nova']) {
                    $this->_buildHeader($t, $t);      
                }
                //Solo agrego el titulo y subtitulo en la primer hoja
                $t = false;
                
                $this->header->seccion = $sec;
                $this->header->subseccion = $subsec;
            }
        return parent::toPDF();
        }
    }

    /**
     * Funcion que pemite agregar contenido al PDF.
     *
     * @param mixed $contenido Objeto contenido que se agrega.
     * @param bool $separador Indicacion si hay que agregar un separador.
     *
     * @return void
     * @access public
     */
    function addContent($contenido, $separador = true) {
        //Me aseguro de poner el separador siempre y cuando no sea el primer
        //objeto de la primer pagina.
        if ($separador && $this->_contenido) {
            $this->_contenido[] = $this->_separador_defecto;
        }
        $this->_contenido[] = $contenido;
    }
}
?>