cPanel API 1 Functions - Fileman::fmsavefile - Knowledgebase

Description

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

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

UAPI (recommended) — Fileman::save_file_content — This function saves a file in a directory and encodes it in a character set.
cPanel API 2 — Fileman::savefile — This function saves a string to a file.

Examples

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

$save_string = $cpanel->api1('Fileman', 'fmsavefile', array('user', 'myfile.txt', 'This is the new string', '1', '1')); // Call the function.

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

my $save_string = $cpliveapi->api1('Fileman', 'fmsavefile' ['user', 'myfile.txt', 'This is the new string', '1', '1']); # Call the function.

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. This example is present in order to help developers move from the old cPanel tag system to our LiveAPI.

We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Fileman::fmsavefile ( $FORM('dir','file','page','doublecode','stripnewline'))">

Command Line

cpapi1 --user=username Fileman fmsavefile dir=user file=myfile.txt page="This is the new string" doublecode=1 stripnewline=1

Notes:

You must URI-encode these values.
username represents your account-level username.

Output (none)

This function does not return output.

Parameters

Parameter	Type	Description	Possible values	Example
dir	string	Required The file's directory.	Any valid directory, relative to the account's /home directory.	user
file	string	Required The file to modify.	Any valid filename.	myfile.txt
page	string	Required The new string to save.	Any string.	This is the new string.
doubledecode	Boolean	Required Whether to decode the URL values in the specified directory and file.	0 — Do not decode. 1 — Decode.	0
stripnewline	Boolean	Required Whether to strip new lines in the file.	0 — Do not strip. 1 — Strip.	1

Returns

This function does not return output.

Knowledgebase

Categories

Categories