\ProfileDocuments
DOCx profile documents base class
Synopsis
class ProfileDocuments
{
- // constants
- const TEMPLATES_PATH = 'content/documents/pl_docx/';
- const DOCUMENTS_PATH = 'content/documents/pl_cache/';
- // members
- protected array $templates = ;
- protected string $userLogin = '';
- protected array $userData = ;
- protected array $userAgentData = ;
- protected array $customFields = ;
- protected array $altcfg = ;
- protected array $userDocuments = ;
- protected array $allUserDocuments = ;
- // methods
- public void __construct()
- protected void loadTemplates()
- public void setLogin()
- public string getLogin()
- public array getUserData()
- protected void loadUserAgentData()
- public array getUserAgentData()
- protected int getDocumentLastId()
- protected string transformDateLit()
- protected array getContractDatesAll()
- public void loadAllUserData()
- public array getTemplates()
- protected string renderTemplateEditForm()
- public void saveTemplate()
- public string renderTemplatesList()
- public string uploadForm()
- protected void registerTemplateDB()
- protected void unregisterTemplateDB()
- public void deleteTemplate()
- public boolean doUpload()
- public string customDocumentFieldsForm()
- public void setCustomFields()
- public array getCustomFields()
- public void registerDocument()
- protected void deleteDocument()
- public void unregisterDocument()
- public void loadUserDocuments()
- public void loadAllUsersDocuments()
- public array getAllUsersDocuments()
- protected string renderDocumentEditForm()
- public void saveDocumentVisibility()
- public string renderUserDocuments()
- public string renderAllUserDocuments()
- public string renderAllUserDocumentsCalendar()
- public string dateControl()
Constants
Name | Value |
---|---|
TEMPLATES_PATH | 'content/documents/pl_docx/' |
DOCUMENTS_PATH | 'content/documents/pl_cache/' |
Members
protected
- $allUserDocuments
—
array
Contains all users documents array as id=>data - $altcfg
—
array
Contains system alter config as key=>value - $customFields
—
array
Contains some custom fields data - $templates
—
array
Contains available document templates as id=>data - $userAgentData
—
array
Conteins associated agents data for current user as key=>value - $userData
—
array
Contains available users data - $userDocuments
—
array
Contains user documents as id=>data - $userLogin
—
string
Contains current instance user login
Methods
protected
- deleteDocument() — Deletes specified document from filesystem documents storage
- getContractDatesAll() — Returns contract dates data
- getDocumentLastId() — returns last generated ID from documents registry
- loadTemplates() — load templates into private prop
- loadUserAgentData() — Loads current user assigned agent data into private property
- registerTemplateDB() — register uploaded template into database
- renderDocumentEditForm() — Renders document edit form, which allows to change document public visibility
- renderTemplateEditForm() — Renders existing document template edit form
- transformDateLit() — Transforms and localizes date
- unregisterTemplateDB() — unregister existing document template
public
- __construct()
- customDocumentFieldsForm() — returns custom documents form fields
- dateControl() — show calendar contol form
- deleteTemplate() — deletes existing template
- doUpload() — do the docx template upload subroutine
- getAllUsersDocuments() — gets all user generated documents from database by this year
- getCustomFields() — receives custom fields from object
- getLogin() — gets current user login
- getTemplates() — Returns available document templates prop
- getUserAgentData() — Returns current user assigned agent data
- getUserData() — gets user data by previously setted login
- loadAllUserData() — loads user data for template processing
- loadAllUsersDocuments() — loads all user generated documents from database
- loadUserDocuments() — loads user documents from database
- registerDocument() — register generated document in database
- renderAllUserDocuments() — Renders previously generated all users documents
- renderAllUserDocumentsCalendar() — Renders previously generated all users as fullcalendar widget
- renderTemplatesList() — returns available templates list with some controls
- renderUserDocuments() — Renders previously generated user documents
- saveDocumentVisibility() — Saves document visibility if this required
- saveTemplate() — Saves changes to existing document template
- setCustomFields() — sets some custom template fields from post request
- setLogin() — Sets user login
- unregisterDocument() — kills document in database
- uploadForm() — returns template upload form