CKFinder Class Reference

Inheritance diagram for CKFinder:

Public Member Functions
	__construct ($config)
	handleOptionsRequest (RequestEvent $event)
	getBackendFactory ()
	getAcl ()
	getWorkingFolder ()
	debug ($message, array $context=[])
	registerPlugin (PluginInterface $plugin)
	getPlugins ()
	getPlugin ($name)
	boot (Request $request)
	getResizedImageRepository ()
	getConnectorUrl ($full=true)

Public Attributes
const	VERSION = '3.5.3'
const	COMMANDS_NAMESPACE = 'CKSource\\CKFinder\\Command\\'
const	PLUGINS_NAMESPACE = 'CKSource\\CKFinder\\Plugin\\'
const	CHARS = '123456789ABCDEFGHJKLMNPQRSTUVWXYZ'

Protected Member Functions
	getExtraHeaders ()
	registerPlugins ()
	checkRequirements ()

Protected Attributes
	$plugins = []
	$booted = false

Detailed Description

The main CKFinder class.

It is based on Pimple so it also serves as a dependency injection container.

Constructor & Destructor Documentation

__construct()

__construct

(

$config

)

Constructor.

Parameters

array | string

$config

an array containing configuration options or a path to the configuration file

See also

config.php

Member Function Documentation

boot()

boot

(

Request

$request

)

Prepares application environment before the Request is dispatched.

Exceptions

CKFinderException
InvalidPluginException

checkRequirements()

checkRequirements ( )

protected

Checks PHP requirements.

Exceptions

CKFinderException

debug()

debug	(		$message,
		array	$context = []
	)

Shorthand for debugging using the defined logger.

Parameters

string

$message

getAcl()

getAcl

(

)

Returns the ACL service.

getBackendFactory()

getBackendFactory

(

)

Returns the BackedFactory service.

getConnectorUrl()

getConnectorUrl

(

$full = true

)

Returns the connector URL based on the current request.

Parameters

bool | true

$full

if set to true, the returned URL contains the scheme and host

getExtraHeaders()

getExtraHeaders ( )

protected

Returns an array of extra headers defined in the headers configuration option.

Returns

array an array of headers

getPlugin()

getPlugin

(

$name

)

Returns a plugin by the name.

Parameters

string

$name

plugin name

getPlugins()

getPlugins

(

)

Returns an array containing all registered plugins.

Returns

array array of PluginInterface-s

getResizedImageRepository()

getResizedImageRepository

(

)

Returns the resized image repository.

getWorkingFolder()

getWorkingFolder

(

)

Returns the current WorkingFolder object.

handleOptionsRequest()

handleOptionsRequest

(

RequestEvent

$event

)

A handler for the OPTIONS HTTP method.

If the request HTTP method is OPTIONS, it returns an empty response with extra headers defined in the configuration. This handler is executed very early, so if required, the response is set even before the controller for the current request is resolved.

registerPlugin()

registerPlugin

(

PluginInterface

$plugin

)

Registers the plugin.

registerPlugins()

registerPlugins ( )

protected

Registers plugins defined in the configuration file.

Exceptions

LogicException in case the plugin was not found or is invalid

---

The documentation for this class was generated from the following file:

• CKFinder.php