Document
class Document extends DocumentItem
Class XELOS\Modules\SystemDMS\CF\xcf_system_dms_document
Properties
SystemDMSController | $mod | ||
protected string | $model_name | from DocumentItem |
Methods
Returns true if this cf type allows copying documents to different instances.
Returns TRUE if the current user may create new documents
Copies a given document to another instance
Creates a new xelos_document_model
Returns an i18n string describing the document type for which this content first library was created. The description should consist of approximately 30 words.
Returns a view for editing the document before it is finally created.
Returns the "location" a document is located at in its home instance.
Returns a fdl array containing specification on how to setup a location form element.
Returns a specific view for the given document
Returns an array of name=>title pairs of all views that are available for the current document.
Returns true if this cf type has the technical means of being copied to another instance.
Details
in
DocumentItem at line 164
bool
can_copy_to_another_instance()
Returns true if this cf type allows copying documents to different instances.
This does not reflect the technical means, but if the current user is allowed to perform the action
at line 30
bool
can_create_new()
Returns TRUE if the current user may create new documents
at line 261
protected DocumentModel
create_copy_document_in_instance(DocumentModel $document, string $instance_id, int $global_group_security_id = 0, $location = false)
Copies a given document to another instance
at line 53
DocumentModel
create_new(string $name)
Creates a new xelos_document_model
at line 243
CommentsController
get_comments_instance(DocumentModel $document)
Returns the comments instance for a given document
in
DocumentItem at line 23
string
get_description()
Returns an i18n string describing the document type for which this content first library was created. The description should consist of approximately 30 words.
at line 225
mixed
get_draft_view(DocumentModel $document)
Returns a view for editing the document before it is finally created.
Often it is the edit view provided by xelos_document_cf::get_view()
at line 39
string
get_icon_class(DocumentModel $document = false)
No description
in
DocumentItem at line 92
string
get_location(DocumentModel $document)
Returns the "location" a document is located at in its home instance.
This could be the category, the contact type or something else, depending on the document type in question. It may be implemented as it seams convinient.
in
DocumentItem at line 105
mixed
get_location_form_element(DocumentModel $document = null)
Returns a fdl array containing specification on how to setup a location form element.
If an implementation returns something other than false, the "create_new" form will be equipped with an element created by using the returned fdl specification. The element will ALWAYS be optional
at line 170
UIAjaxComponent
get_view(string $view_name, DocumentModel $document, bool $readonly = false)
Returns a specific view for the given document
at line 122
array
get_views(DocumentModel $document)
Returns an array of name=>title pairs of all views that are available for the current document.
Use realtime evaluation of the document only if necessary!
in
DocumentItem at line 173
bool
supports_copy_to_another_instance()
Returns true if this cf type has the technical means of being copied to another instance.