1: <?php
  2: /**
  3:  * XOOPS Kernel Class
  4:  *
  5:  * You may not change or alter any portion of this comment or credits
  6:  * of supporting developers from this source code or any supporting source code
  7:  * which is considered copyrighted (c) material of the original comment or credit authors.
  8:  * This program is distributed in the hope that it will be useful,
  9:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
 10:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 11:  *
 12:  * @copyright       (c) 2000-2016 XOOPS Project (www.xoops.org)
 13:  * @license             GNU GPL 2 (http://www.gnu.org/licenses/gpl-2.0.html)
 14:  * @package             kernel
 15:  * @since               2.0.0
 16:  * @author              Kazumi Ono (AKA onokazu) http://www.myweb.ne.jp/, http://jp.xoops.org/
 17:  */
 18: defined('XOOPS_ROOT_PATH') || exit('Restricted access');
 19: 
 20: /**
 21:  * A Avatar
 22:  *
 23:  * @author              Kazumi Ono <onokazu@xoops.org>
 24:  * @copyright       (c) 2000-2016 XOOPS Project (www.xoops.org)
 25:  *
 26:  * @package             kernel
 27:  */
 28: class XoopsAvatar extends XoopsObject
 29: {
 30:     public $_userCount;
 31: 
 32:     /**
 33:      * Constructor
 34:      */
 35:     public function __construct()
 36:     {
 37:         parent::__construct();
 38:         $this->initVar('avatar_id', XOBJ_DTYPE_INT, null, false);
 39:         $this->initVar('avatar_file', XOBJ_DTYPE_OTHER, null, false, 30);
 40:         $this->initVar('avatar_name', XOBJ_DTYPE_TXTBOX, null, true, 100);
 41:         $this->initVar('avatar_mimetype', XOBJ_DTYPE_OTHER, null, false);
 42:         $this->initVar('avatar_created', XOBJ_DTYPE_INT, null, false);
 43:         $this->initVar('avatar_display', XOBJ_DTYPE_INT, 1, false);
 44:         $this->initVar('avatar_weight', XOBJ_DTYPE_INT, 0, false);
 45:         $this->initVar('avatar_type', XOBJ_DTYPE_OTHER, 0, false);
 46:     }
 47: 
 48:     /**
 49:      * Returns Class Base Variable avatar_id
 50:      * @param string $format
 51:      * @return mixed
 52:      */
 53:     public function id($format = 'N')
 54:     {
 55:         return $this->getVar('avatar_id', $format);
 56:     }
 57: 
 58:     /**
 59:      * Returns Class Base Variable avatar_id
 60:      * @param string $format
 61:      * @return mixed
 62:      */
 63:     public function avatar_id($format = '')
 64:     {
 65:         return $this->getVar('avatar_id', $format);
 66:     }
 67: 
 68:     /**
 69:      * Returns Class Base Variable avatar_file
 70:      * @param string $format
 71:      * @return mixed
 72:      */
 73:     public function avatar_file($format = '')
 74:     {
 75:         return $this->getVar('avatar_file', $format);
 76:     }
 77: 
 78:     /**
 79:      * Returns Class Base Variable avatar_name
 80:      * @param string $format
 81:      * @return mixed
 82:      */
 83:     public function avatar_name($format = '')
 84:     {
 85:         return $this->getVar('avatar_name', $format);
 86:     }
 87: 
 88:     /**
 89:      * Returns Class Base Variable avatar_mimetype
 90:      * @param string $format
 91:      * @return mixed
 92:      */
 93:     public function avatar_mimetype($format = '')
 94:     {
 95:         return $this->getVar('avatar_mimetype', $format);
 96:     }
 97: 
 98:     /**
 99:      * Returns Class Base Variable avatar_created
100:      * @param string $format
101:      * @return mixed
102:      */
103:     public function avatar_created($format = '')
104:     {
105:         return $this->getVar('avatar_created', $format);
106:     }
107: 
108:     /**
109:      * Returns Class Base Variable avatar_display
110:      * @param string $format
111:      * @return mixed
112:      */
113:     public function avatar_display($format = '')
114:     {
115:         return $this->getVar('avatar_display', $format);
116:     }
117: 
118:     /**
119:      * Returns Class Base Variable avatar_weight
120:      * @param string $format
121:      * @return mixed
122:      */
123:     public function avatar_weight($format = '')
124:     {
125:         return $this->getVar('avatar_weight', $format);
126:     }
127: 
128:     /**
129:      * Returns Class Base Variable avatar_type
130:      * @param string $format
131:      * @return mixed
132:      */
133:     public function avatar_type($format = '')
134:     {
135:         return $this->getVar('avatar_type', $format);
136:     }
137: 
138:     /**
139:      * Set User Count
140:      *
141:      * @param int $value
142:      */
143:     public function setUserCount($value)
144:     {
145:         $this->_userCount = (int)$value;
146:     }
147: 
148:     /**
149:      * Get User Count
150:      *
151:      * @return int
152:      */
153:     public function getUserCount()
154:     {
155:         return $this->_userCount;
156:     }
157: }
158: 
159: /**
160:  * XOOPS avatar handler class. (Singelton)
161:  *
162:  * This class is responsible for providing data access mechanisms to the data source
163:  * of XOOPS block class objects.
164:  *
165:  * @author              Kazumi Ono <onokazu@xoops.org>
166:  * @copyright       (c) 2000-2016 XOOPS Project (www.xoops.org)
167:  * @package             kernel
168:  * @subpackage          block
169:  */
170: class XoopsAvatarHandler extends XoopsObjectHandler
171: {
172:     /**
173:      * Create new Object
174:      *
175:      * @param  bool $isNew
176:      * @return XoopsAvatar
177:      */
178:     public function create($isNew = true)
179:     {
180:         $avatar = new XoopsAvatar();
181:         if ($isNew) {
182:             $avatar->setNew();
183:         }
184: 
185:         return $avatar;
186:     }
187: 
188:     /**
189:      * Egt Object
190:      *
191:      * @param  int $id
192:      * @return XoopsAvatar
193:      */
194:     public function get($id)
195:     {
196:         $avatar = false;
197:         $id     = (int)$id;
198:         if ($id > 0) {
199:             $sql = 'SELECT * FROM ' . $this->db->prefix('avatar') . ' WHERE avatar_id=' . $id;
200:             if (!$result = $this->db->query($sql)) {
201:                 return false;
202:             }
203:             $numrows = $this->db->getRowsNum($result);
204:             if ($numrows == 1) {
205:                 $avatar = new XoopsAvatar();
206:                 $avatar->assignVars($this->db->fetchArray($result));
207: 
208:                 return $avatar;
209:             }
210:         }
211: 
212:         return $avatar;
213:     }
214: 
215:     /**
216:      * Insert and Object into the database
217:      *
218:      * @param  XoopsObject|XoopsAvatar $avatar a XoopsAvatar object
219:      *
220:      * @return bool true on success, otherwise false
221:      */
222:     public function insert(XoopsObject $avatar)
223:     {
224:         $className = 'XoopsAvatar';
225:         if (!($avatar instanceof $className)) {
226:             return false;
227:         }
228:         if (!$avatar->isDirty()) {
229:             return true;
230:         }
231:         if (!$avatar->cleanVars()) {
232:             return false;
233:         }
234:         foreach ($avatar->cleanVars as $k => $v) {
235:             ${$k} = $v;
236:         }
237:         if ($avatar->isNew()) {
238:             $avatar_id = $this->db->genId('avatar_avatar_id_seq');
239:             $sql       = sprintf('INSERT INTO %s (avatar_id, avatar_file, avatar_name, avatar_created, avatar_mimetype, avatar_display, avatar_weight, avatar_type) VALUES (%u, %s, %s, %u, %s, %u, %u, %s)', $this->db->prefix('avatar'), $avatar_id, $this->db->quoteString($avatar_file), $this->db->quoteString($avatar_name), time(), $this->db->quoteString($avatar_mimetype), $avatar_display, $avatar_weight, $this->db->quoteString($avatar_type));
240:         } else {
241:             $sql = sprintf('UPDATE %s SET avatar_file = %s, avatar_name = %s, avatar_created = %u, avatar_mimetype= %s, avatar_display = %u, avatar_weight = %u, avatar_type = %s WHERE avatar_id = %u', $this->db->prefix('avatar'), $this->db->quoteString($avatar_file), $this->db->quoteString($avatar_name), $avatar_created, $this->db->quoteString($avatar_mimetype), $avatar_display, $avatar_weight, $this->db->quoteString($avatar_type), $avatar_id);
242:         }
243:         if (!$result = $this->db->query($sql)) {
244:             return false;
245:         }
246:         if (empty($avatar_id)) {
247:             $avatar_id = $this->db->getInsertId();
248:         }
249:         $avatar->assignVar('avatar_id', $avatar_id);
250: 
251:         return true;
252:     }
253: 
254:     /**
255:      * Delete an object from the database
256:      *
257:      * @param  XoopsObject|XoopsAvatar $avatar a XoopsAvatar object
258:      *
259:      * @return bool true on success, otherwise false
260:      */
261:     public function delete(XoopsObject $avatar)
262:     {
263:         $className = 'XoopsAvatar';
264:         if (!($avatar instanceof $className)) {
265:             return false;
266:         }
267: 
268:         $id  = $avatar->getVar('avatar_id');
269:         $sql = sprintf('DELETE FROM %s WHERE avatar_id = %u', $this->db->prefix('avatar'), $id);
270:         if (!$result = $this->db->query($sql)) {
271:             return false;
272:         }
273:         $sql    = sprintf('DELETE FROM %s WHERE avatar_id = %u', $this->db->prefix('avatar_user_link'), $id);
274:         $result = $this->db->query($sql);
275: 
276:         return true;
277:     }
278: 
279:     /**
280:      * Fetch a row of objects from the database
281:      *
282:      * @param  CriteriaElement|CriteriaCompo $criteria
283:      * @param  bool  $id_as_key
284:      * @return object
285:      */
286:     public function &getObjects(CriteriaElement $criteria = null, $id_as_key = false)
287:     {
288:         $ret   = array();
289:         $limit = $start = 0;
290:         $sql   = 'SELECT a.*, COUNT(u.user_id) AS count FROM ' . $this->db->prefix('avatar') . ' a LEFT JOIN ' . $this->db->prefix('avatar_user_link') . ' u ON u.avatar_id=a.avatar_id';
291:         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
292:             $sql .= ' ' . $criteria->renderWhere();
293:             $sql .= ' GROUP BY a.avatar_id ORDER BY avatar_weight, avatar_id';
294:             $limit = $criteria->getLimit();
295:             $start = $criteria->getStart();
296:         }
297:         $result = $this->db->query($sql, $limit, $start);
298:         if (!$result) {
299:             return $ret;
300:         }
301:         while ($myrow = $this->db->fetchArray($result)) {
302:             $avatar = new XoopsAvatar();
303:             $avatar->assignVars($myrow);
304:             $avatar->setUserCount($myrow['count']);
305:             if (!$id_as_key) {
306:                 $ret[] = &$avatar;
307:             } else {
308:                 $ret[$myrow['avatar_id']] = &$avatar;
309:             }
310:             unset($avatar);
311:         }
312: 
313:         return $ret;
314:     }
315: 
316:     /**
317:      * Get count
318:      *
319:      * @param  CriteriaElement|CriteriaCompo $criteria
320:      * @return int
321:      */
322:     public function getCount(CriteriaElement $criteria = null)
323:     {
324: 
325: 
326:         $sql = 'SELECT COUNT(*) FROM ' . $this->db->prefix('avatar');
327:         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
328:             $sql .= ' ' . $criteria->renderWhere();
329:         }
330:         if (!$result = $this->db->query($sql)) {
331:             return 0;
332:         }
333:         list($count) = $this->db->fetchRow($result);
334: 
335:         return $count;
336:     }
337: 
338:     /**
339:      * Add user
340:      *
341:      * @param  int $avatar_id
342:      * @param  int $user_id
343:      * @return bool
344:      */
345:     public function addUser($avatar_id, $user_id)
346:     {
347:         $avatar_id = (int)$avatar_id;
348:         $user_id   = (int)$user_id;
349:         if ($avatar_id < 1 || $user_id < 1) {
350:             return false;
351:         }
352:         $sql = sprintf('DELETE FROM %s WHERE user_id = %u', $this->db->prefix('avatar_user_link'), $user_id);
353:         $this->db->query($sql);
354:         $sql = sprintf('INSERT INTO %s (avatar_id, user_id) VALUES (%u, %u)', $this->db->prefix('avatar_user_link'), $avatar_id, $user_id);
355:         if (!$result = $this->db->query($sql)) {
356:             return false;
357:         }
358: 
359:         return true;
360:     }
361: 
362:     /**
363:      * Get User
364:      *
365:      * @param  XoopsAvatar $avatar
366:      * @return array
367:      */
368:     public function getUser(XoopsAvatar $avatar)
369:     {
370:         $ret = array();
371:         /**
372:          * @TODO: Change to if (!(class_exists($this->className) && $obj instanceof $this->className)) when going fully PHP5
373:          */
374:         if (!is_a($avatar, 'xoopsavatar')) {
375:             return false;
376:         }
377:         $sql = 'SELECT user_id FROM ' . $this->db->prefix('avatar_user_link') . ' WHERE avatar_id=' . $avatar->getVar('avatar_id');
378:         if (!$result = $this->db->query($sql)) {
379:             return $ret;
380:         }
381:         while ($myrow = $this->db->fetchArray($result)) {
382:             $ret[] = &$myrow['user_id'];
383:         }
384: 
385:         return $ret;
386:     }
387: 
388:     /**
389:      * Get a list of Avatars
390:      *
391:      * @param  string $avatar_type
392:      * @param  string $avatar_display
393:      * @return array
394:      */
395:     public function getList($avatar_type = null, $avatar_display = null)
396:     {
397:         $criteria = new CriteriaCompo();
398:         if (isset($avatar_type)) {
399:             $avatar_type = ($avatar_type === 'C') ? 'C' : 'S';
400:             $criteria->add(new Criteria('avatar_type', $avatar_type));
401:         }
402:         if (isset($avatar_display)) {
403:             $criteria->add(new Criteria('avatar_display', (int)$avatar_display));
404:         }
405:         $avatars = &$this->getObjects($criteria, true);
406:         $ret     = array(
407:             'blank.gif' => _NONE);
408:         foreach (array_keys($avatars) as $i) {
409:             $ret[$avatars[$i]->getVar('avatar_file')] = $avatars[$i]->getVar('avatar_name');
410:         }
411: 
412:         return $ret;
413:     }
414: }
415: