{"id":608,"date":"2018-02-28T21:08:00","date_gmt":"2018-02-28T21:08:00","guid":{"rendered":"https:\/\/codenerix.com\/?p=608\/"},"modified":"2023-04-06T07:06:54","modified_gmt":"2023-04-06T07:06:54","slug":"codenerixmodel","status":"publish","type":"post","link":"https:\/\/codenerix.com\/en\/codenerixmodel\/","title":{"rendered":"CodenerixModel"},"content":{"rendered":"\n

\ud83c\uddea\ud83c\udde6 Leer en Espa\u00f1ol, \u201cCodenerixModel<\/a>\u201c<\/p>\n\n\n\n

For any Django project to support CODENERIX properly, it is necessary to take some important steps to ensure a good start to the project. We will not repeat that using the CODE<\/span>NERIX<\/span><\/strong> Examples<\/a> available on GitHub<\/a> is the easiest way to get started.<\/p>\n\n\n\n

That is why this time, we will focus on the CORE \/ KERNEL of CODE<\/span>NERIX<\/span><\/a>, which<\/strong> we will know from now on as CodenerixModel<\/strong>.<\/p>\n\n\n\n

CodenerixModel<\/strong> is an extended class from Django’s models.Model <\/strong>where a series of new functionalities are contemplated that we will explain below. First, we must bear in mind that most of the functionalities we will see in CODE<\/span>NERIX<\/span><\/a><\/strong> are achieved through the use of direct inheritance of classes of this framework. To do this, we are going to see a simple example of a class developed with CODE<\/span>NERIX<\/span><\/a><\/strong>:<\/p>\n\n\n\n

from codenerix.models import CodenerixModel\n\nfrom django.db import models\n\nclass Author(CodenerixModel):\n    name = models.CharField(_(u'Name'), max_length=128, blank=False, null=False)\n    birth_date = models.CharField(_(u'Birth Date'), max_length=128, blank=False, null=False)\n    def __fields__(self, info):\n        fields=[]\n        fields.append(('name', _('Name'), 100, 'left'))\n        fields.append(('birth_date', _('Birth Date')))\n        return fields<\/pre>\n\n\n\n
In this example, we see several things that stand out to us compared to a normal declaration of a model in Django:<\/p>\n\n\n\n
    \n
  1. We import CodenerixModel<\/strong> with:
    from codenerix.models import CodenerixModel<\/code><\/code>

    <\/li>\n\n\n\n
  2. The model inherits CodenerixModel (not from models.Model<\/strong>):
    class Author(CoderixModel):<\/code><\/code>

    <\/li>\n\n\n\n
  3. There is a special method that is required<\/mark><\/strong> called __fields__<\/strong> and takes an “info<\/strong>” argument:
    def fields(self, info):<\/code><\/code>

    We must remember that this method must be defined in all the classes inherited from CodenerixModel<\/strong> since     CODE<\/span>NERIX<\/span><\/a><\/strong> uses it to know how to show the information to the end-user of the application in such a way that it is clear, simple, and usable.
    <\/li>\n\n\n\n
  4. The rest of the information in the class is simple to understand and responds to the general paradigm that Django<\/strong> uses. In fact, CODE<\/span>NERIX<\/span><\/a><\/strong> always inherits Django<\/strong> and passes its management to it, thus always ensuring that any improvements to Django<\/strong> are also available in CODE<\/span>NERIX<\/span><\/a><\/strong>.<\/li>\n<\/ol>\n\n\n\n
    <\/p>\n\n\n\n
    What does the __fields__<\/em> method contain?<\/h2>\n\n\n\n
    It collects what information from the model is useful to be shown when the user wants to work with that model. This method is usually called from lists since the fields that appear here will be used as columns in the listing.<\/p>\n\n\n\n
    def __fields__(self, info):\n    fields=[]\n    fields.append(('name', ('Name'), 100, 'left')) fields.append(('birth_date', ('Birth Date')))\n    return fields<\/pre>\n\n\n\n
    \u26a0 IMPORTANT: This method is mandatory<\/mark> in all models inherited from CodenerixModel.<\/strong><\/p>\n\n\n\n
    The method receives an “info<\/strong>” argument that contains information about the query received (request), including, among other data, the user who makes it and other important meta information for decision-making that will be made within __fields__<\/strong>. This example is linear, but we can take advantage of this information to detect a user’s level of access and display some fields or others in the list, adapting the content of the list depending on the user or the system conditions.<\/p>\n\n\n\n
    This method is expected to respond with a list of tuples containing at least 2 elements. The first will be the field’s name according to Django’s model, and the second will be the translatable name of the field to be shown to the user in the column’s title referenced by that field.<\/p>\n\n\n\n
    Each tuple, therefore, consists of 2 mandatory elements and several optional elements:<\/p>\n\n\n\n