ModelViewer.php

Go to the documentation of this file.

<?php
 
namespace Ubiquity\controllers\crud\viewers;
 
use Ajax\semantic\html\elements\HtmlButton;
use Ajax\semantic\html\elements\HtmlHeader;
use Ajax\semantic\html\elements\HtmlLabel;
use Ajax\semantic\widgets\datatable\DataTable;
use Ajax\semantic\widgets\datatable\PositionInTable;
use Ajax\service\JString;
use Ubiquity\controllers\crud\CRUDHelper;
use Ubiquity\controllers\crud\interfaces\HasModelViewerInterface;
use Ubiquity\controllers\crud\viewers\traits\FormModelViewerTrait;
use Ubiquity\orm\OrmUtils;
use Ubiquity\utils\base\UString;
 
class ModelViewer  extends  FormModelViewerTrait  {
    private $jquery;
    private $style;
    
    protected $controller;
    
    public function __construct(HasModelViewerInterface $controller, $style = null) {
        $this->jquery = $controller->jquery;
        $this->controller = $controller;
        $this->style = $style;
    }
    
    public function setStyle($elm) {
        if ($this->style === 'inverted') {
            $elm->setInverted ( true );
            if ($elm instanceof DataTable) {
                $elm->setActiveRowSelector ( 'black' );
            }
        }
    }
    
    public function getModelDataElement($instance, $model, $modal): \Ajax\semantic\widgets\dataelement\DataElement {
        $semantic = $this->jquery->semantic ();
        $fields = $this->controller->_getAdminData ()->getElementFieldNames ( $model );
        
        $dataElement = $semantic->dataElement ( "de", $instance );
        $pk = OrmUtils::getFirstKeyValue ( $instance );
        $dataElement->getInstanceViewer ()->setIdentifierFunction ( function () use ($pk) {
            return $pk;
        } );
            $dataElement->setFields ( $fields );
            $dataElement->setCaptions ( $this->getElementCaptions ( $fields, $model, $instance ) );
            
            $fkInstances = CRUDHelper::getFKIntances ( $instance, $model );
            foreach ( $fkInstances as $member => $fkInstanceArray ) {
                if (array_search ( $member, $fields ) !== false) {
                    $dataElement->setValueFunction ( $member, function () use ($fkInstanceArray, $member) {
                        return $this->getFkMemberElement ( $member, $fkInstanceArray ["objectFK"], $fkInstanceArray ["fkClass"], $fkInstanceArray ["fkTable"] );
                    } );
                }
            }
            $this->addEditMemberFonctionality ( "dataElement" );
            return $dataElement->addClass ( $this->style );
    }
    
    public function getElementCaptions($captions, $className, $instance): array {
        return \array_map ( 'ucfirst', $captions );
    }
    
    public function getModelDataTable($instances, $model, $totalCount, $page = 1): DataTable {
        $adminRoute = $this->controller->_getBaseRoute ();
        $files = $this->controller->_getFiles ();
        $dataTable = $this->getDataTableInstance ( $instances, $model, $totalCount, $page );
        $attributes = $this->controller->_getAdminData ()->getFieldNames ( $model );
        $this->setDataTableAttributes ( $dataTable, $attributes, $model, $instances );
        $dataTable->setCaptions ( $this->getCaptions ( $attributes, $model ) );
        $dataTable->setFocusable(true);
        $dataTable->addClass ( 'small very compact' );
        $lbl = new HtmlLabel ( 'search-query', "<span id='search-query-content'></span>" );
        $icon = $lbl->addIcon ( 'delete', false );
        $lbl->wrap ( "<span>", "</span>" );
        $lbl->setProperty ( "style", "display: none;" );
        $icon->getOnClick ( $adminRoute . $files->getRouteRefreshTable (), '#' . $this->getDataTableId (), [ "jqueryDone" => "replaceWith","hasLoader" => "internal" ] );
        
        $dataTable->addItemInToolbar ( $lbl );
        $dataTable->addSearchInToolbar ();
        $dataTable->setToolbarPosition ( PositionInTable::FOOTER );
        $dataTable->getToolbar ()->setSecondary ();
        $this->setStyle ( $dataTable );
        return $dataTable;
    }
    
    public function setDataTableAttributes(DataTable $dataTable, $attributes, $model, $instances, $selector = null) {
        $modal = ($this->isModal ( $instances, $model ) ? 'modal' : 'no');
        
        $adminRoute = $this->controller->_getBaseRoute ();
        $files = $this->controller->_getFiles ();
        $dataTable->setButtons ( $this->getDataTableRowButtons () );
        $dataTable->setFields ( $attributes );
        if (\array_search ( 'password', $attributes ) !== false) {
            $dataTable->setValueFunction ( 'password', function ($v) {
                return UString::mask ( $v );
            } );
        }
        $dataTable->setIdentifierFunction ( CRUDHelper::getIdentifierFunction ( $model ) );
        
        if (! isset ( $selector )) {
            if (\count ( $instances ) > 0 && $this->showDetailsOnDataTableClick ()) {
                $dataTable->getOnRow ( 'click', $adminRoute . $files->getRouteDetails (), "#table-details", [ "selector" => $selector,"attr" => "data-ajax","hasLoader" => false,"jsCallback" => "return false;" ] );
                $dataTable->setActiveRowSelector ( 'active' );
            }
            
            $dataTable->setUrls ( [ 'refresh' => $adminRoute . $files->getRouteRefresh (),'delete' => $adminRoute . $files->getRouteDelete (),'edit' => $adminRoute . $files->getRouteEdit () . "/" . $modal,'display' => $adminRoute . $files->getRouteDisplay () . "/" . $modal ] );
            $dataTable->setTargetSelector ( [ 'delete' => '#table-messages','edit' => '#frm-add-update','display' => '#table-details' ] );
            $this->addEditMemberFonctionality ( 'dataTable' );
        }
        $this->addAllButtons ( $dataTable, $attributes );
    }
    
    public function addEditMemberFonctionality($part) {
        if (($editMemberParams = $this->getEditMemberParams ()) !== false) {
            if (isset ( $editMemberParams [$part] )) {
                $params = $editMemberParams [$part];
                $params->compile ( $this->controller->_getBaseRoute (), $this->jquery, $part );
            }
        }
    }
    
    public function recordsPerPage($model, $totalCount = 0) {
        if ($totalCount > 6) {
            return 6;
        }
        return;
    }
    
    public function getGroupByFields() {
        return;
    }
    
    protected function getDataTableInstance($instances, $model, $totalCount, $page = 1): DataTable {
        $dtId = $this->getDataTableId ();
        $semantic = $this->jquery->semantic ();
        $recordsPerPage = $this->recordsPerPage ( $model, $totalCount );
        if (\is_numeric ( $recordsPerPage )) {
            $grpByFields = $this->getGroupByFields ();
            if (\is_array ( $grpByFields )) {
                $dataTable = $semantic->dataTable ( $dtId, $model, $instances );
                $dataTable->setGroupByFields ( $grpByFields );
            } else {
                $dataTable = $semantic->jsonDataTable ( $dtId, $model, $instances );
            }
            $dataTable->paginate ( $page, $totalCount, $recordsPerPage, 5 );
            $dataTable->onSearchTerminate ( '$("#search-query-content").html(data);$("#search-query").show();$("#table-details").html("");' );
        } else {
            $dataTable = $semantic->dataTable ( $dtId, $model, $instances );
        }
        $dataTable->setLibraryId ( 'lv' );
        return $dataTable;
    }
    
    protected function getDataTableRowButtons(): array {
        return [ 'edit','delete' ];
    }
    
    public function addAllButtons(DataTable $dataTable, $attributes) {
        $transition = $this->getTransition ();
        $dataTable->onPreCompile ( function () use (&$dataTable) {
            $dataTable->getHtmlComponent ()->colRightFromRight ( 0 );
            $tb = $dataTable->getPaginationToolbar ();
            if (isset ( $tb )) {
                $tb->addClass ( $this->style );
            }
        } );
            $dataTable->addAllButtons ( false, [ 'ajaxTransition' => $transition,'hasLoader' => 'internal' ], function ($bt) {
                $bt->addClass ( 'circular ' . $this->style );
                $this->onDataTableRowButton ( $bt ,'display');
            }, function ($bt) {
                $bt->addClass ( 'circular ' . $this->style );
                $this->onDataTableRowButton ( $bt ,'edit');
            }, function ($bt) {
                $bt->addClass ( 'circular ' . $this->style );
                $this->onDataTableRowButton ( $bt ,'delete');
            } );
                $buttons=\array_diff($this->getDataTableRowButtons(),['edit','display','delete']);
                foreach ($buttons as $bt){
                    $attr=JString::cleanIdentifier($bt);
                    $dataTable->insertDefaultButtonIn($dataTable->getButtonsColumn(),$bt,"_$attr circular basic",false,function($b) use($attr){
                        $b->addClass ( $this->style );
                        $this->onDataTableRowButton ( $b,$attr );
                    },$bt);
                }
                $dataTable->setDisplayBehavior ( [ 'jsCallback' => '$("#dataTable").hide();','ajaxTransition' => $transition,'hasLoader' => 'internal' ] );
    }
    
    public function getTransition(): string {
        return 'fade';
    }
    
    public function getDataTableId(): string {
        return 'lv';
    }
    
    public function onDataTableRowButton(HtmlButton $bt,?string $name=null) {
    }
    
    public function onConfirmButtons(HtmlButton $confirmBtn, HtmlButton $cancelBtn) {
    }
    
    public function getCaptions($captions, $className):array {
        return \array_map ( 'ucfirst', $captions );
    }
    
    public function getFkHeaderElementDetails($member, $className, $object) {
        $res = new HtmlHeader ( '', 4, $member, 'content' );
        return $res->addClass ( $this->style );
    }
    
    public function getFkHeaderListDetails($member, $className, $list) {
        $res = new HtmlHeader ( '', 4, $member . ' (' . \count ( $list ) . ')', 'content' );
        return $res->addClass ( $this->style );
    }
    
    public function getFkElementDetails($member, $className, $object) {
        $res = $this->jquery->semantic ()->htmlLabel ( 'element-' . $className . '.' . $member, $object . '' );
        return $res->addClass ( $this->style );
    }
    
    public function getFkListDetails($member, $className, $list) {
        $element = $this->jquery->semantic ()->htmlList ( 'list-' . $className . '.' . $member );
        $element->setMaxVisible ( 15 );
        
        return $element->addClass ( 'animated divided celled ' . $this->style );
    }
    
    public function getFkMemberElementDetails($memberFK, $objectFK, $fkClass, $fkTable) {
        $_fkClass = str_replace ( "\\", ".", $fkClass );
        $header = new HtmlHeader ( "", 4, $memberFK, "content" );
        if (is_array ( $objectFK ) || $objectFK instanceof \Traversable) {
            $header = $this->getFkHeaderListDetails ( $memberFK, $fkClass, $objectFK );
            $element = $this->getFkListDetails ( $memberFK, $fkClass, $objectFK );
            foreach ( $objectFK as $oItem ) {
                if (method_exists ( $oItem, "__toString" )) {
                    $id = (CRUDHelper::getIdentifierFunction ( $fkClass )) ( 0, $oItem );
                    $item = $element->addItem ( $oItem . "" );
                    $item->setProperty ( "data-ajax", $_fkClass . "||" . $id );
                    $item->addClass ( "showTable" );
                    $this->onDisplayFkElementListDetails ( $item, $memberFK, $fkClass, $oItem );
                }
            }
        } else {
            if (method_exists ( $objectFK, "__toString" )) {
                $header = $this->getFkHeaderElementDetails ( $memberFK, $fkClass, $objectFK );
                $id = (CRUDHelper::getIdentifierFunction ( $fkClass )) ( 0, $objectFK );
                $element = $this->getFkElementDetails ( $memberFK, $fkClass, $objectFK );
                $element->setProperty ( "data-ajax", $_fkClass . "||" . $id )->addClass ( "showTable" );
            }
        }
        if (isset ( $element )) {
            return [ $header,$element ];
        }
        return null;
    }
    
    public function onDisplayFkElementListDetails($element, $member, $className, $object) {
    }
    
    public function getFkMemberElement($memberFK, $objectFK, $fkClass, $fkTable) {
        $element = "";
        $_fkClass = str_replace ( "\\", ".", $fkClass );
        if (is_array ( $objectFK ) || $objectFK instanceof \Traversable) {
            $element = $this->getFkList ( $memberFK, $objectFK );
            foreach ( $objectFK as $oItem ) {
                if (\method_exists ( $oItem, '__toString' )) {
                    $id = (CRUDHelper::getIdentifierFunction ( $fkClass )) ( 0, $oItem );
                    $item = $element->addItem ( $oItem . '' );
                    $item->setProperty ( 'data-ajax', $_fkClass . '||' . $id );
                    $item->addClass ( 'showTable' );
                    $this->displayFkElementList ( $item, $memberFK, $fkClass, $oItem );
                }
            }
        } else {
            if (method_exists ( $objectFK, '__toString' )) {
                $id = (CRUDHelper::getIdentifierFunction ( $fkClass )) ( 0, $objectFK );
                $element = $this->getFkElement ( $memberFK, $fkClass, $objectFK );
                $element->setProperty ( 'data-ajax', $_fkClass . '||' . $id )->addClass ( 'showTable' );
            }
        }
        return $element;
    }
    
    public function getFkList($member, $list) {
        $element = $this->jquery->semantic ()->htmlList ( 'list-' . $member );
        $element->setMaxVisible ( 10 );
        return $element->addClass ( 'animated' );
    }
    
    public function displayFkElementList($element, $member, $className, $object) {
    }
    
    public function getFkElement($member, $className, $object) {
        $res = $this->jquery->semantic ()->htmlLabel ( 'element-' . $className . '.' . $member, $object . '' );
        return $res->addClass ( $this->style );
    }
    
    public function showDetailsOnDataTableClick(): bool {
        return true;
    }
}