include/Sugarpdf/sugarpdf_config.php

Show:

inherited

Constants
Functions
- defineFromConfig
- defineFromUserPreference

Table of Contents

Constants

 
                K_PATH_MAIN
                = $sugarpdf_default["K_PATH_MAIN"]

 
                K_PATH_URL
                = $sugarpdf_default["K_PATH_URL"]

URL path to tcpdf installation folder

 
                K_PATH_CUSTOM_FONTS
                = $sugarpdf_default["K_PATH_CUSTOM_FONTS"]

custom path for PDF fonts (Use for non core added fonts)

 
                K_PATH_FONTS
                = $sugarpdf_default["K_PATH_FONTS"]

path for PDF fonts

 
                K_PATH_CACHE
                = $sugarpdf_default["K_PATH_CACHE"]

cache directory for temporary files (full path)

 
                K_PATH_URL_CACHE
                = $sugarpdf_default["K_PATH_URL_CACHE"]

cache directory for temporary files (url path)

 
                K_PATH_CUSTOM_IMAGES
                = $sugarpdf_default["K_PATH_CUSTOM_IMAGES"]

 
                K_PATH_IMAGES
                = $sugarpdf_default["K_PATH_IMAGES"]

 
                K_BLANK_IMAGE
                = $sugarpdf_default["K_BLANK_IMAGE"]

 
                PDF_PAGE_FORMAT_LIST
                = $sugarpdf_default["PDF_PAGE_FORMAT_LIST"]

 
                PDF_PAGE_ORIENTATION_LIST
                = $sugarpdf_default["PDF_PAGE_ORIENTATION_LIST"]

 
                PDF_ENCODING_TABLE_LIST
                = $sugarpdf_default["PDF_ENCODING_TABLE_LIST"]

Available encoding tables when adding a new font

 
                PDF_ENCODING_TABLE_LABEL_LIST
                = $sugarpdf_default["PDF_ENCODING_TABLE_LABEL_LIST"]

Available encoding tables when adding a new font (Label)

 
                K_TCPDF_EXTERNAL_CONFIG
                = true

Functions

defineFromConfig(
          \$value $value, \$default $default
          )
        
        :
          void

Function to define a sugarpdf seeting from the admin application settings (config table).

This function use the default value if there is nothing in the table.

Parameters

Name	Type	Description
$value	\$value	settings to search
$default	\$default	default value

defineFromUserPreference(
          \$value $value, \$default $default
          )
        
        :
          void

This function define a Sugarpdf setting from the user preferences.

This function use the default value if there is no preference. If SUGARPDF_USE_DEFAULT_SETTINGS is define the function will always use the default value. SUGARPDF_USE_FOCUS is use to load the preference of the none current user. To use this constant you have to define a global variable $focus_user.

Parameters

Name	Type	Description
$value	\$value	settings to search
$default	\$default	default value