cPanel API 1 Functions - Fileman::dofileop - Knowledgebase

Description

This function moves or copies a file to a different directory.

Warning:

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

UAPI (recommended) — None.
cPanel API 2 — Fileman::fileop — This function performs an operation on one or more files.

Examples

LiveAPI PHP Class

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

$move_file = $cpanel->api1('Fileman', 'dofileop', array('public_html', 'myfile.txt', 'user2', 'move')); // Call the function.

LiveAPI Perl Module

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

my $move_file = $cpliveapi->api1('Fileman', 'dofileop' ['public_html', 'myfile.txt', 'user2', 'move']); # 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::dofileop ( $FORM('opdir','opfile','dir','fileop'))">

Command Line

cpapi1 --user=username opdir=public_html opfile-myfile.txt dir=user2 fileop=move

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.
We introduced this functionality in cPanel & WHM version 56.

Output (none)

This functions does not return any output.

Parameters

Parameter	Type	Description	Possible values	Example
opdir	string	The file's directory. This parameter defaults to the cPanel account's /home directory.	Any valid directory, relative to the account's /home directory.	public_html
opfile	string	Required The file to move or copy.	Any valid filename.	myfile.txt
dir	string	Required The file's new location.	Any valid directory.	user2
fileop	string	Required The operation to perform.	copy move	move

Returns

This function does not return output.

Knowledgebase

Categories

Categories