add docblocs, add behat tests to travis, smaller fixes

sourcefabric · Dec 3, 2014 · 6a838ff · 6a838ff
1 parent a2f9b61
commit 6a838ff
Show file tree

Hide file tree

Showing 11 changed files with 88 additions and 17 deletions.
diff --git a/newscoop/application/controllers/ErrorController.php b/newscoop/application/controllers/ErrorController.php
@@ -49,7 +49,6 @@ public function errorAction()
  }
 
  $errors = $this->_getParam('error_handler');
- $request = $this->getRequest();
 
  if (!$errors) {
  $this->view->message = $translator->trans('You have reached the error page', array(), 'bug_reporting');
@@ -90,7 +89,7 @@ public function errorAction()
  if ($this->getInvokeArg('displayExceptions') == true) {
  $this->view->exception = $errors->exception;
  }
- 
+
  $this->view->request = $errors->request;
  $this->view->errors = $errors;
  }

diff --git a/newscoop/application/controllers/ImageController.php b/newscoop/application/controllers/ImageController.php
@@ -34,7 +34,7 @@ public function cacheAction()
  $this->getResponse()->setHeader('Expires', gmdate(self::DATE_FORMAT, date_create('+30 days')->getTimestamp()), true);
 
  try {
- $image = $this->_helper->service('image')->generateFromSrc($this->_getParam('src'));
+ $this->_helper->service('image')->generateFromSrc($this->_getParam('src'));
  $this->getResponse()->setHeader('Content-Type', $this->getContentType($this->getPath()), true);
  $this->getResponse()->sendHeaders();
  $this->getResponse()->setBody(file_get_contents($this->getPath()));

diff --git a/newscoop/application/controllers/RegisterController.php b/newscoop/application/controllers/RegisterController.php
@@ -26,7 +26,7 @@ public function init()
  }
 
  public function indexAction()
- { 
+ {
  $translator = \Zend_Registry::get('container')->getService('translator');
  $form = new Application_Form_Register();
  $form->setMethod('POST');
@@ -55,21 +55,21 @@ public function indexAction()
 
  $this->view->form = $form;
  }
- 
+
  public function createUserAction()
  {
  $parameters = $this->getRequest()->getParams();
- 
+
  $user = $this->_helper->service('user')->findBy(array(
  'email' => $parameters['email'],
  ));
- 
+
  if ($user) {
  echo '0';
  exit;
  } else {
  $user = $this->_helper->service('user')->createPending($parameters['email'], $parameters['first_name'], $parameters['last_name'], $parameters['subscriber_id']);
-  
+
  $this->_helper->service('email')->sendConfirmationToken($user);
  echo '1';
  exit;
@@ -124,7 +124,7 @@ public function confirmAction()
  } else {
  $adapter = $this->_helper->service('auth.adapter');
  $adapter->setEmail($user->getEmail())->setPassword($values['password']);
- $result = $auth->authenticate($adapter);
+ $auth->authenticate($adapter);
  $token = $this->_helper->service('user')->loginUser($user, 'frontend_area');
  $session->set('_security_frontend_area', serialize($token));
  $OAuthtoken = $this->_helper->service('user')->loginUser($user, 'oauth_authorize');

diff --git a/newscoop/library/Newscoop/Entity/Article.php b/newscoop/library/Newscoop/Entity/Article.php
@@ -841,9 +841,9 @@ public function getPublished()
  /**
  * Set published
  *
- * @param Datetime|null $published
+ * @param \Datetime|null $published
  *
- * @return string
+ * @return self
  */
  public function setPublished($published)
  {
@@ -1551,7 +1551,7 @@ public function getPublic()
  /**
  * Sets the value of public.
  *
- * @param string $public the public
+ * @param boolean $public the public
  *
  * @return self
  */
@@ -1667,7 +1667,7 @@ public function getIsIndexed()
  /**
  * Sets the value of isIndexed.
  *
- * @param string $isIndexed the is indexed
+ * @param boolean $isIndexed the is indexed
  *
  * @return self
  */

diff --git a/newscoop/library/Newscoop/Entity/AuthorType.php b/newscoop/library/Newscoop/Entity/AuthorType.php
@@ -45,6 +45,9 @@ class AuthorType
  */
  protected $authors;
 
+ /**
+ * @param string $type
+ */
  public function __construct($type = null)
  {
  $this->authors = new ArrayCollection();

diff --git a/newscoop/library/Newscoop/Entity/Repository/ArticleRepository.php b/newscoop/library/Newscoop/Entity/Repository/ArticleRepository.php
@@ -278,6 +278,13 @@ public function getArticlesForSection($publication, $sectionNumber)
  return $query;
  }
 
+ /**
+ * Get number of articles assigned to Publication
+ *
+ * @param integer $publicationId
+ *
+ * @return \Doctrine\ORM\Query
+ */
  public function getArticlesCountForPublication($publicationId)
  {
  $articlesCount = $this->createQueryBuilder('a')
@@ -477,6 +484,15 @@ public function countByAuthor(User $user)
  return (int) $count;
  }
 
+ /**
+ * Get new minimal article order value
+ *
+ * @param integer $publication
+ * @param integer $issue
+ * @param integer $section
+ *
+ * @return \Doctrine\ORM\Query
+ */
  public function getMinArticleOrder($publication = null, $issue = null, $section = null)
  {
  $qb = $this->getEntityManager()->createQueryBuilder();
@@ -502,6 +518,16 @@ public function getMinArticleOrder($publication = null, $issue = null, $section
  return $qb->getQuery();
  }
 
+ /**
+ * Update article order
+ *
+ * @param integer $increment
+ * @param integer $publication
+ * @param integer $issue
+ * @param integer $section
+ *
+ * @return \Doctrine\ORM\Query
+ */
  public function updateArticleOrder($increment, $publication = null, $issue = null, $section = null)
  {
  $qb = $this->getEntityManager()->createQueryBuilder('a');

diff --git a/newscoop/library/Newscoop/Entity/Repository/AutoIdRepository.php b/newscoop/library/Newscoop/Entity/Repository/AutoIdRepository.php
@@ -17,6 +17,11 @@
 class AutoIdRepository extends EntityRepository
 {
 
+ /**
+ * Get next translations phrase Id.
+ *
+ * @return integer
+ */
  public function getNextTranslationPhraseId()
  {
  $em = $this->getEntityManager();
@@ -29,6 +34,11 @@ public function getNextTranslationPhraseId()
  return $autoId->getTranslationPhraseId();
  }
 
+ /**
+ * Get next article number
+ *
+ * @return integer
+ */
  public function getNextArticleNumber()
  {
  $em = $this->getEntityManager();

diff --git a/newscoop/library/Newscoop/Entity/Repository/IssueRepository.php b/newscoop/library/Newscoop/Entity/Repository/IssueRepository.php
@@ -36,7 +36,7 @@ public function getLatestByPublication($publicationId, $maxResults = 1)
  ->getArrayResult();
 
  if (count($issuesIds) == 0) {
- return false;
+ return null;
  }
 
  $ids = array();

diff --git a/newscoop/library/Newscoop/Installer/Services/DatabaseService.php b/newscoop/library/Newscoop/Installer/Services/DatabaseService.php
@@ -128,6 +128,10 @@ public function installDatabaseSchema($connection, $host = null, $publicationNam
 
  $connection->executeQuery('INSERT IGNORE INTO Aliases VALUES (2,?,1)', array($host));
  $connection->executeQuery('INSERT IGNORE INTO Publications (`Id`, `Name`, `IdDefaultLanguage`, `IdDefaultAlias`, `IdURLType`, `fk_forum_id`, `comments_enabled`, `comments_article_default_enabled`, `comments_subscribers_moderated`, `comments_public_moderated`, `comments_public_enabled`, `comments_captcha_enabled`, `comments_spam_blocking_enabled`, `comments_moderator_to`, `comments_moderator_from`, `url_error_tpl_id`, `seo`, `meta_title`, `meta_keywords`, `meta_description`) VALUES ("1", ?, "1", "2", "2", NULL, "1", "1", NULL, "0", NULL, NULL, "1", NULL, NULL, NULL, "a:1:{s:4:\"name\";s:2:\"on\";}", NULL, NULL, NULL)', array($publicationName));
+
+ // needed for tests - sample new article type
+ $connection->executeQuery("CREATE TABLE `Xnews` (`NrArticle` int(11) NOT NULL,`IdLanguage` int(11) NOT NULL,`Fhighlight` tinyint(1) NOT NULL DEFAULT '0',`Fdeck` mediumblob,`Ffull_text` mediumblob,PRIMARY KEY (`NrArticle`,`IdLanguage`)) ENGINE=InnoDB DEFAULT CHARSET=utf8;");
+ $connection->executeQuery("INSERT INTO `ArticleTypeMetadata` VALUES ('news','NULL',NULL,0,1,NULL,NULL,NULL,0,NULL),('news','lead',2,0,0,NULL,'longtext',NULL,0,NULL),('news','content',3,0,0,NULL,'body','editor_size=750',1,NULL);");
  }
 
  /**

diff --git a/newscoop/library/Newscoop/Services/ArticleService.php b/newscoop/library/Newscoop/Services/ArticleService.php
@@ -10,6 +10,7 @@
 
 use Doctrine\ORM\EntityManager;
 use Newscoop\Entity\Article;
+use Newscoop\Entity\User;
 use Symfony\Component\HttpFoundation\Request;
 
 /**
@@ -75,6 +76,7 @@ public function getArticleMetadata()
 
  /**
  * Resolve article from provided data
+ *
  * @param Request $request Request object
  *
  * @return Article $article Article entity object
@@ -123,6 +125,19 @@ public function articleResolver(Request $request)
  }
  }
 
+ /**
+ * Create new article
+ *
+ * @param string $articleType
+ * @param integer $language
+ * @param User $user
+ * @param integer $publication
+ * @param array $attributes
+ * @param integer $issue
+ * @param integer $section
+ *
+ * @return Article
+ */
  public function createArticle($articleType, $language, $user, $publication, $attributes = array(), $issue = null, $section = null)
  {
  $this->checkForArticleConflicts($attributes['name'], $publication, $issue, $section);
@@ -143,7 +158,7 @@ public function createArticle($articleType, $language, $user, $publication, $att
 
 
  $increment = $minArticleOrder > 0 ? 1 : 2;
- $result = $this->em->getRepository('Newscoop\Entity\Article')
+ $this->em->getRepository('Newscoop\Entity\Article')
  ->updateArticleOrder($increment, $publication, $issue, $section)
  ->getResult();
 
@@ -184,6 +199,14 @@ public function createArticle($articleType, $language, $user, $publication, $att
  return $article;
  }
 
+ /**
+ * Update article
+ *
+ * @param Article $article
+ * @param array $attributes
+ *
+ * @return Article
+ */
  public function updateArticle($article, $attributes)
  {
  $this->checkForArticleConflicts(
@@ -208,6 +231,14 @@ public function updateArticle($article, $attributes)
  return $article;
  }
 
+ /**
+ * Update Article static properties
+ *
+ * @param Article $article
+ * @param array $attributes
+ *
+ * @return Article
+ */
  private function updateArticleMeta($article, $attributes)
  {
  $article->setName($attributes['name']);

diff --git a/newscoop/src/Newscoop/GimmeBundle/Controller/ArticlesController.php b/newscoop/src/Newscoop/GimmeBundle/Controller/ArticlesController.php
@@ -171,8 +171,6 @@ public function patchArticleAction(Request $request, $number, $language)
  'number' => $article->getId(),
  ), true))
  );
-
- return $response;
  } else {
  // TODO add support for global for errors handler
  }