API15:JFile/write

This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Description

Write contents to a file

Syntax

write($file, $buffer)

Parameter Name	Default Value	Description
$file		$file The full file path
$buffer		$buffer The buffer to write

Returns

boolean True on success

Defined in

libraries/joomla/filesystem/file.php

Importing

jimport( 'joomla.filesystem.file' );

Source Body

function write($file, $buffer)
{
        // Initialize variables
        jimport('joomla.client.helper');
        $FTPOptions = JClientHelper::getCredentials('ftp');
 
        // If the destination directory doesn't exist we need to create it
        if (!file_exists(dirname($file))) {
                jimport('joomla.filesystem.folder');
                JFolder::create(dirname($file));
        }
 
        if ($FTPOptions['enabled'] == 1) {
                // Connect the FTP client
                jimport('joomla.client.ftp');
                $ftp = & JFTP::getInstance($FTPOptions['host'], $FTPOptions['port'], null, $FTPOptions['user'], $FTPOptions['pass']);
 
                // Translate path for the FTP account and use FTP write buffer to file
                $file = JPath::clean(str_replace(JPATH_ROOT, $FTPOptions['root'], $file), '/');
                $ret = $ftp->write($file, $buffer);
        } else {
                $file = JPath::clean($file);
                $ret = file_put_contents($file, $buffer);
        }
        return $ret;
}

Examples

<CodeExamplesForm />