Propósito
Este objeto recupera los datos del "ambiente" donde se encuentra instalado el sistema, proporcionando información sobre variables, directorios, cookies, códigos de seguridad, acciones permitidas (siteup), idiomas soportados y proporciona información através de métodos establecidos.
Se encuentra reservada la variable objeto $env para este propósito.
Valores
El sistema almacena internamente ciertos valores a lo largo de su existencia, algunos accesibles solo mediante el método correspondiente.
- $str_AVAILABLEACTIONS
- Opciones de acción disponibles.
- $str_AVAILABLELANGS
- Idiomas soportados.
- $str_SECCODE
- Código de seguridad. Es creado durante la instalación y permanece único.
- $str_FULLDOMAIN
- Nombre completo del dominio, incluyendo subdominio.
- $str_CPDOMAIN
- Directorio donde se encuentra panel de control.
- $str_CGIDIR
- Directorio de cgis, por defecto cgi-bin. Si es modificado, favor de verificar correspondencias posteriores.
- $str_HOME
- Directorio (~/) del usuario
- $str_TEMP
- Directorio temporal (~/tmp/) no visualizable via web. Utilizado para descargas.
- $str_HTDOCS
- Directorio de documentos html (~/public_html/).
- $str_ADMCP
- Ruta a panel administrativo (~/public_html/subdom/subdir/)
- $str_USRCP
- Ruta a panel de usuario (~/public_html/subdom/subdir/)
- $str_LOCALTEMP
- Directorio temporal web (~/public_html/subdom/subdir/temp/).
- $str_LANG
- Idioma actual.
- $str_IP
- Dirección ip del cliente
Descripción
El objeto $env, perteneciente a la clase EnvData es creado una única vez por llamado, ofreciendo los siguientes métodos:
- envAction(opt)
- Devuelve la acción actual. En caso de que se pase como parámetro la palabra "available" devuelve el valor de todas las acciones posibles.
- envLang(opt)
- Devuelve el idioma actual. En caso de que se pase como parámetro la palabra "available" devuelve el valor de todos los idiomas soportados.
- envSecCode()
- No requiere parámetros. Devuelve la calve de seguridad Esta funcionalidad debe usarse solo para procesos internos, nunca desplegarse a pantalla o modificar su valor.
- envDir(str)
- Devuelve alguno de los valores de directorios de acuerdo a la opción indicada (cgi, home, temp, htdocs, admcp, usrcp, ltemp). Por defecto devuelve el valor del directorio actual.
- envCgi(opt)
- Si se indica como parámetro el valor de "method" devuelve el método utilizado para llamar al cgi (POST|GET). En caso contrario devuelve el valor del directorio de cgis.
- envGet(str)
- De acuerdo al parámetro indicado (str) el valor de ip (ip) o dominio (fulldomain) o el nombre o privilegios correspondientes al servicio o subservicio actual (servicename, serviceprivileged, subservicename, subserviceprivileged). En caso de ser algún otro valor, busca devolver el valor por defecto o el indicado como parámetro. Nótese que este sigue una lógica diferente a los siguientes tres métodos.
- envDefault(str)
- Devuelve el valor por defecto indicado como parámetro (str).
- envParam(str)
- Devuelve el valor del parámetro indicado (str).
- envCookie(str)
- Devuelve el valor de la cookie indicada (str).
Uso
Requiere de la carga previa de los objetos $db y $usr.