1: <?php
  2: 
  3: /**
  4:  * This file contains the layout 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:  * Layout collection
 19:  *
 20:  * @package Core
 21:  * @subpackage GenericDB_Model
 22:  */
 23: class cApiLayoutCollection extends ItemCollection {
 24: 
 25:     /**
 26:      * Constructor
 27:      */
 28:     public function __construct() {
 29:         global $cfg;
 30:         parent::__construct($cfg['tab']['lay'], 'idlay');
 31:         $this->_setItemClass('cApiLayout');
 32: 
 33:         // set the join partners so that joins can be used via link() method
 34:         $this->_setJoinPartner('cApiClientCollection');
 35:     }
 36: 
 37:     /**
 38:      * Creates a layout entry.
 39:      *
 40:      * @param string $name
 41:      * @param int $idclient [optional]
 42:      * @param string $alias [optional]
 43:      * @param string $description [optional]
 44:      * @param int $deletable [optional]
 45:      *         Either 1 or 0
 46:      * @param string $author [optional]
 47:      * @param string $created [optional]
 48:      * @param string $lastmodified [optional]
 49:      * @return cApiLayout
 50:      */
 51:     public function create($name, $idclient = NULL, $alias = '', $description = '', $deletable = 1, $author = '', $created = '', $lastmodified = '') {
 52:         global $client, $auth;
 53: 
 54:         if (NULL === $idclient) {
 55:             $idclient = $client;
 56:         }
 57: 
 58:         if (empty($alias)) {
 59:             $alias = strtolower(cString::cleanURLCharacters(i18n("-- New layout --")));
 60:         }
 61: 
 62:         if (empty($author)) {
 63:             $author = $auth->auth['uname'];
 64:         }
 65:         if (empty($created)) {
 66:             $created = date('Y-m-d H:i:s');
 67:         }
 68:         if (empty($lastmodified)) {
 69:             $lastmodified = date('Y-m-d H:i:s');
 70:         }
 71: 
 72:         $item = $this->createNewItem();
 73:         $item->set('idclient', $idclient);
 74:         $item->set('name', $name);
 75:         $item->set('alias', $alias);
 76:         $item->set('description', $description);
 77:         $item->set('deletable', $deletable);
 78:         $item->set('author', $author);
 79:         $item->set('created', $created);
 80:         $item->set('lastmodified', $lastmodified);
 81:         $item->store();
 82: 
 83:         return $item;
 84:     }
 85: 
 86: }
 87: 
 88: /**
 89:  * Layout item
 90:  *
 91:  * @package Core
 92:  * @subpackage GenericDB_Model
 93:  */
 94: class cApiLayout extends Item {
 95: 
 96:     /**
 97:      * List of templates being used by current layout
 98:      *
 99:      * @var array
100:      */
101:     protected $_aUsedTemplates = array();
102: 
103:     /**
104:      * Constructor Function
105:      *
106:      * @param mixed $mId [optional]
107:      *         Specifies the ID of item to load
108:      */
109:     public function __construct($mId = false) {
110:         global $cfg;
111:         parent::__construct($cfg['tab']['lay'], 'idlay');
112:         $this->setFilters(array(), array());
113:         if ($mId !== false) {
114:             $this->loadByPrimaryKey($mId);
115:         }
116:     }
117: 
118:     /**
119:      * Checks if the layout is in use in any templates.
120:      *
121:      * @throws cException
122:      *         If layout item has not been loaded before
123:      * @param bool $setData [optional]
124:      *         Flag to set used templates data structure
125:      * @return bool
126:      */
127:     public function isInUse($setData = false) {
128:         if (!$this->isLoaded()) {
129:             throw new cException('Layout item not loaded!');
130:         }
131: 
132:         $oTplColl = new cApiTemplateCollection();
133:         $templates = $oTplColl->fetchByIdLay($this->get('idlay'));
134:         if (0 === count($templates)) {
135:             return false;
136:         }
137: 
138:         if ($setData === true) {
139:             $this->_aUsedTemplates = array();
140:             foreach ($templates as $i => $template) {
141:                 $this->_aUsedTemplates[$i] = array(
142:                     'tpl_id' => $template->get('idtpl'),
143:                     'tpl_name' => $template->get('name')
144:                 );
145:             }
146:         }
147: 
148:         return true;
149:     }
150: 
151:     /**
152:      * Get the informations of used templates
153:      *
154:      * @return array
155:      *         template data
156:      */
157:     public function getUsedTemplates() {
158:         return $this->_aUsedTemplates;
159:     }
160: 
161:     /**
162:      * Userdefined setter for layout fields.
163:      *
164:      * @param string $name
165:      * @param mixed $value
166:      * @param bool $bSafe [optional]
167:      *         Flag to run defined inFilter on passed value
168:      * @return bool
169:      */
170:     public function setField($name, $value, $bSafe = true) {
171:         switch ($name) {
172:             case 'deletable':
173:                 $value = ($value == 1) ? 1 : 0;
174:                 break;
175:             case 'idclient':
176:                 $value = (int) $value;
177:                 break;
178:         }
179: 
180:         return parent::setField($name, $value, $bSafe);
181:     }
182: 
183: }
184: