wikitag: comparison Entity/DocumentRepository.php

equal deleted inserted replaced

-:b403086580f7
+:0e57c730bb18
 <?php
 namespace IRI\Bundle\WikiTagBundle\Entity;
+use IRI\Bundle\WikiTagBundle\Model\DocumentInterface;
 use Doctrine\ORM\EntityRepository;
 use IRI\Bundle\WikiTagBundle\Entity\Document;
 use Doctrine\ORM\Query\ResultSetMapping;
 use \ReflectionClass;
 use Doctrine\ORM\AbstractQuery;
 use Doctrine\ORM\Mapping\ClassMetadataInfo;
+use IRI\Bundle\WikiTagBundle\Model\ModelException;
 /**
 * DocumentRepository
 *
 * This class was generated by the Doctrine ORM. Add your own custom
 * repository methods below.
 */
 class DocumentRepository extends EntityRepository
 {
 /**
-*
+* The cache for the host document class
-* TODO : Enter description here ...
 * @var ReflectionClass
 */
 private $reflection_class;
+/**
+* The cache for the wikitag document class
+* @var ReflectionClass
+*/
 private $reflection_doc_class;
 private $set_methods = array();
 private $get_methods = array();
-function findOneByExternalId($external_id)
+/**
+* Find one wikitagRepository by its externalId i.e. the host document id.
+* @param $external_id
+*/
+public function findOneByExternalId($external_id)
 {
 return $this->findOneBy(array("externalId" => $external_id));
 }
 private function reflectionSetField($object, $method_name, $value)
 {
 if(isset($this->set_methods[$method_name]))
 {
 {
 return $get_object->getValue($document);
 }
 else
 {
-//TODO : custom exception
+throw new ModelException("Bad reflection object type");
-throw new \Exception("Bad reflection object type");
+}
 }
 }
-}
+throw new ModelException("Unknown accessor $accessor");
-//TODO: replace by custom exception
-throw new \Exception("Unknown accessor $accessor");
 }
 private function getColumnName($field_name)
 {
 }
 return $res;
 }
+/**
+* Write a wikitag document given the host document and the field list.
+* @param $document The source document
+* @param $document_id_column the name of the source document id column
+* @param $fields The list of field definition. This is an associative array [<field name>=><field definition>].
+*     See the @IRI\Bundle\WikiTagBundle\DependencyInjection\Configuration documentation
+*/
 public function writeDocument($document,  $document_id_column, $fields)
 {
 // get document from id
 $docid = $this->reflectionGetField($document, $document_id_column);
 $this->getEntityManager()->flush();
 return $baseDocument;
 }
-function removeDocument($document, $document_id_column)
+/**
+* Remove a Wikitag doument given the host docuument.
+* @param $document The host document
+* @param string $document_id_column The host document id column name
+*/
+public function removeDocument($document, $document_id_column)
 {
 $docid = $this->reflectionGetField($document, $document_id_column);
 $baseDocument = $this->findOneByExternalId($docid);
 if(!is_null($baseDocument))
 {
 $this->getEntityManager()->remove($baseDocument);
 }
 }
-function getTagsStr($document)
+/**
+* return the list of a wikitag documents the tags label.
+* @param DocumentInterface $document the wikitag document
+* @return array
+*/
+public function getTagsStr($document)
 {
 $em = $this->getEntityManager();
 $query = $em->createQuery("SELECT t.label FROM WikiTagBundle:DocumentTag dt JOIN dt.tag t WHERE dt.document = :docid");
 $query = $query->setParameter("docid", $document);
 $result = $query->getScalarResult();
 $tagstr[] = $res['label'];
 }
 return $tagstr;
 }
-function updateTagsStr($document)
+/**
+* Update a wikitag document tags string.
+* @param DocumentInterface $document the wikitag document
+*/
+function updateTagsStr(DocumentInterface $document)
 {
 $tagstr = $this->getTagsStr($document);
 $document->setTagsStr(implode(",",$tagstr));
 $this->getEntityManager()->persist($document);
 }
 /**
+* Search wikitag documents using the index.
 *
-* Enter description here ...
 * @param array $values : key: the fields to search into, value : array('value'=>value, 'weight'=>weight)
 * @param array $conditions : array : key : field name, value : simple value (operator is "=") or array(valuea, value2,...) (operatr is IN) or array("operator"=>"", "value"=>value)
-* @return Ambigous <multitype:, \Doctrine\ORM\mixed, \Doctrine\DBAL\Driver\Statement, \Doctrine\ORM\Internal\Hydration\mixed>
+* @return array [["id" => <the wikitag document id>, "externalId" => <the host document ids>, "score" => <the score for this document>]]
 */
 function search(array $values, array $conditions=NULL)
 {
 $em = $this->getEntityManager();
 $query->setParameters($parameters);
 $res = $query->getResult();
 return $res;
 }
 }

changeset 42	0e57c730bb18
parent 37	9ba15af20acc
child 57	186c4121c7b3