CKFinder 2.x/Developers Guide/PHP/Configuration/Quick Start - Revision history

Anna: Article content moved to a template

2011-03-31T12:20:15Z

Article content moved to a template

Anna: Code formatting added

2011-03-31T10:47:04Z

Code formatting added

Anna: Sessions note template changed

2011-03-31T10:42:04Z

Sessions note template changed

Wiktor: Created page with '== The CheckAuthentication() function
== By default, CKFinder will not work due to authentication restrictions. You must first be sure that you have configured it properly, …'

2010-05-14T19:35:29Z

Created page with '== The CheckAuthentication() function<br> == By default, CKFinder will not work due to authentication restrictions. You must first be sure that you have configured it properly, …'

New page

== The CheckAuthentication() function<br> ==

By default, CKFinder will not work due to authentication restrictions. You must first be sure that you have configured it properly, and then enable it.

Once you have completely configured CKFinder, you are ready to enable it for use. The CheckAuthentication() function is used for that. In this function, you must implement the code that ensures that the requests are coming from an authenticated user. This is usually done by assigning a session variable when the user logs on your system.

Return "true" if the user is properly authenticated. We strongly recommend you to NOT simply return "true" from this function without implementing authentication checks. Anonymous users would be able to use CKFinder, including uploading and deleting files from your server.

The following is a sample implementation for it:
<source>function CheckAuthentication()
{
return isset($_SESSION['IsAuthorized']) && $_SESSION['IsAuthorized'];
}
</source>

{{CKFinder_2.x Sessions|lang=PHP}}
=== License ===

If you purchased CKFinder you should put your license key in the config.php file:
<source lang="php">$config['LicenseName'] = 'put your license name here';
$config['LicenseKey'] = 'put your license key here';</source>
If you leave this fields blank CKFinder will be fully functional but it will be ruining in demo mode.

=== baseUrl ===

The '''$baseUrl''' is the base path used to build the final URL for the resources handled in CKFinder. Examples:
<source lang="php">$baseUrl = 'http://example.com/ckfinder/files/';
$baseUrl = '/userfiles/';</source>
If you leave this field empty the default value (/userfiles/) will be used. Notice that the trailing slash is required.

=== baseDir ===

The '''$baseDir''' is the path to the local directory (in the server) which points to the above $baseUrl URL. This is the path used by CKFinder to handle the files in the server. Full write permissions must be granted to this directory. Examples:

You may point it to a directory directly:
<source lang="php">$baseDir = '/home/login/public_html/ckfinder/files/';
$baseDir = 'C:/SiteDir/CKFinder/userfiles/';</source>
Or you may let CKFinder discover the path, based on $baseUrl:
<pre>$baseDir = resolveUrl($baseUrl);</pre>
Remember that CKFinder will only discover the path when the base url is a local web path ( relative to document root ).<br>Example:
<pre>$baseUrl = '/userfiles/'</pre>
If it is a full URL address.<br>Example:
<pre>$baseUrl = 'http://example.com/ckfinder/files/'</pre>
the path won't be discovered. Notice that the trailing slash is required.

@@ Line 1: / Line 1: @@
-== The CheckAuthentication() function<br> ==
+{{CKFinder_2.x_CheckAuthentication}}
 <source lang="php">function CheckAuthentication()
+{
@@ Line 16: / Line 9: @@
 {{CKFinder_2.x Sessions note|lang=PHP}}
-=== License ===
+{{CKFinder_2.x License|file=<code>config.php</code>|code=
 <source lang="php">$config['LicenseName'] = 'put your license name here';
-$config['LicenseKey'] = 'put your license key here';</source>
+$config['LicenseKey'] = 'put your license key here';</source>}}
-=== baseUrl ===
+{{CKFinder_2.x baseUrl|baseUrl=$baseUrl|code=
 <source lang="php">$baseUrl = 'http://example.com/ckfinder/files/';
-$baseUrl = '/userfiles/';</source>
+$baseUrl = '/userfiles/';</source>}}
-You may point it to a directory directly:
+{{CKFinder_2.x baseDir|baseUrl=$baseUrl|baseDir=$baseDir|code1=
 <source lang="php">$baseDir = '/home/login/public_html/ckfinder/files/';
-$baseDir = 'C:/SiteDir/CKFinder/userfiles/';</source>
+$baseDir = 'C:/SiteDir/CKFinder/userfiles/';</source>|code2=
-Or you may let CKFinder discover the path, based on $baseUrl:
+<source lang="php">$baseDir = resolveUrl($baseUrl);</source>|code3=
-<source lang="php">$baseDir = resolveUrl($baseUrl);</source>
+<source lang="php">$baseUrl = '/userfiles/'</source>|code4=
-Remember that CKFinder will only discover the path when the base url is a local web path ( relative to document root ).<br>Example:
+<source lang="php">$baseUrl = 'http://example.com/ckfinder/files/'</source>}}

@@ Line 8: / Line 8: @@
 The following is a sample implementation for it:
-<source>function CheckAuthentication()
+<source lang="php">function CheckAuthentication()
+{
 	return isset($_SESSION['IsAuthorized']) && $_SESSION['IsAuthorized'];
@@ Line 38: / Line 38: @@
 $baseDir = 'C:/SiteDir/CKFinder/userfiles/';</source>
 Or you may let CKFinder discover the path, based on $baseUrl:
-<pre>$baseDir = resolveUrl($baseUrl);</pre>
+<source lang="php">$baseDir = resolveUrl($baseUrl);</source>
 Remember that CKFinder will only discover the path when the base url is a local web path ( relative to document root ).<br>Example:
-<pre>$baseUrl = '/userfiles/'</pre>
+<source lang="php">$baseUrl = '/userfiles/'</source>
 If it is a full URL address.<br>Example:
-<pre>$baseUrl = 'http://example.com/ckfinder/files/'</pre>
+<source lang="php">$baseUrl = 'http://example.com/ckfinder/files/'</source>
 the path won't be discovered. Notice that the trailing slash is required.

CKFinder 2.x/Developers Guide/PHP/Configuration/Quick Start - Revision history

Anna: Article content moved to a template

Anna: Code formatting added

Anna: Sessions note template changed

Wiktor: Created page with '== The CheckAuthentication() function == By default, CKFinder will not work due to authentication restrictions. You must first be sure that you have configured it properly, …'

Wiktor: Created page with '== The CheckAuthentication() function
== By default, CKFinder will not work due to authentication restrictions. You must first be sure that you have configured it properly, …'