Updated Snippets.

dennykorsukewitz · Jul 14, 2023 · 1ab3e83 · 1ab3e83
1 parent 7131985
commit 1ab3e83
Show file tree

Hide file tree

Showing 92 changed files with 463 additions and 375 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,99 @@ All notable changes to the "Znuny" extension will be documented in this file.
 - `znuny.LayoutObject.AddPopupProfiles.code-snippets`
 - `znuny.MentionObject.RemoveAllMentions.code-snippets`
 
+#### Updated Snippets
+
+- `znuny.ActivityObject.DataAdd.code-snippets`
+- `znuny.ActivityObject.DataGet.code-snippets`
+- `znuny.ActivityObject.DataListGet.code-snippets`
+- `znuny.ActivityObject.DataSearch.code-snippets`
+- `znuny.CSVObject.CSV2Array.code-snippets`
+- `znuny.CacheObject.Get.code-snippets`
+- `znuny.CalendarObject.CalendarCreate.code-snippets`
+- `znuny.CalendarObject.CalendarImport.code-snippets`
+- `znuny.CalendarObject.CalendarUpdate.code-snippets`
+- `znuny.CalendarObject.TicketAppointmentDelete.code-snippets`
+- `znuny.CheckItemObject.StringClean.code-snippets`
+- `znuny.CustomerUserObject.CustomerUserAdd.code-snippets`
+- `znuny.CustomerUserObject.CustomerUserUpdate.code-snippets`
+- `znuny.CustomerUserObject.SetPassword.code-snippets`
+- `znuny.DynamicFieldObject.ObjectMappingGet.code-snippets`
+- `znuny.DynamicFieldValueObject.AllValuesDelete.code-snippets`
+- `znuny.DynamicFieldValueObject.ValueDelete.code-snippets`
+- `znuny.DynamicFieldValueObject.ValueGet.code-snippets`
+- `znuny.DynamicFieldValueObject.ValueSearch.code-snippets`
+- `znuny.DynamicFieldValueObject.ValueSet.code-snippets`
+- `znuny.DynamicFieldValueObject.ValueValidate.code-snippets`
+- `znuny.EmailObject.Send.code-snippets`
+- `znuny.FormDraftObject.FormDraftDelete.code-snippets`
+- `znuny.FormDraftObject.FormDraftGet.code-snippets`
+- `znuny.GenericAgentObject.JobRun.code-snippets`
+- `znuny.JSONObject.Encode.code-snippets`
+- `znuny.JWTObject.Encode.code-snippets`
+- `znuny.LinkObject.LinkCleanup.code-snippets`
+- `znuny.LinkObject.LinkListWithData.code-snippets`
+- `znuny.LinkObject.ObjectDescriptionGet.code-snippets`
+- `znuny.LinkObject.ObjectPermission.code-snippets`
+- `znuny.LogObject.GetLogEntry.code-snippets`
+- `znuny.MailAccountObject.MailAccountCheck.code-snippets`
+- `znuny.MailAccountObject.MailAccountFetch.code-snippets`
+- `znuny.MailAccountObject.MailAccountUpdate.code-snippets`
+- `znuny.MailQueueObject.Create.code-snippets`
+- `znuny.MailQueueObject.Delete.code-snippets`
+- `znuny.MailQueueObject.Get.code-snippets`
+- `znuny.MailQueueObject.List.code-snippets`
+- `znuny.MailQueueObject.Send.code-snippets`
+- `znuny.MainObject.Dump.code-snippets`
+- `znuny.MainObject.FileDelete.code-snippets`
+- `znuny.MainObject.FileGetMTime.code-snippets`
+- `znuny.MainObject.FilenameCleanUp.code-snippets`
+- `znuny.MentionObject.GetTicketMentions.code-snippets`
+- `znuny.MentionObject.GetUserMentions.code-snippets`
+- `znuny.NotificationEventObject.NotificationImport.code-snippets`
+- `znuny.PIDObject.PIDCreate.code-snippets`
+- `znuny.PIDObject.PIDUpdate.code-snippets`
+- `znuny.PackageObject.AnalyzePackageFrameworkRequirements.code-snippets`
+- `znuny.PackageObject.DeployCheck.code-snippets`
+- `znuny.PackageObject.PackageFileGetMD5Sum.code-snippets`
+- `znuny.PackageObject.PackageInstall.code-snippets`
+- `znuny.PackageObject.RepositoryAdd.code-snippets`
+- `znuny.PackageObject.RepositoryPackageListGet.code-snippets`
+- `znuny.QueueObject.NameExistsCheck.code-snippets`
+- `znuny.QueueObject.QueueGet.code-snippets`
+- `znuny.SLAObject.SLAUpdate.code-snippets`
+- `znuny.ServiceObject.ServiceAdd.code-snippets`
+- `znuny.ServiceObject.ServiceUpdate.code-snippets`
+- `znuny.StandardTemplateObject.NameExistsCheck.code-snippets`
+- `znuny.StateObject.StateGetStatesByType.code-snippets`
+- `znuny.StatsObject.Export.code-snippets`
+- `znuny.StatsObject.GetStaticFiles.code-snippets`
+- `znuny.StatsObject.GetStatsList.code-snippets`
+- `znuny.StatsObject.StatsCleanUp.code-snippets`
+- `znuny.StatsObject.StatsInstall.code-snippets`
+- `znuny.StatsObject.StatsListGet.code-snippets`
+- `znuny.StatsObject.StatsResultCacheCompute.code-snippets`
+- `znuny.StatsObject.StatsResultCacheGet.code-snippets`
+- `znuny.StatsObject.StatsRun.code-snippets`
+- `znuny.StatsObject.StatsUninstall.code-snippets`
+- `znuny.StatsObject.StringAndTimestamp2Filename.code-snippets`
+- `znuny.StdAttachmentObject.StdAttachmentList.code-snippets`
+- `znuny.SupportDataCollectorObject.Collect.code-snippets`
+- `znuny.SysConfigObject.ConfigurationDeploy.code-snippets`
+- `znuny.SysConfigObject.ConfigurationNavigationTree.code-snippets`
+- `znuny.SysConfigObject.SettingAddItem.code-snippets`
+- `znuny.SysConfigObject.SettingEffectiveValueCheck.code-snippets`
+- `znuny.SysConfigObject.SettingEffectiveValueGet.code-snippets`
+- `znuny.SysConfigObject.SettingReset.code-snippets`
+- `znuny.SysConfigObject.SettingUpdate.code-snippets`
+- `znuny.SystemDataObject.SystemDataDelete.code-snippets`
+- `znuny.SystemDataObject.SystemDataGet.code-snippets`
+- `znuny.SystemDataObject.SystemDataUpdate.code-snippets`
+- `znuny.TemplateGeneratorObject.GenericAgentArticle.code-snippets`
+- `znuny.TemplateGeneratorObject.Sender.code-snippets`
+- `znuny.TicketAttributeRelationsObject.GetTicketAttributeRelations.code-snippets`
+- `znuny.TypeObject.NameExistsCheck.code-snippets`
+- `znuny.ObjectManager.PostMasterObject.code-snippets`
+
 ## [1.1.2]
 
 ### Snippets

diff --git a/snippets/Functions/ActivityObject/znuny.ActivityObject.DataAdd.code-snippets b/snippets/Functions/ActivityObject/znuny.ActivityObject.DataAdd.code-snippets
@@ -2,15 +2,15 @@
     "znuny.ActivityObject.DataAdd": {
         "body": [
             "${1:my \\$CreatedID = \\$ActivityObject->DataAdd(",
-            "    ID               => '...',",
-            "    Type             => '...',",
-            "    Title            => '...',",
-            "    Text             => '...',",
-            "    State            => '...',",
-            "    Link             => '...',",
-            "    CreateTime       => '...',",
-            "    CreateBy         => '...',",
-            "    UserID           => \\$UserID,",
+            "    ID         => '...',",
+            "    Type       => '...',",
+            "    Title      => '...',",
+            "    Text       => '...',",
+            "    State      => '...',",
+            "    Link       => '...',",
+            "    CreateTime => '...',",
+            "    CreateBy   => '...',",
+            "    UserID     => \\$UserID,",
             ");}",
         ],
         "prefix": "znuny.ActivityObject.DataAdd",

diff --git a/snippets/Functions/ActivityObject/znuny.ActivityObject.DataGet.code-snippets b/snippets/Functions/ActivityObject/znuny.ActivityObject.DataGet.code-snippets
@@ -2,15 +2,15 @@
     "znuny.ActivityObject.DataGet": {
         "body": [
             "${1:my %Data = \\$ActivityObject->DataGet(",
-            "    ID               => '...', # optional",
-            "    Type             => '...', # optional",
-            "    Title            => '...', # optional",
-            "    Text             => '...', # optional",
-            "    State            => '...', # optional",
-            "    Link             => '...', # optional",
-            "    CreateTime       => '...', # optional",
-            "    CreateBy         => '...', # optional",
-            "    UserID           => \\$UserID,",
+            "    ID         => '...', # optional",
+            "    Type       => '...', # optional",
+            "    Title      => '...', # optional",
+            "    Text       => '...', # optional",
+            "    State      => '...', # optional",
+            "    Link       => '...', # optional",
+            "    CreateTime => '...', # optional",
+            "    CreateBy   => '...', # optional",
+            "    UserID     => \\$UserID,",
             ");}",
         ],
         "prefix": "znuny.ActivityObject.DataGet",

diff --git a/snippets/Functions/ActivityObject/znuny.ActivityObject.DataListGet.code-snippets b/snippets/Functions/ActivityObject/znuny.ActivityObject.DataListGet.code-snippets
@@ -2,15 +2,15 @@
     "znuny.ActivityObject.DataListGet": {
         "body": [
             "${1:my @Data = \\$ActivityObject->DataListGet(",
-            "    ID               => '...', # optional",
-            "    Type             => '...', # optional",
-            "    Title            => '...', # optional",
-            "    Text             => '...', # optional",
-            "    State            => '...', # optional",
-            "    Link             => '...', # optional",
-            "    CreateTime       => '...', # optional",
-            "    CreateBy         => '...', # optional",
-            "    UserID           => \\$UserID,",
+            "    ID         => '...', # optional",
+            "    Type       => '...', # optional",
+            "    Title      => '...', # optional",
+            "    Text       => '...', # optional",
+            "    State      => '...', # optional",
+            "    Link       => '...', # optional",
+            "    CreateTime => '...', # optional",
+            "    CreateBy   => '...', # optional",
+            "    UserID     => \\$UserID,",
             ");}",
         ],
         "prefix": "znuny.ActivityObject.DataListGet",

diff --git a/snippets/Functions/ActivityObject/znuny.ActivityObject.DataSearch.code-snippets b/snippets/Functions/ActivityObject/znuny.ActivityObject.DataSearch.code-snippets
@@ -2,16 +2,16 @@
     "znuny.ActivityObject.DataSearch": {
         "body": [
             "${1:my %Data = \\$ActivityObject->DataSearch(",
-            "    Search           => 'test*test',",
-            "    ID               => '...', # optional",
-            "    Type             => '...', # optional",
-            "    Title            => '...', # optional",
-            "    Text             => '...', # optional",
-            "    State            => '...', # optional",
-            "    Link             => '...', # optional",
-            "    CreateTime       => '...', # optional",
-            "    CreateBy         => '...', # optional",
-            "    UserID           => \\$UserID,",
+            "    Search     => 'test*test',",
+            "    ID         => '...', # optional",
+            "    Type       => '...', # optional",
+            "    Title      => '...', # optional",
+            "    Text       => '...', # optional",
+            "    State      => '...', # optional",
+            "    Link       => '...', # optional",
+            "    CreateTime => '...', # optional",
+            "    CreateBy   => '...', # optional",
+            "    UserID     => \\$UserID,",
             ");}",
         ],
         "prefix": "znuny.ActivityObject.DataSearch",

diff --git a/snippets/Functions/CSVObject/znuny.CSVObject.CSV2Array.code-snippets b/snippets/Functions/CSVObject/znuny.CSVObject.CSV2Array.code-snippets
@@ -3,8 +3,8 @@
         "body": [
             "${1:my \\$RefArray = \\$CSVObject->CSV2Array(",
             "    String    => \\$CSVString,",
-            "    Separator => ';', # optional separator (default is ;)",
-            "    Quote     => '\\"', # optional quote (default is \\")",
+            "    Separator => ';',           # optional separator (default is ;)",
+            "    Quote     => '\\"',           # optional quote (default is \\")",
             ");}",
         ],
         "prefix": "znuny.CSVObject.CSV2Array",

diff --git a/snippets/Functions/CacheObject/znuny.CacheObject.Get.code-snippets b/snippets/Functions/CacheObject/znuny.CacheObject.Get.code-snippets
@@ -5,7 +5,7 @@
             "    Type => 'ObjectName',",
             "    Key  => 'SomeKey',",
             "",
-            "    CacheInMemory => 0,     # optional, defaults to 1",
+            "    CacheInMemory  => 0,    # optional, defaults to 1",
             "    CacheInBackend => 1,    # optional, defaults to 1",
             ");}",
             "${2:my \\$Value = \\$CacheObject->Get(",

diff --git a/snippets/Functions/CalendarObject/znuny.CalendarObject.CalendarCreate.code-snippets b/snippets/Functions/CalendarObject/znuny.CalendarObject.CalendarCreate.code-snippets
@@ -2,16 +2,16 @@
     "znuny.CalendarObject.CalendarCreate": {
         "body": [
             "${1:my %Calendar = \\$CalendarObject->CalendarCreate(",
-            "    CalendarName    => 'Meetings',          # (required) Personal calendar name",
-            "    GroupID         => \\$GroupID,                   # (required) GroupID",
-            "    Color           => '#FF7700',           # (required) Color in hexadecimal RGB notation",
-            "    UserID          => \\$UserID,                   # (required) UserID",
+            "    CalendarName         => 'Meetings',          # (required) Personal calendar name",
+            "    GroupID              => \\$GroupID,                   # (required) GroupID",
+            "    Color                => '#FF7700',           # (required) Color in hexadecimal RGB notation",
+            "    UserID               => \\$UserID,                   # (required) UserID",
             "",
-            "    TicketAppointments => [                 # (optional) Ticket appointments, array ref of hashes",
+            "    TicketAppointments   => [                    # (optional) Ticket appointments, array ref of hashes",
             "        {",
-            "            StartDate => 'FirstResponse',",
-            "            EndDate   => 'Plus_5',",
-            "            QueueID   => [ \\$QueueID ],",
+            "            StartDate    => 'FirstResponse',",
+            "            EndDate      => 'Plus_5',",
+            "            QueueID      => [ \\$QueueID ],",
             "            SearchParams => {",
             "                Title => 'This is a title',",
             "                Types => 'This is a type',",

diff --git a/snippets/Functions/CalendarObject/znuny.CalendarObject.CalendarImport.code-snippets b/snippets/Functions/CalendarObject/znuny.CalendarObject.CalendarImport.code-snippets
@@ -12,10 +12,10 @@
             "        \\},",
             "        AppointmentData => {",
             "            {",
-            "                AppointmentID       => \\$AppointmentID,",
-            "                ParentID            => \\$ParentID,",
-            "                CalendarID          => \\$CalendarID,",
-            "                UniqueID            => \\$UniqueID,",
+            "                AppointmentID => \\$AppointmentID,",
+            "                ParentID      => \\$ParentID,",
+            "                CalendarID    => \\$CalendarID,",
+            "                UniqueID      => \\$UniqueID,",
             "                # ...",
             "            \\},",
             "            # ...",

diff --git a/snippets/Functions/CalendarObject/znuny.CalendarObject.CalendarUpdate.code-snippets b/snippets/Functions/CalendarObject/znuny.CalendarObject.CalendarUpdate.code-snippets
@@ -2,14 +2,13 @@
     "znuny.CalendarObject.CalendarUpdate": {
         "body": [
             "${1:my \\$Success = \\$CalendarObject->CalendarUpdate(",
-            "    CalendarID       => \\$CalendarID,                   # (required) CalendarID",
-            "    GroupID          => \\$GroupID,                   # (required) Calendar group",
-            "    CalendarName     => 'Meetings',          # (required) Personal calendar name",
-            "    Color            => '#FF9900',           # (required) Color in hexadecimal RGB notation",
-            "    UserID           => \\$UserID,                   # (required) UserID (who made update)",
-            "    ValidID          => \\$ValidID,                   # (required) ValidID",
-            "",
-            "    TicketAppointments => [                 # (optional) Ticket appointments, array ref of hashes",
+            "    CalendarID         => \\$CalendarID,                   # (required) CalendarID",
+            "    GroupID            => \\$GroupID,                   # (required) Calendar group",
+            "    CalendarName       => 'Meetings',          # (required) Personal calendar name",
+            "    Color              => '#FF9900',           # (required) Color in hexadecimal RGB notation",
+            "    UserID             => \\$UserID,                   # (required) UserID (who made update)",
+            "    ValidID            => \\$ValidID,                   # (required) ValidID",
+            "    TicketAppointments => [                    # (optional) Ticket appointments, array ref of hashes",
             "        {",
             "            StartDate => 'FirstResponse',",
             "            EndDate   => 'Plus_5',",

diff --git a/snippets/Functions/CalendarObject/znuny.CalendarObject.TicketAppointmentDelete.code-snippets b/snippets/Functions/CalendarObject/znuny.CalendarObject.TicketAppointmentDelete.code-snippets
@@ -6,7 +6,6 @@
             "    RuleID        => \\$RuleID,    # (required) RuleID",
             "                                                            # or",
             "    TicketID      => \\$TicketID,                                     # (required) Ticket ID",
-            "",
             "    AppointmentID => \\$AppointmentID,                                     # (optional) Appointment ID is known",
             ");}",
         ],

diff --git a/snippets/Functions/CheckItemObject/znuny.CheckItemObject.StringClean.code-snippets b/snippets/Functions/CheckItemObject/znuny.CheckItemObject.StringClean.code-snippets
@@ -2,13 +2,13 @@
     "znuny.CheckItemObject.StringClean": {
         "body": [
             "${1:my \\$StringRef = \\$CheckItemObject->StringClean(",
-            "    StringRef               => \'String',",
-            "    TrimLeft                => 0,  # (optional) default 1",
-            "    TrimRight               => 0,  # (optional) default 1",
-            "    RemoveAllNewlines       => 1,  # (optional) default 0",
-            "    RemoveAllTabs           => 1,  # (optional) default 0",
-            "    RemoveAllSpaces         => 1,  # (optional) default 0",
-            "    ReplaceWithWhiteSpace   => 1,  # (optional) default 0",
+            "    StringRef             => \'String',",
+            "    TrimLeft              => 0,  # (optional) default 1",
+            "    TrimRight             => 0,  # (optional) default 1",
+            "    RemoveAllNewlines     => 1,  # (optional) default 0",
+            "    RemoveAllTabs         => 1,  # (optional) default 0",
+            "    RemoveAllSpaces       => 1,  # (optional) default 0",
+            "    ReplaceWithWhiteSpace => 1,  # (optional) default 0",
             ");}",
         ],
         "prefix": "znuny.CheckItemObject.StringClean",

diff --git a/snippets/Functions/CustomerUserObject/znuny.CustomerUserObject.CustomerUserAdd.code-snippets b/snippets/Functions/CustomerUserObject/znuny.CustomerUserObject.CustomerUserAdd.code-snippets
@@ -7,7 +7,7 @@
             "    UserLastname   => 'Manfred',",
             "    UserCustomerID => \\$UserCustomerID,",
             "    UserLogin      => 'mhuber',",
-            "    UserPassword   => 'some-pass', # not required",
+            "    UserPassword   => 'some-pass',          # not required",
             "    UserEmail      => '[email protected]',",
             "    ValidID        => \\$ValidID,",
             "    UserID         => \\$UserID,",

diff --git a/...ts/Functions/CustomerUserObject/znuny.CustomerUserObject.CustomerUserUpdate.code-snippets b/...ts/Functions/CustomerUserObject/znuny.CustomerUserObject.CustomerUserUpdate.code-snippets
@@ -2,12 +2,12 @@
     "znuny.CustomerUserObject.CustomerUserUpdate": {
         "body": [
             "${1:\\$CustomerUserObject->CustomerUserUpdate(",
-            "    Source        => 'CustomerUser', # CustomerUser source config",
-            "    ID            => 'mh',           # current user login",
-            "    UserLogin     => 'mhuber',       # new user login",
+            "    Source        => 'CustomerUser',        # CustomerUser source config",
+            "    ID            => 'mh',                  # current user login",
+            "    UserLogin     => 'mhuber',              # new user login",
             "    UserFirstname => 'Huber',",
             "    UserLastname  => 'Manfred',",
-            "    UserPassword  => 'some-pass',    # not required",
+            "    UserPassword  => 'some-pass',           # not required",
             "    UserEmail     => '[email protected]',",
             "    ValidID       => \\$ValidID,",
             "    UserID        => \\$UserID,",

diff --git a/snippets/Functions/CustomerUserObject/znuny.CustomerUserObject.SetPassword.code-snippets b/snippets/Functions/CustomerUserObject/znuny.CustomerUserObject.SetPassword.code-snippets
@@ -3,7 +3,7 @@
         "body": [
             "${1:\\$CustomerUserObject->SetPassword(",
             "    UserLogin => 'some-login',",
-            "    PW        => 'some-new-password'",
+            "    PW        => 'some-new-password',",
             ");}",
         ],
         "prefix": "znuny.CustomerUserObject.SetPassword",

diff --git a/...pets/Functions/DynamicFieldObject/znuny.DynamicFieldObject.ObjectMappingGet.code-snippets b/...pets/Functions/DynamicFieldObject/znuny.DynamicFieldObject.ObjectMappingGet.code-snippets
@@ -2,11 +2,11 @@
     "znuny.DynamicFieldObject.ObjectMappingGet": {
         "body": [
             "${1:my \\$ObjectMapping = \\$DynamicFieldObject->ObjectMappingGet(",
-            "    ObjectName            => \\$ObjectName,    # Name or array ref of names of the object(s) to get the ID(s) for",
+            "    ObjectName => \\$ObjectName,    # Name or array ref of names of the object(s) to get the ID(s) for",
             "                                             # Note: either give ObjectName or ObjectID",
-            "    ObjectID              => \\$ObjectID,      # ID or array ref of IDs of the object(s) to get the name(s) for",
+            "    ObjectID   => \\$ObjectID,      # ID or array ref of IDs of the object(s) to get the name(s) for",
             "                                             # Note: either give ObjectName or ObjectID",
-            "    ObjectType            => 'CustomerUser', # Type of object to get mapping for",
+            "    ObjectType => 'CustomerUser', # Type of object to get mapping for",
             ");}",
         ],
         "prefix": "znuny.DynamicFieldObject.ObjectMappingGet",

diff --git a/...tions/DynamicFieldValueObject/znuny.DynamicFieldValueObject.AllValuesDelete.code-snippets b/...tions/DynamicFieldValueObject/znuny.DynamicFieldValueObject.AllValuesDelete.code-snippets
@@ -2,7 +2,7 @@
     "znuny.DynamicFieldValueObject.AllValuesDelete": {
         "body": [
             "${1:my \\$Success = \\$DynamicFieldValueObject->AllValuesDelete(",
-            "    FieldID            => \\$FieldID,                 # ID of the dynamic field",
+            "    FieldID => \\$FieldID,    # ID of the dynamic field",
             "    UserID  => \\$UserID,",
             ");}",
         ],