Child pages
  • cPanel API 1 Functions - Fileman::savehtmlfile
Skip to end of metadata
Go to start of metadata

Description

This function saves a string's contents to an HTML file.

Warning:

cPanel API 1 is deprecated. We strongly recommend that you do not use cPanel API 1. However, no equivalent function exists in our newer APIs.


Examples


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$save_file = $cpanel->api1('Fileman', 'savehtmlfile', array('public_html', 'myfile.html', '<p>This is the new string</p>', '1', '1')); // Call the function.


Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $save_file = $cpliveapi->api1('Fileman', 'savehtmlfile' ['public_html', 'myfile.txt', '<p>This is the new string</p>', '1', '1']); # Call the function.


Note:

For more information, read our Guide to the LiveAPI System.

 cPanel Tag System (deprecated)


Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Fileman::savehtmlfile ( $FORM('dir','file','page','skipfile','doublecode'))">
 Command Line
cpapi1 --user=username fileman savehtmlfile public_html myfile.txt "<p>This is the new string</p>" 1 1


Notes:

  • You must URI-encode these values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 1 documentation or run the cpapi1 --help command. 

 Output (none)

This function does not return output.

Parameters

ParameterTypeDescriptionPossible valuesExample
dirstring

Required

The directory in which to store the file.

Any valid directory that is relative to the account's /home directory.public_html
filestring

Required

The file.

Any valid filename.myfile.html
pagestring

Required

The HTML code to save to the file.

Any single string.<p>This is a new string</p>.
skipfilesBoolean

Required

Whether to open the directory before the function saves the file.

  • 0 — Open the directory.
  • 1 — Do not open the directory.
1
doubledecode Boolean

Required

Whether to decode the URL values in the directory and file.

  • 0 — Do not decode the URL values.
  • 1 — Decode the URL values.
1

Returns

This function does not return output.