Adding New Resource Types

This website contains links to software which is either no longer maintained or will be supported only until the end of 2019 (CKFinder 2). For the latest documentation about current CKSource projects, including software like CKEditor 4/CKEditor 5, CKFinder 3, Cloud Services, Letters, Accessibility Checker, please visit the new documentation website.

If you look for an information about very old versions of CKEditor, FCKeditor and CKFinder check also the CKEditor forum, which was closed in 2015. If not, please head to StackOverflow for support.

(Created page with 'To create a new resource type you should place the section below in your config.php file. Note that the options you can use are discribed in the [[CKFinder_2.x/Developers Guide/P…')
 
(Article contents proof-read and formatted, some replaced with a template)
 
Line 1: Line 1:
To create a new resource type you should place the section below in your config.php file. Note that the options you can use are discribed in the [[CKFinder_2.x/Developers Guide/PHP/Configuration/Resource Types/Built-in|Built-in resource types]] section.
+
{{Ckfinder_2.x_New_Resource_Types_Description|file=<code>config.php</code>|link=CKFinder_2.x/Developers Guide/PHP/Configuration/Resource Types/Built-in}}
  
Example: You want to create a resource type MSdocs which will only have files with the doc,ppt,xls extensions and be maximum 2 megabites large.
+
<source lang="php">
<source lang="php">$config['ResourceType'][] = Array(
+
$config['ResourceType'][] = Array(
 
'name' => 'MSdocs',
 
'name' => 'MSdocs',
 
'url' => $baseUrl . 'MSdocs',
 
'url' => $baseUrl . 'MSdocs',
Line 8: Line 8:
 
'maxSize' => 2M,
 
'maxSize' => 2M,
 
'allowedExtensions' => 'doc,ppt,xls,',
 
'allowedExtensions' => 'doc,ppt,xls,',
'deniedExtensions' => '');</source>  
+
'deniedExtensions' => '');
When loading CKFinder, the "type" querystring parameter can be used to display a specific type only. If "type" is omitted in the URL, the "DefaultResourceTypes" settings is used (may contain the resource type names separated by a comma). <br>If left empty, all types are loaded. If you want to limit the CKFinder to use only MSdocs resource type'','' use the following code'':''
+
</source>
<pre>$config['DefaultResourceTypes'] = 'MSdocs';</pre>  
+
 
{{#CUSTOMTITLE:Adding new resource types}}
+
{{Ckfinder_2.x_New_Resource_Types_Default|DefaultResourceTypes=DefaultResourceTypes}}
 +
 
 +
<source lang="php">$config['DefaultResourceTypes'] = 'MSdocs';</source>

Latest revision as of 07:07, 31 March 2011

When you want to create a new resource type, you should place the section below in your config.php file. Note that the options you can use are described in the Handling Built-in Resource Types section.

Example: Suppose you want to create a new resource type named MSdocs, which will only be used for files with the .doc, .ppt, and .xls extensions and the maximum size of 2 megabytes. Add the following code to your configuration file.

$config['ResourceType'][] = Array(
'name' => 'MSdocs',
'url' => $baseUrl . 'MSdocs',
'directory' => $baseDir . 'MSdocs',
'maxSize' => 2M,
'allowedExtensions' => 'doc,ppt,xls,',
'deniedExtensions' => '');

When loading CKFinder, the type querystring parameter can be used to display a specific type only. If type is omitted in the URL, the DefaultResourceTypes setting is used (it may contain the resource type names separated by a comma).

If the DefaultResourceTypes setting is left empty, all types — including the newly defined ones — are loaded. When you want to limit CKFinder to only use the newly defined MSdocs resource type, use the following code:

$config['DefaultResourceTypes'] = 'MSdocs';
This page was last edited on 31 March 2011, at 07:07.