- Entran en vigencia las modificaciones realizadas por el XMI2CODE

[mecon/meconlib.git] / marco / php / marco / Script.php

diff --git a/marco/php/marco/Script.php b/marco/php/marco/Script.php
index 25cd52cc5e3638389b58e36ba8bb8e8fbbd9b7ae..8a7c1c4103c8381d7f6a365867eee2a67512d86c 100644 (file)
--- a/marco/php/marco/Script.php
+++ b/marco/php/marco/Script.php
@@ -1,72 +1,86 @@
 <?php
 // vim: set expandtab tabstop=4 softtabstop=4 shiftwidth=4:
-// +--------------------------------------------------------------------+
-// |                            Script                                  |
-// +--------------------------------------------------------------------+
-// |   Liberia generica para el manejo de los scripts de los sistemas   |
-// |                      Ministerio de Economía                        |
-// +--------------------------------------------------------------------+
-// | Creado: thu apr 03 ART 2003                                        |
-// | Autor:  Martin Marrese <mmarre@mecon.gov.ar>                       |
-// +--------------------------------------------------------------------+
-// 
+// +----------------------------------------------------------------------+
+// | PHP Version 4                                                        |
+// +----------------------------------------------------------------------+
+// | Copyright (c) 1997-2003 The PHP Group                                |
+// +----------------------------------------------------------------------+
+// | This source file is subject to version 2.02 of the PHP license,      |
+// | that is bundled with this package in the file LICENSE, and is        |
+// | available at through the world-wide-web at                           |
+// | http://www.php.net/license/2_02.txt.                                 |
+// | If you did not receive a copy of the PHP license and are unable to   |
+// | obtain it through the world-wide-web, please send a note to          |
+// | license@php.net so we can mail you a copy immediately.               |
+// +----------------------------------------------------------------------+
+// | Created: Mon Apr 14 16:23:22 2003
+// | Author:  Martin Marrese <mmarre@mecon.gov.ar>
+// +----------------------------------------------------------------------+
+//
 // $Id$
-// 
+// $Author$
 // $URL$
-// $Rev$
 // $Date$
-// $Author$
+// $Rev$
+//
 
 require_once 'PEAR.php';
 
 define ('SCRIPT_GENERICO', '/www/js/scripts.js');
 
+// +X2C Class 11 :Script
 /**
- * Manejo de los Scripts
+ * Clase para el manejo de los scripts del sistema. En primera instancia agrega el archivo de script generico que permite el manejo de secciones, etc. Ademas se pueden agregar archivos de script propios del sistema.
  *
- * Libreria para le manejo de los scripts para los sistemas de intranet.
- *
- * @version $Rev$
- * @author  $Author$
+ * @access public
  */
-
-class Script extends PEAR {
-
+class Script {
     /**
-     * Directorio del sistema
+     * Nombre del directorio en donde se encuentra el sistema. Es case sensitive.
+     *
+     * @var    string $_directorio
      *
-     * @var string
+     * @access private
      */
     var $_directorio;
 
-   /**
-     * Array con archivos de script agregdos
+    /**
+     * Array con los nombre de los archivos de script que se fueron agregando.
+     *
+     * @var    array(string) $_archivos
      *
-     * @var array
+     * @access private
      */
     var $_archivos;
 
+    // ~X2C
+
+    // +X2C Operation 42
     /**
-     * Constructor. 
+     * Constructor. Recibe como parametro el directorio en donde se encuentra el sistema. Es case sensitive.
+     *
+     * @param  string $directorio Nombre del directorio en donde se ecuentra el sistema.
      *
-     * Recibe como parametro el directorio sistema. Es case sensitive.
+     * @return void
      *
-     * @param string $directorio
-     * 
      * @access public
      */
-    function Script ($directorio) 
+    function Script($directorio) // ~X2C
     {
         $this->_directorio  = $directorio;
         $this->_archivos    = array ();
     }
+    // -X2C
 
+    // +X2C Operation 43
     /**
-     * Funcion que devuelve el html a mostrar 
+     * Funcion que devuelve un string html con la informacion a imprimir en pantalla.
+     *
+     * @return string
      *
      * @access public
      */
-    function toHtml () 
+    function toHtml() // ~X2C
     {
         $TEXTO = "\n".'<script language="JavaScript" src="'.SCRIPT_GENERICO.'"></script>'."\n";        
         foreach ($this->_archivos as $archivo) {
@@ -74,22 +88,24 @@ class Script extends PEAR {
         }        
         return $TEXTO;
     }
+    // -X2C
 
+    // +X2C Operation 45
     /**
-     * Agrego archivos de script
+     * Funcion que permite agregar un archivo de script nuevo.
      *
-     * Funcion que permite agregar archivos con javascript ademas del
-     * archivo generico de script. Recibe como parametro el nombre
-     * del archivo. Este lo va a buscar en el subdirectorio js del 
-     * directorio www del sistema.
+     * @param  string $archivo Nombre del archivo a agregar.
      *
-     * @param string $archivo
+     * @return void
      *
      * @access public
      */
-    function agregarArchivo($archivo)
+    function agregarArchivo($archivo) // ~X2C
     {
         array_push($this->_archivos, $archivo);
     }
-}
+    // -X2C
+
+} // -X2C Class :Script
+
 ?>