Phar::setAlias

(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL phar >= 1.2.1)

Phar::setAliasEstablece el alias del archivo Phar

Descripción

public Phar::setAlias(string $alias): true

Nota:

Este método requiere que la opción de php.ini phar.readonly esté establecida a 0 para que trabaje con objetos Phar. De otra manera, se lanzará una excepción de tipo PharException.

Establece el alias del archivo Phar y lo escribe como alias permanente de este archivo phar. Un alias puede ser utilizado dentro de un archivo phar para asegurar que el uso del flujo phar para acceder a ficheros internos funcione siempre independientemente de la ubicación del archivo phar en el sistema de ficheros. Una alternativa consiste en confiar en la intercepción de include realizada por Phar o en utilizar Phar::interceptFileFuncs() y usar rutas relativas.

Parámetros

alias

Una pequeña cadena con la que se referirá a este archivo durante los accesos con el flujo phar.

Valores devueltos

Siempre devuelve true.

Errores/Excepciones

Se lanza una excepción UnexpectedValueException cuando el acceso en escritura está desactivado y se lanza una excepción PharException si el alias ya está en uso o si se ha encontrado un problema al escribir los cambios en el disco.

Historial de cambios

Versión Descripción
8.4.0 Phar::setAlias() ahora tiene un tipo de retorno provisional de tipo true.

Ejemplos

Ejemplo #1 Un ejemplo con Phar::setAlias()

<?php
try {
$phar = new Phar('monphar.phar');
$phar->setAlias('monp.phar');
} catch (
Exception $e) {
// trata los errores
}
?>

Ver también