1: <?php
  2: 
  3: /**
  4:  * This file contains the template collection and item class.
  5:  *
  6:  * @package Core
  7:  * @subpackage GenericDB_Model
  8:  * @author Timo Hummel
  9:  * @copyright four for business AG <www.4fb.de>
 10:  * @license http://www.contenido.org/license/LIZENZ.txt
 11:  * @link http://www.4fb.de
 12:  * @link http://www.contenido.org
 13:  */
 14: 
 15: defined('CON_FRAMEWORK') || die('Illegal call: Missing framework initialization - request aborted.');
 16: 
 17: /**
 18:  * Template collection
 19:  *
 20:  * @package Core
 21:  * @subpackage GenericDB_Model
 22:  */
 23: class cApiTemplateCollection extends ItemCollection {
 24: 
 25:     /**
 26:      * Create a new collection of items.
 27:      *
 28:      * @param string $select [optional]
 29:      *         where clause to use for selection (see ItemCollection::select())
 30:      */
 31:     public function __construct($select = false) {
 32:         global $cfg;
 33:         parent::__construct($cfg['tab']['tpl'], 'idtpl');
 34:         $this->_setItemClass('cApiTemplate');
 35: 
 36:         // set the join partners so that joins can be used via link() method
 37:         $this->_setJoinPartner('cApiLayoutCollection');
 38:         $this->_setJoinPartner('cApiTemplateCollection');
 39:         $this->_setJoinPartner('cApiTemplateConfigurationCollection');
 40: 
 41:         if ($select !== false) {
 42:             $this->select($select);
 43:         }
 44:     }
 45: 
 46:     /**
 47:      * Creates a template entry.
 48:      *
 49:      * @param int $idclient
 50:      * @param int $idlay
 51:      * @param int $idtplcfg
 52:      *         Either a valid template configuration id or an empty string
 53:      * @param string $name
 54:      * @param string $description
 55:      * @param int $deletable [optional]
 56:      * @param int $status [optional]
 57:      * @param int $defaulttemplate [optional]
 58:      * @param string $author [optional]
 59:      * @param string $created [optional]
 60:      * @param string $lastmodified [optional]
 61:      * @return cApiTemplate
 62:      */
 63:     public function create($idclient, $idlay, $idtplcfg, $name, $description,
 64:             $deletable = 1, $status = 0, $defaulttemplate = 0, $author = '',
 65:             $created = '', $lastmodified = '') {
 66:         if (empty($author)) {
 67:             $auth = cRegistry::getAuth();
 68:             $author = $auth->auth['uname'];
 69:         }
 70:         if (empty($created)) {
 71:             $created = date('Y-m-d H:i:s');
 72:         }
 73:         if (empty($lastmodified)) {
 74:             $lastmodified = date('Y-m-d H:i:s');
 75:         }
 76: 
 77:         $oItem = $this->createNewItem();
 78: 
 79:         $oItem->set('idclient', $idclient);
 80:         $oItem->set('idlay', $idlay);
 81:         $oItem->set('idtplcfg', $idtplcfg);
 82:         $oItem->set('name', $name);
 83:         $oItem->set('description', $description);
 84:         $oItem->set('deletable', $deletable);
 85:         $oItem->set('status', $status);
 86:         $oItem->set('defaulttemplate', $defaulttemplate);
 87:         $oItem->set('author', $author);
 88:         $oItem->set('created', $created);
 89:         $oItem->set('lastmodified', $lastmodified);
 90:         $oItem->store();
 91: 
 92:         return $oItem;
 93:     }
 94: 
 95:     /**
 96:      * Returns the default template configuration item
 97:      *
 98:      * @param int $idclient
 99:      * @return cApiTemplateConfiguration|NULL
100:      */
101:     public function selectDefaultTemplate($idclient) {
102:         $this->select('defaulttemplate = 1 AND idclient = ' . (int) $idclient);
103:         return $this->next();
104:     }
105: 
106:     /**
107:      * Returns all templates having passed layout id.
108:      *
109:      * @param int $idlay
110:      * @return array
111:      */
112:     public function fetchByIdLay($idlay) {
113:         $this->select('idlay = ' . (int) $idlay);
114:         $entries = array();
115:         while (($entry = $this->next()) !== false) {
116:             $entries[] = clone $entry;
117:         }
118:         return $entries;
119:     }
120: }
121: 
122: /**
123:  * Template item
124:  *
125:  * @package Core
126:  * @subpackage GenericDB_Model
127:  */
128: class cApiTemplate extends Item {
129: 
130:     /**
131:      * Constructor Function
132:      *
133:      * @param mixed $mId [optional]
134:      *         Specifies the ID of item to load
135:      */
136:     public function __construct($mId = false) {
137:         global $cfg;
138:         parent::__construct($cfg['tab']['tpl'], 'idtpl');
139:         $this->setFilters(array(), array());
140:         if ($mId !== false) {
141:             $this->loadByPrimaryKey($mId);
142:         }
143:     }
144: 
145:     /**
146:      * Load a template based on article, category, language and client id
147:      *
148:      * @todo avoid returning void
149:      * @param int $idart
150:      *         article id
151:      * @param int $idcat
152:      *         category id
153:      * @param int $lang
154:      *         language id
155:      * @param int $client
156:      *         client id
157:      * @return void|bool
158:      */
159:     public function loadByArticleOrCategory($idart, $idcat, $lang, $client) {
160: 
161:         // get ID of template configuration that is used for
162:         // either the article language or the category language
163:         $idtplcfg = conGetTemplateConfigurationIdForArticle($idart, $idcat, $lang, $client);
164:         if (!is_numeric($idtplcfg) || $idtplcfg == 0) {
165:             $idtplcfg = conGetTemplateConfigurationIdForCategory($idcat, $lang, $client);
166:         }
167:         if (is_null($idtplcfg)) {
168:             return false;
169:         }
170: 
171:         // load template configuration to get its template ID
172:         $templateConfiguration = new cApiTemplateConfiguration($idtplcfg);
173:         if (!$templateConfiguration->isLoaded()) {
174:             return;
175:         }
176: 
177:         // try to load template by determined ID
178:         $idtpl = $templateConfiguration->get('idtpl');
179:         $this->loadByPrimaryKey($idtpl);
180:     }
181: 
182:     /**
183:      * Userdefined setter for template fields.
184:      *
185:      * @todo should return return value of overloaded method
186:      * @param string $name
187:      * @param mixed $value
188:      * @param bool $bSafe [optional]
189:      *         Flag to run defined inFilter on passed value
190:      */
191:     public function setField($name, $value, $bSafe = true) {
192:         switch ($name) {
193:             case 'deletable':
194:             case 'status':
195:             case 'defaulttemplate':
196:                 $value = ($value == 1) ? 1 : 0;
197:                 break;
198:             case 'idclient':
199:             case 'idlay':
200:                 $value = (int) $value;
201:                 break;
202:             case 'idtplcfg':
203:                 if (!is_numeric($value)) {
204:                     $value = '';
205:                 }
206:                 break;
207:         }
208: 
209:         parent::setField($name, $value, $bSafe);
210:     }
211: 
212: }
213: