ATTENTION

You're browsing the documentation for an development version of froxlor.
The current stable version's documentation can be found here.

DirOptions

DirOptions.add

add options for a given directory

Permission

admin customer

Parameter

FieldTypeDescription
customeridintoptional, required when called as admin (if $loginname is not specified)
loginnamestringoptional, required when called as admin (if $customerid is not specified)
pathstringpath relative to the customer's home-Directory
options_indexesbooloptional, activate directory-listing for this path, default 0 (false)
options_cgibooloptional, allow Perl/CGI execution, default 0 (false)
error404pathstringoptional, custom 404 error string/file
error403pathstringoptional, custom 403 error string/file
error500pathstringoptional, custom 500 error string/file

Response

string as json-encoded array

DirOptions.get

return a directory-protection entry by id

Permission

admin customer

Parameter

FieldTypeDescription
idintid of dir-protection entry

Response

string as json-encoded array

DirOptions.update

update options for a given directory by id

Permission

admin customer

Parameter

FieldTypeDescription
idintid of dir-protection entry
customeridintoptional, required when called as admin (if $loginname is not specified)
loginnamestringoptional, required when called as admin (if $customerid is not specified)
options_indexesbooloptional, activate directory-listing for this path, default 0 (false)
options_cgibooloptional, allow Perl/CGI execution, default 0 (false)
error404pathstringoptional, custom 404 error string/file
error403pathstringoptional, custom 403 error string/file
error500pathstringoptional, custom 500 error string/file

Response

string as json-encoded array

DirOptions.listing

list all directory-options, if called from an admin, list all directory-options of all customers you are allowed to view, or specify id or loginname for one specific customer

Permission

admin customer

Parameter

FieldTypeDescription
customeridintoptional, admin-only, select directory-protections of a specific customer by id
loginnamestringoptional, admin-only, select directory-protections of a specific customer by loginname
sql_searcharrayoptional array with index = fieldname, and value = array with 'op' => operator (one of <, > or =),LIKE is used if left empty and 'value' => searchvalue
sql_limitintoptional specify number of results to be returned
sql_offsetintoptional specify offset for resultset
sql_orderbyarrayoptional array with index = fieldname and value = ASC|DESC to order the resultset by one or morefields

Response

string as json-encoded array count|list

DirOptions.listingCount

returns the total number of accessible directory options

Permission

admin customer

Parameter

FieldTypeDescription
customeridintoptional, admin-only, select directory-protections of a specific customer by id
loginnamestringoptional, admin-only, select directory-protections of a specific customer by loginname

Response

string as json-encoded response message

DirOptions.delete

delete a directory-options by id

Permission

admin customer

Parameter

FieldTypeDescription
idintid of dir-protection entry

Response

string as json-encoded array