joomla/Component-Builder
joomla/Component-Builder
39
23
Fork 11
Code Issues 82 Pull Requests Projects 4 Wiki Activity
Page: 026 How to setup a store message method along side the email helper class
Pages
001 Hello World with Joomla Component Builder 002 Intro to JCB 003 Installation of JCB 004 General Planning 005 Field Types 006 Basic Fields 007 Admin Views 008 Advanced Fields 009 Adding Admin Views to a Component 010 Component Settings 011 Component Scripts 012 Component FTP and more 013 dynamicGet 014 Adding dynamicGet to a Site View 015 Adding Templates and Layouts to a Site View 016 Template Setup 017 Layout Setup 018 Custom Admin Views 019 Adding Site Views to a Component 020 Adding Custom Admin Views to a Component 021 Tweaking MySQL Demo Data 022 Global Settings of Component Builder 023 Adding a custom time field 024 How to integrate the Create User Helper Method in your Components 025 How to use email helper in your components 026 How to setup a store message method along side the email helper class 027 How to ensure that a field is not escaped when added to list views 028 How to change exported values and setup custom import options 029 How to overwrite the custom fields 030 How to filter a list field based on association with another field 031 Automatic import of custom code during compilation in JCB 032 JCB manual custom code implementation 033 Export Import of fully mapped components 034 How to add Custom Buttons in JCB to your component Admin Area 035 Translation Mananger in JCB explained 036 Setting Site View Permission 037 Auto create SQL updates for Componets in JCB 038 Setup Site Edit View in JCB 039 Automated backup system in JCB 040 Adding Helper Structures to any JCB component 041 Upgrade to JCB v2.5.8 and using the new Admin View and Admin Fields 042 How to setup tabs after upgrade to v2.5.8 in JCB 043 Major Release of JCB v2.6.0 044 Hello World Component with Joomla Component Builder Creator Extended 045 Adding your own rule validation to a field in JCB 046 General overview of how community snippets work 047 Tutorial on forking JCB snippets so you can share your snippets with the rest of the Community 048 Tutorial on making a pull request at Joomla Component Builder Snippets 049 The New Library Manager Area 050 Easy Translation via excel 051 Dynamic Router Implementation Explained 052 Automated database updates in Joomla during development of a component 053 Quick Subform Demonstration 054 VDM Package Import Option 055 Dynamic File and Folder Inclusion concept 056 How to use the file field type to upload a file in JCB 057 Drag and Drop Upload functionality in JCB 058 The Quick Hello Word with JCB 059 Adding none database fields to an admin view 060 The custom dashboard option in JCB 061 Add or Remove Prefix to Component Name in Joomla Menu 062 Add your own JCB packages to the JCB Communty Directory 063 Proposed Collaborative Workflow in JCB 064 How to install jcb packages 065 JAB18 Using Joomla Component Builder 066 The new fields Area to make things easier 067 Adding Language String to your Component and get the Language Placeholder for dynamic use 068 Library Manager Anticipated Functionality 069 Join Fields in the admin list view with field relations 070 How to change the License Template in JCB 071 Reuse Custom Code 072 Setup Local Development Environment with Bitnami 073 JCB Fields Type Extended 074 How to add Joomla Custom Fields 075 Expand Custom Field Type Beyond The Default 076 A Quick Demonstration to Load a List of Items in a Site View 077 Run Expansion Explained 078 How to Add a Form to a Site View 079 Update the Site Form Field via URL Parameter 080 How to Add More Helper Methods to Your Components Helper Class 081 Easy Validation Rules for Fields in JCB 082 New Placeholders Feature 083 Manage a Components Global Config Option Field in Relation With Menu Params 084 Default Database Values can be set per Field Type Beta Testing Component Settings Develop a Joomla Component Guide to use the Component Builder Developing with Joomla Component Builder Home PHP Settings TIPS: Custom Code Using the JCB Demo Component While Building Your Local Development System
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
Table of Contents

HOW TO SETUP A STORE MESSAGE METHOD ALONGSIDE THE EMAIL HELPER CLASS

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

00:01:17

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

00:02:19

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.