Merge pull request #158 from phpcr/cleanup-tests

fix some tests to not be risky anymore and cleanup phpdoc

Author: lsmith77

src/PHPCR/Util/NodeHelper.php

@@ -89,6 +89,8 @@ public static function purgeWorkspace(SessionInterface $session)
     /**
      * Kept as alias of purgeWorkspace for BC compatibility
      *
+     * @param SessionInterface $session
+     *
      * @deprecated
      */
     public static function deleteAllNodes(SessionInterface $session)
@@ -102,6 +104,8 @@ public static function deleteAllNodes(SessionInterface $session)
      * repository.
      *
      * @param ItemInterface $item
+     *
+     * @return boolean true if $item is a system item, false otherwise
      */
     public static function isSystemItem(ItemInterface $item)
     {

src/PHPCR/Util/QOM/QueryBuilder.php

@@ -417,7 +417,7 @@ public function getSource()
      *
      * @return QueryBuilder This QueryBuilder instance.
      *
-     * @throws RuntimeException if there is not an existing source.
+     * @throws \RuntimeException if there is not an existing source.
      */
     public function join(SourceInterface $rightSource, JoinConditionInterface $joinCondition)
     {
@@ -432,7 +432,7 @@ public function join(SourceInterface $rightSource, JoinConditionInterface $joinC
      *
      * @return QueryBuilder This QueryBuilder instance.
      *
-     * @throws RuntimeException if there is not an existing source.
+     * @throws \RuntimeException if there is not an existing source.
      */
     public function innerJoin(SourceInterface $rightSource, JoinConditionInterface $joinCondition)
     {
@@ -447,7 +447,7 @@ public function innerJoin(SourceInterface $rightSource, JoinConditionInterface $
      *
      * @return QueryBuilder This QueryBuilder instance.
      *
-     * @throws RuntimeException if there is not an existing source.
+     * @throws \RuntimeException if there is not an existing source.
      */
     public function leftJoin(SourceInterface $rightSource, JoinConditionInterface $joinCondition)
     {
@@ -462,7 +462,7 @@ public function leftJoin(SourceInterface $rightSource, JoinConditionInterface $j
      *
      * @return QueryBuilder This QueryBuilder instance.
      *
-     * @throws RuntimeException if there is not an existing source.
+     * @throws \RuntimeException if there is not an existing source.
      */
     public function rightJoin(SourceInterface $rightSource, JoinConditionInterface $joinCondition)
     {
@@ -478,7 +478,7 @@ public function rightJoin(SourceInterface $rightSource, JoinConditionInterface $
      *
      * @return QueryBuilder This QueryBuilder instance.
      *
-     * @throws RuntimeException if there is not an existing source.
+     * @throws \RuntimeException if there is not an existing source.
      */
     public function joinWithType(SourceInterface $rightSource, $joinType, JoinConditionInterface $joinCondition)
     {

src/PHPCR/Util/QOM/Sql1Generator.php

@@ -50,6 +50,8 @@ protected function getPathForDescendantQuery($path)
      *
      * @param string $path
      * @param string $selectorName
+     *
+     * @return string
      */
     public function evalChildNode($path, $selectorName = null)
     {
@@ -142,6 +144,8 @@ public function evalColumns($columns)
      *
      * @param string $propertyName
      * @param string $selectorName unused in SQL1
+     *
+     * @return string
      */
     public function evalPropertyValue($propertyName, $selectorName = null)
     {

src/PHPCR/Util/QOM/Sql2Generator.php

@@ -166,6 +166,8 @@ public function evalDescendantNodeJoinCondition($descendantSelectorName, $ancest
      *
      * @param string $path
      * @param string $selectorName
+     *
+     * @return string
      */
     public function evalSameNode($path, $selectorName = null)
     {
@@ -181,6 +183,8 @@ public function evalSameNode($path, $selectorName = null)
      *
      * @param string $path
      * @param string $selectorName
+     *
+     * @return string
      */
     public function evalChildNode($path, $selectorName = null)
     {
@@ -196,6 +200,8 @@ public function evalChildNode($path, $selectorName = null)
      *
      * @param string $path
      * @param string $selectorName
+     *
+     * @return string
      */
     public function evalDescendantNode($path, $selectorName = null)
     {
@@ -260,6 +266,8 @@ public function evalLength($propertyValue)
      * NodeName ::= 'NAME(' [selectorName] ')'
      *
      * @param string $selectorValue
+     *
+     * @return string
      */
     public function evalNodeName($selectorValue = null)
     {
@@ -270,6 +278,8 @@ public function evalNodeName($selectorValue = null)
      * NodeLocalName ::= 'LOCALNAME(' [selectorName] ')'
      *
      * @param string $selectorValue
+     *
+     * @return string
      */
     public function evalNodeLocalName($selectorValue = null)
     {
@@ -280,6 +290,8 @@ public function evalNodeLocalName($selectorValue = null)
      * FullTextSearchScore ::= 'SCORE(' [selectorName] ')'
      *
      * @param string $selectorValue
+     *
+     * @return string
      */
     public function evalFullTextSearchScore($selectorValue = null)
     {
@@ -291,6 +303,8 @@ public function evalFullTextSearchScore($selectorValue = null)
      *
      * @param string $propertyName
      * @param string $selectorName
+     *
+     * @return string
      */
     public function evalPropertyValue($propertyName, $selectorName = null)
     {

src/PHPCR/Util/TreeWalker.php

@@ -33,14 +33,14 @@ class TreeWalker
     /**
      * Filters to apply to decide whether a node needs to be visited
      *
-     * @var array()
+     * @var TreeWalkerFilterInterface[]
      */
     protected $nodeFilters = array();
 
     /**
      * Filters to apply to decide whether a property needs to be visited
      *
-     * @var array()
+     * @var TreeWalkerFilterInterface[]
      */
     protected $propertyFilters = array();
 

tests/PHPCR/Tests/Util/PathHelperTest.php

@@ -42,7 +42,7 @@ public function testAssertInvalidAbsolutePath($path, $destination = false)
      */
     public function testAssertAbsolutePathNamespace($path)
     {
-        PathHelper::assertValidAbsolutePath($path, false, true, array('jcr', 'nt'));
+        $this->assertTrue(PathHelper::assertValidAbsolutePath($path, false, true, array('jcr', 'nt')));
     }
 
     public function dataproviderValidAbsolutePathsWithNamespaces()

tests/PHPCR/Tests/Util/QOM/QueryBuilderTest.php

@@ -174,6 +174,9 @@ public function testJoin()
         $source1 = $this->getMock('PHPCR\Query\QOM\SourceInterface', array(), array());
         $source2= $this->getMock('PHPCR\Query\QOM\SourceInterface', array(), array());
         $joinCondition = $this->getMock('PHPCR\Query\QOM\SameNodeJoinConditionInterface', array(), array());
+        $this->qf->expects($this->once())
+            ->method('join')
+            ->with($source1, $source2, $this->equalTo(\PHPCR\Query\QOM\QueryObjectModelConstantsInterface::JCR_JOIN_TYPE_INNER), $joinCondition);
         $qb = new QueryBuilder($this->qf);
         $qb->from($source1);
         $qb->join($source2, $joinCondition);