Child pages
  • cPanel API 1 Functions - Fileman::fmsavefile

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

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


Warning
titleWarning:

Include Page
LIB:_cPanelAPI1NewerFunctions
LIB:_cPanelAPI1NewerFunctions

  • UAPI (recommended) Fileman::save_file_content
    Excerpt Include
    DD:UAPI Functions - Fileman::save_file_contentDD:
    UAPI Functions - Fileman::save_file_content
    nopaneltrue
  • cPanel API 2 Fileman::savefile
    Excerpt Include
    DD:cPanel API 2 Functions - Fileman::savefileDD:
    cPanel API 2 Functions - Fileman::savefile
    nopaneltrue

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledFileStorageRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$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.

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
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.

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelTagsWarning
LIB:_cPanelTagsWarning

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



Expand
titleCommand Line


Code Block
cpapi1 --user=username Fileman fmsavefile user myfile.txt "This is the new string" 1 1

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote


Expand
titleOutput (none)

This function does not return output.



Parameters

ParameterTypeDescriptionPossible valuesExample
dirstring

Required

The file's directory.

Any valid directory, relative to the account's /home directory.user
filestring

Required

The file to modify.

Any valid filename.myfile.txt
pagestring

Required

The new string to save.

Any string.This is the new string.
doubledecodeBoolean

Required

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

  • 0 — Do not decode.
  • 1 — Decode.
0
stripnewlineBoolean

Required

Whether to strip new lines in the file.

  • 0 — Do not strip.
  • 1 — Strip.
1

Returns

This function does not return output.