ThemeFileInfo

Class ThemeFileInfo

This class represents a theme file. It includes the real path, the virtual path, and the category.

Virtual paths are a special notation for relative paths, including a prefix to give context. Eg.: the path "image::theme::files/logo.png" is relative to the theme folder, while "image::generalfiles::" is relative to the general files folder. If $path is not valid, returns null. Paths can be

  • related to a global theme option and hence the file be located on the generalfiles directory.
  • related to a survey theme option and hence the file be located relative to a survey upload directory.
  • related to a theme and hence the file be located on the theme directory (eg. when uploaded from theme editor)
package

LimeSurvey\DataValueObject

Methods

__construct

__construct(string $realPath,string $virtualPath,\LimeSurvey\Datavalueobjects\ThemeFileCategory $category)

Arguments

$realPath

string

$virtualPath

string

Properties

the real path to the file (eg. '/var/www/html/limesurvey/themes/survey/vanilla/files/logo.png')

realPath :string
var

the real path to the file (eg. '/var/www/html/limesurvey/themes/survey/vanilla/files/logo.png')

Type(s)

string

the virtual path to the file (eg. 'image::theme::logo.png')

virtualPath :string
var

the virtual path to the file (eg. 'image::theme::logo.png')

Type(s)

string

category

category :\LimeSurvey\Datavalueobjects\ThemeFileCategory