14 026 How to setup a store message method along side the email helper class
Amigo edited this page 2019-08-15 14:50:53 +02:00


00:00:00 (Click on these time links to see Youtube video)

  • Example In Code

In a previous tutorial on the Email Helper, mention had been made of storing messages or emails once they had been sent. 00:00:24 At this stage it is important to know that the Email Helper Class is added to the Helper folder of the component's back end. It's usually called the component's name, 'Jobtracking', and 'Email', the Email Helper class. To use it in the Custom Script three brackets may be used, '[component]email'. Send. 00:00:59 That is how to construct script.

Code Snippet In Method


At the bottom of this class, in the 'Send' method, there is a snippet. Insignificant as it may seem, it is beneficial; the result of the email that was sent is placed in 'sendEmail' and the result is transferred to the method as well. 00:01:47 It does a search in the Helper class (which is usually a component name: 'Helper', which is the Helper Class) to a certain whether this method exists in that class.

This method will not exist unless it is manually written in the component area. The area where this method should be written is in the component (in the Component Builder Dashboard) in an area called Admin Helper.

Adding Code To Admin Helper Area


Open a component and go to Libs & Helpers. Scroll down. 'Add PHP(admin_helper)' may be seen and in which a function called 'storemessage' is where the component may be edited. 00:02:47 This 'Storemessage' has a signature that exists of values that are transferred to the method.

It also has a signature in the Email Helper Class. 00:03:19 Wherever it gives this '=null' with a value, it is the default value. If a value is not added to this position, there are one, two, three, four, five, positions, then it will default to '=null'. 00:03:51 From there all the values receive the value '=null'. It is only necessary to add the first four values. Those values are all used in this method. (See video.) 00:04:17 This script, "if(method_exists('Jobtracking Helper','storeMessage'))", asks whether the method had been created. If not, it simply skips it and returns the value of '$sendmail'. 00:04:52 If it has been created, it will pass these variables corresponding to the signature. In that method, in the Helper Class (PHP), the necessary checks and balances must be done. Since the email address is known, a search may be done with the 'getVar' in the User Class. The recipient must equal 'email' and return the 'id'. 00:05:09 That is how the 'getVar' operates. Having the user ID, the number can be verified and set to the message as 'User'. That is then set as the Email.

Now the message may be stored in any table and more exceptional tasks may be performed than only storing the message. This is the method by which it can be done. (See video.) 00:05:38 'Storemessage' is the method with which more custom scripting on top of the email integration can be done.