system/modules/pct_customelements/PCT/CustomElements/Attributes/Files/Files.php line 47

Open in your IDE?
  1. <?php
  3. /**
  4.  * Contao Open Source CMS
  5.  * 
  6.  * Copyright (C) 2005-2013 Leo Feyer
  7.  * 
  8.  * @copyright    Tim Gatzky 2013, Premium Contao Webworks, Premium Contao Themes
  9.  * @author        Tim Gatzky <info@tim-gatzky.de>
  10.  * @package        pct_customelements
  11.  * @attribute    AttributeFiles
  12.  * @link        http://contao.org
  13.  */
  15. /**
  16.  * Namespace
  17.  */
  18. namespace PCT\CustomElements\Attributes;
  21. /**
  22.  * Imports
  23.  */
  24. use Contao\FilesModel;
  25. use Contao\StringUtil;
  26. use PCT\CustomElements\Core\Attribute as Attribute;
  27. use PCT\CustomElements\Helper\ControllerHelper as ControllerHelper;
  30. /**
  31.  * Class file
  32.  * Files
  33.  */
  34. class Files extends Attribute
  35. {
  36.     /**
  37.      * Tell the vault to store how to save the data (binary,blob)
  38.      * Leave empty to varchar
  39.      * @var boolean
  40.      */
  41.     protected $saveDataAs = '';
  42.         
  43.     /**
  44.      * Create new instance
  45.      * @param array
  46.      */ 
  47.     public function __construct($arrData=array())
  48.     {
  49.         if(count($arrData) > 0)
  50.         {
  51.             $this->setData($arrData);
  52.         }
  53.         
  54.         if($this->get('eval_multiple'))
  55.         {
  56.             $this->saveDataAs = 'blob';
  57.         }
  58.     }    
  60.     /**
  61.      * Return the field definition
  62.      * @return array
  63.      */
  64.     public function getFieldDefinition()
  65.     {
  66.         $arrEval = $this->getEval();
  67.         
  68.         $arrEval['fieldType'] ='radio';
  69.         if( isset($arrEval['multiple']) && $arrEval['multiple'])
  70.         {
  71.             $arrEval['fieldType'] ='checkbox';
  72.         }
  73.         
  74.         // toggle show files only or folders only
  75.         $arrEval['files'] = $this->get('eval_files') ? 0 : 1;
  76.         
  77.         if($this->get('isDownload'))
  78.         {
  79.             $arrEval['isDownloads'] = true;
  80.         
  81.             // restricted file types
  82.             if(!$this->get('eval_extensions'))
  83.             {
  84.                 $arrEval['extensions'] = $GLOBALS['TL_CONFIG']['allowedDownload'];
  85.             }
  86.         }
  87.         
  88.         $arrReturn = array
  89.         (
  90.             'label'            => array( $this->get('title'),$this->get('description') ),
  91.             'exclude'        => true,
  92.             'inputType'        => 'fileTree',
  93.             'eval'            => $arrEval,
  94.             'sql'            => "binary(16) NULL",
  95.         );
  96.         
  97.         if($this->get('eval_multiple'))
  98.         {
  99.             $arrReturn['sql'] = "blob NULL";
  100.         }
  101.         
  102.         // make attribute sortable
  103.         if($this->get('sortBy') == 'custom' && isset($arrEval['multiple']) && $arrEval['multiple'])
  104.         {
  105.             $arrReturn['sortable'] = true;
  106.         }
  107.         
  108.         return $arrReturn;
  109.     }
  112.     /**
  113.      * Parse widget callback
  114.      * Generate the widgets and add them to the child list
  115.      * Optional, return the whole compiled widget as html string
  116.      * @param object    Widget
  117.      * @param string    Name of the field
  118.      * @param array        Field definition
  119.      * @param object    DataContainer
  120.      */
  121.     public function parseWidgetCallback($objWidget,$strField,$arrFieldDef,$objDC)
  122.     {
  123.         // validate the input
  124.         $objWidget->validate();
  126.         if($objWidget->hasErrors())
  127.         {
  128.             $objWidget->class = 'error';
  129.         }
  130.         
  131.         $strBuffer = $objWidget->parse();
  132.         
  133.         // load data container and language file
  134.         ControllerHelper::callstatic('loadDataContainer',array('tl_content'));
  135.         ControllerHelper::callstatic('loadLanguageFile',array('tl_content'));
  136.         
  137.         $options = \Contao\StringUtil::deserialize($this->get('options'));
  138.         if(empty($options) || !is_array($options) || $objWidget->multiple)
  139.         {
  140.             return $strBuffer;
  141.         }
  142.         
  143.         // generate a checkbox field for the 'new window' option 
  144.         if(in_array('linkTitle', $options))
  145.         {
  146.             $strName = $strField.'_linkTitle';
  147.             $arrFieldDef = $GLOBALS['TL_DCA']['tl_content']['fields']['linkTitle'];
  148.             $arrFieldDef['eval']['tl_class'] = 'w50';
  149.             $this->prepareChildAttribute($arrFieldDef,$strName);
  150.         }
  151.         
  152.         // generate a text field for the link text option 
  153.         if(in_array('titleText', $options))
  154.         {
  155.             $strName = $strField.'_titleText';
  156.             $arrFieldDef = $GLOBALS['TL_DCA']['tl_content']['fields']['titleText'];
  157.             $arrFieldDef['eval']['tl_class'] = 'w50';
  158.             $this->prepareChildAttribute($arrFieldDef,$strName);
  159.         }
  160.         
  161.         return $strBuffer;
  162.     }
  163.     
  164.     
  165.     /**
  166.      * Render the attribute and return html
  167.      * @return array
  168.      */
  169.     public function renderCallback($strField,$varValue,$objTemplate,$objAttribute)
  170.     {
  171.         // convert to array
  172.         $varValue = StringUtil::deserialize($varValue);
  173.         if($this->get('eval_multiple') && !is_array($varValue))
  174.         {
  175.             $varValue = array_filter(explode(',', $varValue));
  176.         }
  178.         # issue: #342
  179.         if(is_array($varValue))
  180.         {
  181.             $varValue = array_filter($varValue);
  182.         }
  183.         
  184.         $objOrig = $this->getActiveRecord();
  185.         $objActiveRecord = new \Contao\ContentModel();
  186.         $objActiveRecord->mergeRow( $objOrig->row() );
  187.         $objActiveRecord->__set('strPk',$objActiveRecord->id);
  188.         $objActiveRecord->customTpl = '';
  189.         $objActiveRecord->start = '';
  190.         $objActiveRecord->stop = '';
  191.         $objActiveRecord->invisible = '';
  192.         $objActiveRecord->autogrid = 0;
  193.         $objActiveRecord->cssID = $objAttribute->get('cssID');
  194.         $objActiveRecord->isCustomElement = true;
  195.         $objActiveRecord->headline = '';
  196.         $objActiveRecord->inline = $objAttribute->get('inline');
  198.         // a non ce attribute template is coming in
  199.         if( \property_exists($this,'isCustomTemplate') && $this->isCustomTemplate)
  200.         {
  201.             $objActiveRecord->customTpl = $objAttribute->get('template');
  202.         }
  203.         
  204.         $objMyAttribute = null;
  205.         if($this->get('isDownload') && $this->get('eval_multiple'))
  206.         {
  207.             $objMyAttribute = new \Contao\ContentDownloads($objActiveRecord);
  208.             $objMyAttribute->multiSRC = $varValue;
  209.             $objMyAttribute->sortBy = $objAttribute->get('sortBy');
  210.             $objMyAttribute->orderSRC = $varValue;
  211.             $objMyAttribute->inline = $objAttribute->get('inline');
  213.             // respect individual ordering via record
  214.             if(isset($objActiveRecord->{'orderSRC_'.$strField}))
  215.             {
  216.                 $objMyAttribute->orderSRC = $objActiveRecord->{'orderSRC_'.$strField};
  217.             }
  218.         }
  219.         else if($this->get('isDownload') && !$this->get('eval_multiple'))
  220.         {
  221.             $arrOptionValues = $objAttribute->loadOptionValues($strField);
  222.         
  223.             $objMyAttribute = new \Contao\ContentDownload($objActiveRecord);
  224.             $objMyAttribute->singleSRC = $varValue;
  225.             $objMyAttribute->linkTitle = $arrOptionValues['linkTitle'] ?? '';
  226.             $objMyAttribute->linkText = $arrOptionValues['linkText'] ?? '';
  227.             $objMyAttribute->inline = $objAttribute->get('inline');
  229.             // handle single folders
  230.             $path = FilesModel::findByPk($varValue)->path;
  231.             if(is_dir($path))
  232.             {
  233.                 $this->set('eval_multiple',true);
  234.                 return $this->renderCallback($strField,$varValue,$objTemplate,$objAttribute);
  235.             }
  236.         }
  237.         else if(!$this->get('isDownload'))
  238.         {
  239.             $objMyAttribute = new \Contao\ContentText($objActiveRecord);
  240.             
  241.             // respect individual ordering via record
  242.             if(isset($objActiveRecord->{'orderSRC_'.$strField}))
  243.             {
  244.                 $varValue = $objActiveRecord->{'orderSRC_'.$strField};
  245.             }
  246.             
  247.             // make sure it is an array
  248.             if(!is_array($varValue))
  249.             {
  250.                 $varValue = explode(',', $varValue);
  251.             }
  252.             
  253.             $paths = array();
  254.             if(count($varValue) > 0)
  255.             {
  256.                 foreach($varValue as $v)
  257.                 {
  258.                     $file = FilesModel::findByPk($v);
  259.                     if( $file !== null )
  260.                     {
  261.                         $paths[] = FilesModel::findByPk($v)->path;
  262.                     }
  263.                 }
  264.             }
  265.             $objMyAttribute->text = implode(',', $paths);
  266.         }
  267.         // render raw
  268.         else {return '';}
  269.         
  270.         $arrCssID = \Contao\StringUtil::deserialize($this->get('cssID'));
  271.         $arrClass = array('attribute',$this->get('type'));
  272.         if(strlen($arrCssID[1]) > 0)
  273.         {
  274.             $arrClass = array_unique(array_merge($arrClass,explode(' ',$arrCssID[1])));
  275.         }
  276.         $arrCssID[1] = implode(' ',$arrClass);
  277.         $objMyAttribute->cssID = $arrCssID;
  278.         $objMyAttribute->space = array();
  279.         
  280.         // merge with object vars
  281.         foreach($objActiveRecord->row() as $k => $v)
  282.         {
  283.             if( isset($objMyAttribute->{$k}) )
  284.             {
  285.                 $objActiveRecord->{$k} = $objMyAttribute->{$k};
  286.             }
  287.         }
  288.                 
  289.         // pass to template
  290.         $objTemplate->activeRecord = clone($objActiveRecord);
  291.         $objTemplate->element = clone($objMyAttribute);
  293.         // download: remove cid parameter
  294.         if( \Contao\Input::get('file') != '' && empty($_GET['file']) === false && isset($_GET['cid']) )
  295.         {
  296.             \Contao\Input::setGet('cid',null);
  297.         }
  299.         // generate the attribute and place html in attribute template
  300.         $objTemplate->value = $objMyAttribute->generate();
  301.         
  302.         // bypass the CE attribute template when a Contao template is in use
  303.         if( \property_exists($objAttribute,'isCustomTemplate') && $objAttribute->isCustomTemplate)
  304.         {
  305.             return $objTemplate->value;
  306.         }
  307.         
  308.         return $objTemplate->parse();
  309.     }
  310.     
  311.     
  312.     /**
  313.      * Generate wildcard value
  314.      * @param mixed
  315.      * @param object    DatabaseResult
  316.      * @return string
  317.      */
  318.     public function processWildcardValue($varValue,$objAttribute)
  319.     {
  320.         if($objAttribute->get('type') != 'files' || empty($varValue))
  321.         {
  322.             return $varValue;
  323.         }
  324.         
  325.         $varValue = \Contao\StringUtil::deserialize($varValue);
  326.         
  327.         if(!is_array($varValue))
  328.         {
  329.             $varValue = array_filter( explode(',',$varValue) );
  330.         }
  331.         
  332.         $objFiles = \Contao\FilesModel::findMultipleByUuids($varValue);
  333.         
  334.         $strReturn = '';
  335.         if($objAttribute->get('isDownload'))
  336.         {
  337.             $tmp = array();
  338.             foreach($objFiles as $file)
  339.             {
  340.                 $tmp[] = '<a href="'.$file->path.'" title="'.$file->name.'" download>'.$file->path.'</a>';
  341.             }
  342.             $strReturn = implode(', ', $tmp);
  343.             unset($tmp);
  344.         }
  345.         else
  346.         {
  347.             $strReturn = implode(', ', $objFiles->fetchEach('path'));
  348.         }
  349.                 
  350.         return $strReturn;
  351.         
  352.     }
  353. }