CFile::setFilename PHP Method

setFilename() public method

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