CFile::setBasename PHP Method

setBasename() public method

Lazy wrapper for {@link rename}. This method works only for files.
public setBasename ( null | string $basename = null ) : boolean | CFile
$basename null | string New file basename (e.g.: 'mynewfile.txt')
return boolean | CFile Current CFile object on success, 'False' on fail.
    public function setBasename($basename = null)
    {
        if ($this->getIsFile()) {
            if ($this->getIsUploaded()) {
                $this->addLog('setBasename() is unavailable for uploaded files. Please copy/move uploaded file from temporary directory', 'warning');
                return False;
            }
            if ($this->getWriteable() && $basename && $this->rename($basename)) {
                return $this;
            }
            $this->addLog('Unable to set file basename "' . $basename . '"');
            return False;
        }
        $this->addLog('setBasename() is available only for files', 'warning');
        return False;
    }