joomla/Component-Builder
joomla
/
Component-Builder
38
19
Fork 11
Code Issues 41 Pull Requests Projects 3 Releases Wiki Activity
Page: 033 Export Import of fully mapped components
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 033 Export Import of fully mapped components
Amigo edited this page 2019-08-15 14:09:01 +02:00
Table of Contents

EXPORT-IMPORT OF FULLY MAPPED COMPONENTS

Various Linked Concepts to A component is Exported

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

A new feature has been added to the advanced Component Builder for Joomla which can become very useful in the future. It allows you to export a component out of JCB, and not only the component's information, but everything attached to it. 00:00:34 If the component has Admin Views linked to it, and those Admin Views have fields linked to it, and those fields have field types linked to it, and that component has site views, and Custom Admin views, and those Site Views and Custom Admin Views has templates and layouts, and dynamic gets, and all these various linked concepts to a component, is exported.

Two Ways To Export A Component - Encrypted And Non Encrypted

00:01:09

The way to export a component is to simply click on 'Export Components'. Select the component or components that should be exported. There are two ways of how a component gets exported. One is an encrypted way, and the other is non-encrypted.

Smart Export Builder

00:01:40

Let me show that in the code. There is a method called 'smartExportBuilder'. The 'SmartExportBuilder' gets fired at the very end of the compilation or rather the build. Where all the data has now been extracted from the database and it is now one large array of objects. This data extrusion takes place in the function called 'getSmartExport'.

Export Key

00:02:21

During this process, an account is taken of a specific value. That value's name is 'export key'. So in this 'for each' we are looping through the components that have been selected. If more than one has been selected, then it will check whether there is an 'export key' for that component. It is set in the user interface. When a component is opened, it has a tab called settings. 00:03:00 At the bottom of the right-hand column it has a new field called 'Export Key'. Any value may be placed in here. If this value is left empty, and only this(sermonDistributor) component gets exported, then the component will not be encrypted. If a value is added to this (Export Key) field and this component is exported, it will encrypt that component's data; the database values. 00:03:32It will not encrypt attached files or folders or images that are part of this component. It will only encrypt the data from the database.

Export Key - Encrypt All Components

00:03:54

If multiple components are selected, and anyone of them has a key, then it will encrypt all the components. It will be explained again in the code how this is done. Return to the code. It needs to be asked: Does this component have an export key? 00:04:16 If it is 'true' and it has a 'string', this key is encrypted in a database. First check if it is possible to encrypt it, and then encrypt the key. Then add it to the key array with the component's ID. An array is being built from each component's key. 00:04:41 If a component does not have a key, it simply ignores this script and it continues building its data set. Then once all the data set of all components are finished, then in the 'smartExportBuilder' it may be checked if any keys had been found.

If Any Key - Implode The array

00:05:12

If any keys have been found, the array is going to be imploded and converted to an 'md5' string. We will then use this 'md5' string with an 'Aes' encryption cipher to lock the data. 00:05:37 There is the data(See video). Above here the whole data set has already been changed to a serialized string. There is a string in this(data) variable and here is the whole string encrypted. In this(data) variable is the encrypted value. If there are not any keys, even if that means if none of the components that were selected had any keys set, then it will default simply to do a 'base64_encode'. 00:06:09 That as well, gets written to the file that is part of the package. That is how it exports the data. 00:06:43 So it exports the data and then checks whether there are any keys. So if there is, for example, Export five components, and all five components have keys, all five keys will create a very long string, and then that whole string will be changed into an 'md5' string which is 32 characters. That 32 characters is then used to encrypt the data.

Exporting A Component - Generating A Key

00:07:13

This key which is used to do the encryption will be shown in the interface after the data has been exported. Go back to the user interface and export a component. The(Learning Manager) component has a key. There are other components that have no keys at this stage.

Learning Manager is used as a demonstration. 00:07:52

Click 'export component' and as may be seen it generated a key, which can then be used to import this package into another JCB. It may be imported into the same JCB, but it is obviously not necessary. It could also be used as a backup. It is storing the compiled package in the temporary folder at this stage. 00:08:55 Here is an exported component at the moment, if the data sets are not too large and the memory settings on PHP and so forth are allowing this kind of compilation, all components can then be selected and exported. The result will be the same. Since only one component is set with a key, all of them will be encrypted with the same key. All of them will be stored in this package. All the components have been exported into this one package.

Importing Components - JCB_smartPackage.zip

00:09:41

To demonstrate the importing of this(JCB_smartPackage.zip) data set, a blank website is used. 00:09:49 This blank website, has no special JCB components. First, JCB has to be installed from GitHub. On GitHub the releases should be opened. 00:10:14 The link is copied to the latest release. Go back, paste that in here(Install From URL) and install it. If the installation was successful, go to Component Builder, and open the components. As may be seen 00:10:43 there is only the demo component. If all these components need to be moved to the new install, click on 'Import Components'. Browse to that package that has just been exported and uploads it.

Two Features - Force Local Update - Use Key

00:11:13

There are two features. This 'Force Local Update' may be explained as follow. If under normal circumstances an import is done, the import function looks at the data that are currently in this JCB install. For example Field types, Fields, Admin views and Site views are involved. 00:11:42 If it finds a site view that is being installed, that is already in the current database, it looks at the last modified date, and then by that determines whether the currently installed version is the most recent. If it is the latest version, it will by default ignore the new data and not install it. Sometimes you may get a package, which makes it necessary to force it to update the current data even though it may include all the data. This is the function of the 'Force Local Update' switch. Click 'yes' to force the update. 00:12:20 As there is a key for this package, the switch should remain 'yes'. Copy that key from Joomla Components. This key will then always be necessary if this package is imported. Click 'continue'. This is quite a huge dataset and may take a while. It will indicate that the install had been successful.

Warnings - Remapped

00:12:55

You might get these warnings. What do these warnings indicate? It is that during the install that you are going to realize that lots of IDs will change. This database creates IDs as the new item is added. Since these are the IDs that are used to link the various components, views, and places, all these IDs must be remapped. A very well-formulated algorithm is used to resolve this problem. 00:13:30 So it remaps all the IDs. Sometimes there are certain IDs which can not be remapped. It can be seen that the target field in the Admin Views has a mismatch in the field with 'id.244'. Go back to the previous install, and try to find out what happened there. 00:14:04 Most of the time it is because that specific field is no longer published or for some reason is no longer available. So this is just a heads up of any changes that may have occurred. It is possible to go to these various places and fix them manually. Most of the time these warnings will not show and everything will indicate that it is right. If there are warnings and errors read the messages attentively. This has been a demonstration of this new feature.

Mapped Components

00:14:55

To show that it works properly: It moves all the customer files, custom folders, as well as all the Images per Admin View, Site View, etc., to the new install, it moves it into its right place. If that is true it should be possible to go to the compiler, select any of the components. 00:15:19 It should load that component's image(See video) When compile is clicked it should be able to compile that component after compilation. Install the component. If this component had previously been mapped correctly and going to that component, it will be clear that everything works well. 00:15:51 That is this new feature in action.