YetiForce PHP Documentation

Settings_PDF_Module_Model extends Settings_Vtiger_Module_Model
in package

Module Class for PDF Settings.

Tags
copyright

YetiForce Sp. z o.o

license

YetiForce Public License 3.0 (licenses/LicenseEN.txt or yetiforce.com)

author

Maciej Stencel m.stencel@yetiforce.com

author

Mariusz Krzaczkowski m.krzaczkowski@yetiforce.com

Table of Contents

$allFields  : mixed
$baseIndex  : mixed
$baseTable  : mixed
$listFields  : mixed
$module  : mixed
$parent  : mixed
$step1Fields  : mixed
$step2Fields  : mixed
$step3Fields  : mixed
$uploadPath  : mixed
$viewToPicklistValue  : mixed
getCreateRecordUrl()  : mixed
getCreateViewUrl()  : string
Function to get the url for create view of the module.
getDefaultUrl()  : string
Function to get the url for default view of the module.
getFieldsByStep()  : mixed
getImportViewUrl()  : mixed
getPageFormats()  : mixed
getSupportedModules()  : mixed
getTemplatesByModule()  : array<string|int, mixed>
Returns template records by module name.
getTemplateType()  : int
Get template type.

Properties

$allFields

public static mixed $allFields = ['module_name', 'status', 'primary_name', 'secondary_name', 'meta_author', 'meta_keywords', 'metatags_status', 'meta_subject', 'meta_title', 'page_format', 'margin_chkbox', 'margin_top', 'margin_bottom', 'margin_left', 'margin_right', 'header_height', 'footer_height', 'page_orientation', 'language', 'filename', 'visibility', 'default', 'header_content', 'body_content', 'footer_content', 'conditions', 'watermark_type', 'watermark_text', 'watermark_angle', 'template_members', 'watermark_image', 'one_pdf', 'type']

$baseIndex

public mixed $baseIndex = 'pdfid'

$baseTable

public mixed $baseTable = 'a_yf_pdf'

$listFields

public mixed $listFields = ['module_name' => 'Module', 'status' => 'LBL_STATUS', 'primary_name' => 'LBL_PRIMARY_NAME', 'secondary_name' => 'LBL_SECONDARY_NAME', 'meta_author' => 'LBL_META_AUTHOR', 'meta_keywords' => 'LBL_META_KEYWORDS', 'margin_chkbox' => 'LBL_MAIN_MARGIN', 'page_format' => 'LBL_PAGE_FORMAT']

$module

public static mixed $module = 'PDF'

$parent

public static mixed $parent = 'Settings'

$step1Fields

public static mixed $step1Fields = ['status', 'primary_name', 'secondary_name', 'module_name', 'metatags_status', 'meta_subject', 'meta_title', 'meta_author', 'meta_keywords', 'page_format', 'margin_chkbox', 'margin_top', 'margin_bottom', 'margin_left', 'margin_right', 'header_height', 'footer_height', 'page_orientation', 'language', 'filename', 'visibility', 'default', 'one_pdf', 'template_members', 'watermark_type', 'watermark_text', 'watermark_image', 'watermark_angle']

$step2Fields

public static mixed $step2Fields = ['module_name', 'header_content', 'module_name', 'body_content', 'footer_content']

$step3Fields

public static mixed $step3Fields = ['conditions']

$uploadPath

public static mixed $uploadPath = 'storage/Pdf/watermark/'

$viewToPicklistValue

protected mixed $viewToPicklistValue = ['Detail' => 'PLL_DETAILVIEW', 'List' => 'PLL_LISTVIEW']

Methods

getCreateRecordUrl()

public static getCreateRecordUrl() : mixed
Return values
mixed

getCreateViewUrl()

Function to get the url for create view of the module.

public static getCreateViewUrl() : string
Return values
string
  • url

getDefaultUrl()

Function to get the url for default view of the module.

public static getDefaultUrl() : string
Return values
string
  • url

getFieldsByStep()

public static getFieldsByStep([mixed $step = 1 ]) : mixed
Parameters
$step : mixed = 1
Return values
mixed

getImportViewUrl()

public static getImportViewUrl() : mixed
Return values
mixed

getPageFormats()

public static getPageFormats() : mixed
Return values
mixed

getSupportedModules()

public static getSupportedModules() : mixed
Return values
mixed

getTemplatesByModule()

Returns template records by module name.

public getTemplatesByModule(string $moduleName) : array<string|int, mixed>
Parameters
$moduleName : string
  • module name for which template was created
Return values
array<string|int, mixed>

of template record models

getTemplateType()

Get template type.

public static getTemplateType(Vtiger_PDF_Model $template) : int
Parameters
$template : Vtiger_PDF_Model
Return values
int

template type

Search results