HOWTO · PHP
Encontrar la ruta del directorio raíz en PHP
Este tutorial presenta cómo encontrar la ruta del directorio raíz del proyecto PHP
En esta página
Una aplicación PHP puede tener varias rutas a las que se llama «raíz». La raíz del proyecto es el directorio que la aplicación considera su base; el directorio del archivo actual es donde se encuentra un script PHP; y la raíz documental web es el directorio que el servidor web expone para una solicitud. Estas rutas pueden ser distintas. Elija el valor que corresponda a los archivos que necesita localizar, en lugar de suponer que una expresión siempre devuelve la raíz del proyecto.
Para los ejemplos, imagine que el proyecto está en /var/www/html/project, que index.php se encuentra en el nivel superior y que login.php está en master/. La raíz documental ilustrativa del servidor es /var/www/html. Son rutas de ejemplo, no valores medidos en su servidor.
Distinga la raíz del proyecto de la raíz documental web
La raíz del proyecto es una convención de la aplicación, no una configuración de PHP. Puede contener código de la aplicación, archivos de configuración y otros archivos. El servidor configura la raíz documental web, que determina desde dónde se sirven los archivos públicos. En este ejemplo, el proyecto está dentro de la raíz documental, pero en un despliegue puede ubicarse en otro lugar o puede configurarse un subdirectorio público como raíz documental.
Tenga presente la diferencia: __DIR__ y dirname() derivan rutas de la ubicación de un archivo PHP, mientras que $_SERVER['DOCUMENT_ROOT'] indica una configuración del servidor para la solicitud actual. Ninguno de estos valores detecta automáticamente una raíz específica de la aplicación.
Obtenga el directorio del archivo actual con __DIR__
La constante mágica __DIR__ es la ruta absoluta al directorio que contiene el archivo donde aparece. Por tanto, en master/login.php representa /var/www/html/project/master, no /var/www/html/project. Se resuelve a partir de la ubicación del script, así que incluirlo desde otro directorio de trabajo no cambia su valor. Úsela para construir rutas a archivos que estén junto al script o dentro de sus subdirectorios; cuando sea necesario, añada una ruta relativa usando el separador de rutas de PHP.
Ejecute este ejemplo independiente. En la ejecución suministrada, el archivo PHP se guardó en /work, por lo que ambas expresiones se resolvieron en ese directorio. Las etiquetas visibles y la salida del ejemplo permanecen en inglés:
<?php
echo "Current file directory: ", __DIR__, PHP_EOL;
echo "Directory from __FILE__: ", dirname(__FILE__), PHP_EOL;
?>
Current file directory: /work
Directory from __FILE__: /work
__FILE__ es la ruta completa del archivo actual, y dirname(__FILE__) devuelve el directorio que lo contiene. Por eso, esta última expresión es una alternativa útil al trabajar con código PHP antiguo, mientras que __DIR__ expresa la intención de forma más directa.
Busque un directorio antecesor con dirname()
Use dirname() para pasar de una ruta de archivo conocida a su directorio padre. Si parte de __FILE__ en master/login.php, una llamada devuelve el directorio master; al aplicarla otra vez, devuelve el directorio del proyecto. En el árbol de ejemplo, los resultados son /var/www/html/project/master y /var/www/html/project, respectivamente. Las llamadas anidadas muestran cada paso de forma explícita y evitan depender del argumento opcional levels, cuya disponibilidad depende de la versión de PHP.
La operación sube por los componentes de la ruta; no busca una carpeta por nombre ni baja a un subdirectorio. Si cambia la estructura del proyecto, también podría ser necesario cambiar el número de pasos hacia arriba. Mantenga esa relación cerca del código o defina una ruta base específica del proyecto en la configuración cuando la necesiten muchos archivos.
Lea la raíz documental del servidor web con $_SERVER['DOCUMENT_ROOT']
Durante una solicitud web, $_SERVER['DOCUMENT_ROOT'] contiene la raíz documental configurada para ese servidor. En la configuración ilustrativa es /var/www/html, mientras que la raíz del proyecto es /var/www/html/project. Use este valor cuando necesite específicamente la raíz web pública del servidor, por ejemplo, para construir una ruta relativa a ese directorio configurado. No lo use como sinónimo de la raíz del proyecto.
Esta variable del servidor depende del entorno de la solicitud y de la configuración del servidor. Puede no estar disponible o no ser adecuada en scripts de línea de comandos, y su valor puede variar entre despliegues. Compruebe que esté disponible en el código que podría ejecutarse fuera de una solicitud web; si la ruta deseada pertenece al proyecto y no al directorio público del servidor, use __DIR__ o una ruta base configurada para la aplicación.
En resumen, use __DIR__ para obtener el directorio que contiene el archivo PHP actual, use llamadas anidadas a dirname() para llegar a un antecesor conocido, como el directorio del proyecto, y consulte $_SERVER['DOCUMENT_ROOT'] solo cuando necesite la raíz documental configurada por el servidor web. Considere las rutas de ejemplo como ilustrativas y compruebe la configuración específica del despliegue en el entorno donde se ejecute el script.