Implement Tag and TagMapper classes.
Subclassed from \OCP\AppFramework\Db\Entity and Mapper, respectively. This will allow us to also deal with shared tags.remotes/origin/fix-10825
Bernhard Reiter
parent
cf6fb2c2e4
commit
5471189fe6
@ -0,0 +1,85 @@
|
||||
<?php
|
||||
/**
|
||||
* ownCloud - Tag class
|
||||
*
|
||||
* @author Bernhard Reiter
|
||||
* @copyright 2014 Bernhard Reiter <ockham@raz.or.at>
|
||||
*
|
||||
* This library is free software; you can redistribute it and/or
|
||||
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
|
||||
* License as published by the Free Software Foundation; either
|
||||
* version 3 of the License, or any later version.
|
||||
*
|
||||
* This library is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public
|
||||
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
namespace OC\Tagging;
|
||||
|
||||
use \OCP\AppFramework\Db\Entity;
|
||||
|
||||
/**
|
||||
* Class to represent a tag.
|
||||
*
|
||||
* @method string getOwner()
|
||||
* @method void setOwner(string $owner)
|
||||
* @method string getType()
|
||||
* @method void setType(string $type)
|
||||
* @method string getName()
|
||||
* @method void setName(string $name)
|
||||
*/
|
||||
class Tag extends Entity {
|
||||
|
||||
protected $owner;
|
||||
protected $type;
|
||||
protected $name;
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param string $owner The tag's owner
|
||||
* @param string $type The type of item this tag is used for
|
||||
* @param string $name The tag's name
|
||||
*/
|
||||
public function __construct($owner = null, $type = null, $name = null) {
|
||||
$this->setOwner($owner);
|
||||
$this->setType($type);
|
||||
$this->setName($name);
|
||||
}
|
||||
|
||||
/**
|
||||
* Transform a database columnname to a property
|
||||
* @param string $columnName the name of the column
|
||||
* @return string the property name
|
||||
*/
|
||||
public function columnToProperty($columnName){
|
||||
if ($columnName === 'category') {
|
||||
return 'name';
|
||||
} elseif ($columnName === 'uid') {
|
||||
return 'owner';
|
||||
} else {
|
||||
return parent::columnToProperty($columnName);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Transform a property to a database column name
|
||||
* @param string $property the name of the property
|
||||
* @return string the column name
|
||||
*/
|
||||
public function propertyToColumn($property){
|
||||
if ($property === 'name') {
|
||||
return 'category';
|
||||
} elseif ($property === 'owner') {
|
||||
return 'uid';
|
||||
} else {
|
||||
return parent::propertyToColumn($property);
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,77 @@
|
||||
<?php
|
||||
/**
|
||||
* ownCloud - TagMapper class
|
||||
*
|
||||
* @author Bernhard Reiter
|
||||
* @copyright 2014 Bernhard Reiter <ockham@raz.or.at>
|
||||
*
|
||||
* This library is free software; you can redistribute it and/or
|
||||
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
|
||||
* License as published by the Free Software Foundation; either
|
||||
* version 3 of the License, or any later version.
|
||||
*
|
||||
* This library is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public
|
||||
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
namespace OC\Tagging;
|
||||
|
||||
use \OCP\AppFramework\Db\Mapper,
|
||||
\OCP\AppFramework\Db\DoesNotExistException,
|
||||
\OCP\IDb;
|
||||
|
||||
/**
|
||||
* Thin wrapper around \OCP\AppFramework\Db\Mapper.
|
||||
*/
|
||||
class TagMapper extends Mapper {
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param IDb $db Instance of the Db abstraction layer.
|
||||
*/
|
||||
public function __construct(IDb $db) {
|
||||
parent::__construct($db, 'vcategory', 'OC\Tagging\Tag');
|
||||
}
|
||||
|
||||
/**
|
||||
* Load tags from the database.
|
||||
*
|
||||
* @param array|string $owners The user(s) whose tags we are going to load.
|
||||
* @param string $type The type of item for which we are loading tags.
|
||||
* @return array An array of Tag objects.
|
||||
*/
|
||||
public function loadTags($owners, $type) {
|
||||
if(!is_array($owners)) {
|
||||
$owners = array($owners);
|
||||
}
|
||||
|
||||
$sql = 'SELECT `id`, `uid`, `type`, `category` FROM `' . $this->getTableName() . '` '
|
||||
. 'WHERE `uid` IN (' . str_repeat('?,', count($owners)-1) . '?) AND `type` = ? ORDER BY `category`';
|
||||
return $this->findEntities($sql, array_merge($owners, array($type)));
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a given Tag object already exists in the database.
|
||||
*
|
||||
* @param Tag $tag The tag to look for in the database.
|
||||
* @return bool
|
||||
*/
|
||||
public function tagExists($tag) {
|
||||
$sql = 'SELECT `id`, `uid`, `type`, `category` FROM `' . $this->getTableName() . '` '
|
||||
. 'WHERE `uid` = ? AND `type` = ? AND `category` = ?';
|
||||
try {
|
||||
$this->findEntity($sql, array($tag->getOwner(), $tag->getType(), $tag->getName()));
|
||||
} catch (DoesNotExistException $e) {
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue