Libraries

The “active” code of the application, that is to say the one that chains the actions, is described in the libraries. In general, there is one library per table, but this is not systematic.

The libraries systematically inherit from PpciLibrary, and generally contain the following functions:

• list: display the list of records in the table
• display: display the details of a record
• change: display the modification page
• write: write to the database
• delete: delete the record.

Depending on the case, write and delete refer either to display or to list and, in case of problem, the function reloads the change page.

In some cases, especially when functions can be called from different places in the application, functions simply return the value true or false, and the controller will call the display function, especially after recording operations.

The PpciLibrary class

It manages direct access to some services:

• $this->message: display messages on the screen and record technical messages in Syslog
• $this->appConfig: access to configuration parameters stored in app/Config/App.php or updated via .env
• $this->log: record traces in the gacl.log table of the database.

For it to work properly, it must be initialized as follows:

function __construct()
    {
        parent::__construct();
        $this->dataclass = new ModelsBorrower();
        $this->keyName = "borrower_id";
        if (isset($_REQUEST[$this->keyName])) {
            $this->id = $_REQUEST[$this->keyName];
        }
    }

$this->dataclass must be a class inherited from PpciModel.

It also has generic functions, which simplify the writing of classes in the application. These systematically raise a PpciException exception if an error is encountered.

Reading a record and displaying the page for modification or display

function dataRead($id, $smartyPage, $idParent = 0)

The function calls $this->dataclass->read ($id, true, $idParent), assigns the read data array to the variable $data, then triggers the display of the page $smartyPage. It returns the $data array to the calling function.

Writing a record

function dataWrite(array $data, bool $isPartOfTransaction = false)

Writes the data $data to the table managed by $this->dataclass (call to the write function). If the transaction flag is not enabled, a message informing of the execution of the command is sent, and a trace is recorded in the log table.

Deleting a record

function dataDelete($id, bool $isPartOfTransaction = false)

Deletes the record identified by $id, and displays a message to inform of the success of the operation if the transaction flag is not enabled.

Transaction processing

In the case where several concurrent writes are necessary, it is possible to activate the transactions, managed by CodeIgniter, with the following commands:

try {
   /*
    * Start transaction
    */
   $db = $this->dataclass->db;
   $db->transBegin();
   (...)
   $db->transCommit();
   } catch (PpciException $ie) {
     if ($db->transEnabled) {
     $db->transRollback();
     (...)
   }