PEAR Manual
Prev |  | Next

# PEAR_ChannelFile::setAlias()

PEAR_ChannelFile::setAlias() -- Set the channel alias

## Synopsis

    require_once '/ChannelFile.php';

``boolean PEAR_ChannelFile::setAlias` (string $alias, boolean [$local = `FALSE`])`

## Description

Set the suggested alias that users can use on the command-line as a shortcut access to this channel. For instance, channel `pear.php.net`'s alias is `pear`.

## Parameter

string `$alias`

  The alias

boolean `$local`

  determines whether the alias is in channel.xml or local. If local, then this is the result of a `pear channel-alias` command.

## Return value

returns success

## Throws

throws no exceptions thrown

## Note

This function can not be called statically.

Prev | Home | Next
PEAR_ChannelFile::resetREST() | Up | PEAR_ChannelFile::setBaseURL()