Class.Mask.php

Go to the documentation of this file.

<?php
/*
 * @author Anakeen
 * @package FDL
*/
/**
 * Mask document
 *
 */
namespace Dcp\Core;
use \Dcp\AttributeIdentifiers\Mask as myAttr;
class Mask extends \Dcp\Family\Base
{
    
    var $defaultedit = "FREEDOM:EDITMASK";
    var $defaultview = "FREEDOM:VIEWMASK";
    
    function getLabelVis()
    {
        return array(
            "-" => " ",
            "R" => _("read only") ,
            "W" => _("read write") ,
            "O" => _("write only") ,
            "H" => _("hidden") ,
            "S" => _("read disabled") ,
            "U" => _("static array") ,
            "I" => _("invisible")
        );
    }
    function getLabelNeed()
    {
        return array(
            "-" => " ",
            "Y" => _("Y") ,
            "N" => _("N")
        );
    }
    /**
     * suppress unmodified attributes visibilities
     * to simplify the mask structure
     */
    function postStore()
    {
        $tneed = $this->getMultipleRawValues("MSK_NEEDEEDS");
        $tattrid = $this->getMultipleRawValues("MSK_ATTRIDS");
        $tvis = $this->getMultipleRawValues("MSK_VISIBILITIES");
        
        foreach ($tattrid as $k => $v) {
            if (($tneed[$k] === '-') && ($tvis[$k] === '-') || ($tneed[$k] === '') && ($tvis[$k] === '-')) {
                unset($tneed[$k]);
                unset($tvis[$k]);
                unset($tattrid[$k]);
            }
        }
        $this->setValue("MSK_NEEDEEDS", $tneed);
        $this->setValue("MSK_ATTRIDS", $tattrid);
        $this->setValue("MSK_VISIBILITIES", $tvis);
        
        return '';
    }
    
    public function preImport(array $extra = array())
    {
        return $this->verifyIntegraty();
    }
    public function preRefresh()
    {
        return $this->verifyIntegraty();
    }
    /**
     * Verify if family and attributes are coherents
     * @return string error message
     */
    protected function verifyIntegraty()
    {
        $mskAttrids = $this->getMultipleRawValues(myAttr::msk_attrids);
        $famid = $this->getRawValue(myAttr::msk_famid);
        if (!$famid) {
            return \ErrorCode::getError("MSK0001", $this->name);
        }
        $fam = new_doc($this->dbaccess, $famid);
        if ($fam->doctype !== "C") {
            return \ErrorCode::getError("MSK0002", $famid, $this->name);
        }
        $attributes = $fam->getAttributes();
        $attrids = [];
        foreach ($attributes as $attribute) {
            if ($attribute->usefor !== "Q") {
                $attrids[] = $attribute->id;
            }
        }
        foreach ($mskAttrids as $mAttrid) {
            if ($mAttrid && !in_array($mAttrid, $attrids)) {
                
                return \ErrorCode::getError("MSK0003", $mAttrid, $fam->name, $this->name);
            }
        }
        return "";
    }
    
    function getVisibilities()
    {
        $tvisid = $this->getMultipleRawValues("MSK_VISIBILITIES");
        $tattrid = $this->getMultipleRawValues("MSK_ATTRIDS");
        
        $tvisibilities = array();
        foreach ($tattrid as $k => $v) {
            if ($tvisid[$k] !== "-") {
                $tvisibilities[$v] = $tvisid[$k];
            }
        }
        return $tvisibilities;
    }
    
    function getNeedeeds()
    {
        $tvisid = $this->getMultipleRawValues("MSK_NEEDEEDS");
        $tattrid = $this->getMultipleRawValues("MSK_ATTRIDS");
        
        $tvisibilities = array();
        foreach ($tattrid as $k => $v) {
            $tvisibilities[$v] = $tvisid[$k];
        }
        return $tvisibilities;
    }
    /**
     * @templateController view attributes differences
     * @param string $target
     * @param bool $ulink
     * @param bool $abstract
     */
    function viewmask($target = "_self", $ulink = true, $abstract = false)
    {
        
        $docid = $this->getRawValue("MSK_FAMID", 1);
        
        $tvisibilities = $this->getVisibilities();
        $tkey_visibilities = array_keys($tvisibilities);
        
        $tneedeeds = $this->getNeedeeds();
        
        $this->lay->Set("docid", $docid);
        
        $doc = new_Doc($this->dbaccess, $docid);
        if (!$doc->isAlive()) {
            addWarningMsg(sprintf("Family %s not found", $docid));
            return;
        }
        $doc->applyMask();
        $origattr = $doc->attributes->attr;
        
        $tmpdoc = createTmpDoc($this->dbaccess, $docid);
        $tmpdoc->applyMask($this->id);
        // display current values
        $tmask = array();
        
        $labelvis = $this->getLabelVis();
        $tmpdoc->attributes->orderAttributes();
        
        foreach ($tmpdoc->attributes->attr as $k => $attr) {
            /**
             * @var $attr \NormalAttribute|\ActionAttribute
             */
            if (!$attr->visibility) continue;
            if ($attr->usefor == 'Q') continue;
            $tmask[$k]["attrname"] = $attr->getLabel();
            $tmask[$k]["type"] = $attr->type;
            $tmask[$k]["attrid"] = $attr->id;
            $tmask[$k]["visibility"] = $labelvis[$attr->visibility];
            $tmask[$k]["wneed"] = (!empty($origattr[$k]->needed)) ? ___("mandatory", "mask") : ___("optional", "mask");
            $tmask[$k]["bgcolor"] = "inherits";
            $tmask[$k]["isNeed"] = (!empty($origattr[$k]->needed));
            $tmask[$k]["mvisibility"] = $labelvis[$attr->mvisibility];
            $tmask[$k]["classtype"] = strtok($attr->type, '(');
            
            if (in_array($k, $tkey_visibilities)) {
                $tmask[$k]["classtype"].= " directmodified";
            } elseif ($tmask[$k]["visibility"] != $tmask[$k]["mvisibility"]) {
                if ($tmask[$k]["mvisibility"] != $labelvis[$origattr[$k]->mvisibility]) $tmask[$k]["classtype"].= " inheritmodified";
            } else {
                $tmask[$k]["classtype"].= " notmodified";
            }
            $tmask[$k]["isAneed"] = $tmask[$k]["isNeed"];
            if (isset($tneedeeds[$attr->id])) {
                if (($tneedeeds[$attr->id] == "Y") || (($tneedeeds[$attr->id] == "-") && (!empty($attr->needed)))) {
                    $tmask[$k]["waneed"] = ___("mandatory", "mask");
                    $tmask[$k]["isAneed"] = true;
                } else {
                    $tmask[$k]["waneed"] = ___("optional", "mask");
                    $tmask[$k]["isAneed"] = false;
                }
            } else {
                $tmask[$k]["waneed"] = $tmask[$k]["wneed"];
            }
            
            if (in_array($attr->type, array(
                "frame",
                "tab",
                "menu",
                "action",
                "array"
            ))) {
                $tmask[$k]["waneed"] = $tmask[$k]["wneed"] = '';
            }
            
            if ($tmask[$k]["wneed"] != $tmask[$k]["waneed"]) {
                $tmask[$k]["classtype"].= " needmodified";
            }
            
            if ($attr->fieldSet && $attr->fieldSet->id && $attr->fieldSet->id != \Adoc::HIDDENFIELD) $tmask[$k]["framelabel"] = $attr->fieldSet->getLabel();
            else $tmask[$k]["framelabel"] = "";
            if (!empty($attr->waction)) $tmask[$k]["framelabel"] = _("Action");
            
            $tmask[$k]["displayorder"] = ($attr->ordered) ? $attr->ordered : -2;
            if ($attr->type == "menu" || $attr->type == "action") $tmask[$k]["displayorder"]+= 1000000; // at then end
            if (($attr->ordered > 0) && $attr->fieldSet && $attr->fieldSet->id && $attr->fieldSet->ordered < - 1) {
                $attr->fieldSet->ordered = $attr->ordered - 1;
                $tmask[$attr->fieldSet->id]["displayorder"] = $attr->ordered - 1;
                if ($attr->fieldSet->fieldSet && $attr->fieldSet->fieldSet->id) {
                    if ($attr->fieldSet->fieldSet->ordered < - 1) {
                        $attr->fieldSet->fieldSet->ordered = $attr->fieldSet->ordered - 1;
                        $tmask[$attr->fieldSet->fieldSet->id]["displayorder"] = $attr->fieldSet->ordered - 1;
                    }
                }
            }
        }
        unset($tmask[\Adoc::HIDDENFIELD]);
        uasort($tmask, array(
            get_class($this) ,
            'sortnewelem'
        ));
        $this->lay->SetBlockData("MASK", $tmask);
    }
    /**
     * @templateController special edition for mask
     */
    function editmask()
    {
        
        $docid = $this->getRawValue("MSK_FAMID");
        
        $this->lay->Set("docid", $docid);
        /**
         * @var \DocFam $family
         */
        $family = new_Doc($this->dbaccess, $docid);
        
        $tvisibilities = $this->getVisibilities();
        $tneedeeds = $this->getNeedeeds();
        
        if ($docid == 0) {
            // only choose family in creation
            $selectclass = array();
            $tclassdoc = GetClassesDoc($this->dbaccess, $this->userid, 0, "TABLE");
            foreach ($tclassdoc as $k => $cdoc) {
                $selectclass[$k]["idcdoc"] = $cdoc["id"];
                $selectclass[$k]["classname"] = $cdoc["title"];
                $selectclass[$k]["selected"] = "";
            }
            
            $this->lay->SetBlockData("SELECTCLASS", $selectclass);
        }
        // display current values
        $newelem = array();
        $this->lay->set("creation", ($docid == 0));
        $this->lay->set("family", $family->getTitle());
        
        if ($docid > 0) {
            $ka = 0; // index attribute
            $labelvis = $this->getLabelVis();
            foreach ($labelvis as $k => $v) {
                $selectvis[] = array(
                    "visid" => $k,
                    "vislabel" => $v
                );
            }
            $labelneed = $this->getLabelNeed();
            foreach ($labelneed as $k => $v) {
                $selectneed[] = array(
                    "needid" => $k,
                    "needlabel" => $v
                );
            }
            //    ------------------------------------------
            //  -------------------- NORMAL ----------------------
            $tattr = $family->getAttributes();
            
            foreach ($tattr as $k => $attr) {
                /**
                 * @var $attr \NormalAttribute|\FieldSetAttribute|\ActionAttribute
                 */
                if ($attr->usefor == "Q") continue; // not parameters
                if ($attr->docid == 0) continue; // not parameters
                $newelem[$k]["attrid"] = $attr->id;
                $newelem[$k]["attrname"] = $attr->getLabel();
                $newelem[$k]["type"] = strtok($attr->type, '(');
                $newelem[$k]["visibility"] = $labelvis[$attr->visibility];
                
                $newelem[$k]["wneed"] = (!empty($attr->needed)) ? ___("mandatory", "mask") : ___("optional", "mask");
                $newelem[$k]["isNeed"] = (!empty($attr->needed));
                $newelem[$k]["neweltid"] = $k;
                $newelem[$k]["attrinfo"] = $attr->id;
                $newelem[$k]["useNeed"] = (!in_array($attr->type, array(
                    "frame",
                    "tab",
                    "menu",
                    "action",
                    "array"
                )));
                
                if ($attr->fieldSet && $attr->fieldSet->id && $attr->fieldSet->id != \Adoc::HIDDENFIELD) {
                    $newelem[$k]["attrinfo"].= '/' . $attr->fieldSet->id;
                    if ($attr->fieldSet->fieldSet->id && $attr->fieldSet->fieldSet->id != \Adoc::HIDDENFIELD) $newelem[$k]["attrinfo"].= '/' . $attr->fieldSet->fieldSet->id;
                }
                
                if (($attr->type == "array") || (strtolower(get_class($attr)) == "fieldsetattribute")) $newelem[$k]["fieldweight"] = "bold";
                else $newelem[$k]["fieldweight"] = "";
                
                if ($attr->docid == $docid) {
                    $newelem[$k]["disabled"] = "";
                } else {
                    $newelem[$k]["disabled"] = "disabled";
                }
                
                if ($attr->fieldSet && $attr->fieldSet->docid > 0) $newelem[$k]["framelabel"] = $attr->fieldSet->getLabel();
                else $newelem[$k]["framelabel"] = "";
                if (!empty($attr->waction)) $newelem[$k]["framelabel"] = _("Action");
                
                reset($selectvis);
                foreach ($selectvis as $kopt => $opt) {
                    if (isset($tvisibilities[$attr->id]) && $opt["visid"] == $tvisibilities[$attr->id]) {
                        $selectvis[$kopt]["selected"] = "selected";
                    } else {
                        $selectvis[$kopt]["selected"] = "";
                    }
                }
                // idem for needed
                reset($selectneed);
                foreach ($selectneed as $kopt => $opt) {
                    if (isset($tneedeeds[$attr->id]) && $opt["needid"] == $tneedeeds[$attr->id]) {
                        $selectneed[$kopt]["selectedneed"] = "selected";
                    } else {
                        $selectneed[$kopt]["selectedneed"] = "";
                    }
                }
                $newelem[$k]["displayorder"] = ($attr->ordered) ? $attr->ordered : -2;
                if ($attr->type == "menu" || $attr->type == "action") $newelem[$k]["displayorder"]+= 1000000; // at then end
                if (($attr->ordered > 0) && $attr->fieldSet && $attr->fieldSet->id && $attr->fieldSet->ordered < - 1) {
                    $attr->fieldSet->ordered = $attr->ordered - 1;
                    $newelem[$attr->fieldSet->id]["displayorder"] = $attr->ordered - 1;
                    if ($attr->fieldSet->fieldSet && $attr->fieldSet->fieldSet->id) {
                        if ($attr->fieldSet->fieldSet->ordered < - 1) {
                            $attr->fieldSet->fieldSet->ordered = $attr->fieldSet->ordered - 1;
                            $newelem[$attr->fieldSet->fieldSet->id]["displayorder"] = $attr->fieldSet->ordered - 1;
                        }
                    }
                }
                $newelem[$k]["SELECTVIS"] = "SELECTVIS_$k";
                $this->lay->SetBlockData($newelem[$k]["SELECTVIS"], $selectvis);
                $newelem[$k]["SELECTNEED"] = "SELECTNEED_$k";
                $this->lay->SetBlockData($newelem[$k]["SELECTNEED"], $selectneed);
                
                $ka++;
            }
            unset($newelem[\Adoc::HIDDENFIELD]);
            uasort($newelem, array(
                get_class($this) ,
                'sortnewelem'
            ));
            $this->lay->SetBlockData("NEWELEM", $newelem);
        }
        $this->editattr(false);
    }
    /**
     * use to usort attributes
     * @param \BasicAttribute $a
     * @param \BasicAttribute $b
     * @return int
     */
    static function sortnewelem($a, $b)
    {
        if (isset($a["displayorder"]) && isset($b["displayorder"])) {
            if ($a["displayorder"] == $b["displayorder"]) return 0;
            if ($a["displayorder"] > $b["displayorder"]) return 1;
            return -1;
        }
        if (isset($a["displayorder"])) return 1;
        if (isset($b["displayorder"])) return -1;
        return 0;
    }
}