forum • Reece Fowells Blog

While needing to write a test to check the order of 2 items (within a given CSS query) in Behat, I did a little googling and came across this website here.

The tutorial is great and i just wanted to give a shout out to the author for their great content. I also made a slight change to include testing for the existing of the 2 items.

Here is my slightly updated version:

    /**
     * 
     * @Then /^"([^"]*)" should precede "([^"]*)" for the query "([^"]*)"$/
     */
    public function shouldPrecedeForTheQuery($textBefore, $textAfter, $cssQuery)
    {
		// http://neverstopbuilding.net/simple-method-for-checking-for-order-with-behat/
        $items = array_map(
            function ($element) {
                return $element->getText();
            },
            $this->getPage()->findAll('css', $cssQuery)
        );

		WebTestCase::assertTrue(in_array($textBefore, $items), 'The before text was not found!');
		WebTestCase::assertTrue(in_array($textAfter,  $items), 'The after text was not found!');
			
        WebTestCase::assertGreaterThan(
            array_search($textBefore, $items),
            array_search($textAfter, $items),
            "$textBefore does not proceed $textAfter"
        );
    }

/**

* @Then /^"([^"]*)" should precede "([^"]*)" for the query "([^"]*)"$/

public function shouldPrecedeForTheQuery($textBefore, $textAfter, $cssQuery)

{

// http://neverstopbuilding.net/simple-method-for-checking-for-order-with-behat/

$items = array_map(

function ($element) {

return $element->getText();

$this->getPage()->findAll('css', $cssQuery)

);

WebTestCase::assertTrue(in_array($textBefore, $items), 'The before text was not found!');

WebTestCase::assertTrue(in_array($textAfter, $items), 'The after text was not found!');

WebTestCase::assertGreaterThan(

array_search($textBefore, $items),

array_search($textAfter, $items),

"$textBefore does not proceed $textAfter"

);

}

You can see an example of the test i wrote using this method here.

So i had to implement a mechanism to re-order Categories and also Boards for my forum bundle, and with though there are many ways to go about it, here is how i solved the problem of reordering them. The reordering functionality is circular so last items getting pushed down end up on the top of the list, and top items getting pushed up end up on the bottom of the list.

    /**
     *
     * @access public
     * @param  Array                                               $categories
     * @param  \CCDNForum\ForumBundle\Entity\Category              $categoryShift
     * @param  int                                                 $direction
     * @return \CCDNForum\ForumBundle\Manager\BaseManagerInterface
     */
    public function reorderCategories($categories, Category $categoryShift, $direction)
    {
		$categoryCount = (count($categories) - 1);
		
		// Find category in collection to shift and use list order as array key for easier editing.
		$sorted = array();
		$shiftIndex = null;
		foreach ($categories as $categoryIndex => $category) {
			if ($categories[$categoryIndex]->getId() == $categoryShift->getId()) {
				$shiftIndex = $categoryIndex;
			}
			
			$sorted[$categoryIndex] = $category;
		}

		$incrementKeysAfterIndex = function($index, $arr) {
			$hydrated = array();
		
			foreach ($arr as $key => $el) {
				if ($key > $index) {
					$hydrated[$key + 1] = $el;
				} else {
					$hydrated[$key] = $el;
				}
			}
		
			return $hydrated;
		};
		
		$decrementKeysBeforeIndex = function($index, $arr) {
			$hydrated = array();
		
			foreach ($arr as $key => $el) {
				if ($key < $index) {
					$hydrated[$key - 1] = $el;
				} else {
					$hydrated[$key] = $el;
				}
			}
			
			return $hydrated;
		};
			
		$shifted = array();
		
		// First Category needs reordering??
		if ($shiftIndex == 0) {
			if ($direction) { // Down (move down 1)
				$shifted = $sorted;
				$shifted[$shiftIndex] = $sorted[$shiftIndex + 1];
				$shifted[$shiftIndex + 1] = $sorted[$shiftIndex];
			} else { // Up (send to bottom)
				$shifted[$categoryCount] = $sorted[0];
				unset($sorted[0]);
				$shifted = array_merge($decrementKeysBeforeIndex($categoryCount + 1, $sorted), $shifted);
			}
		} else {
			// Last category needs reordering??
			if ($shiftIndex == $categoryCount) {
				if ($direction) { // Down (send to top)
					$shifted[0] = $sorted[$categoryCount];
					unset($sorted[$categoryCount]);
					$shifted = array_merge($shifted, $incrementKeysAfterIndex(-1, $sorted));
				} else { // Up (move up 1)
					$shifted = $sorted;
					$shifted[$shiftIndex] = $sorted[$shiftIndex - 1];
					$shifted[$shiftIndex - 1] = $sorted[$shiftIndex];
				}
			} else {
				// Swap 2 categories not at beginning or end.
				$shifted = $sorted;
				if ($direction) { // Down (move down 1)
					$shifted[$shiftIndex] = $sorted[$shiftIndex + 1];
					$shifted[$shiftIndex + 1] = $sorted[$shiftIndex];
				} else { // Up (move up 1)
					$shifted[$shiftIndex] = $sorted[$shiftIndex - 1];
					$shifted[$shiftIndex - 1] = $sorted[$shiftIndex];
				}
			}
		}
		
		// Set the order from the $index arranged prior and persist.
		foreach ($shifted as $index => $category) {
			$category->setListOrderPriority($index);
			$this->persist($category);
		}
		
        $this->flush();

        return $this;
    }

/**

* @access public

* @param Array $categories

* @param \CCDNForum\ForumBundle\Entity\Category $categoryShift

* @param int $direction

* @return \CCDNForum\ForumBundle\Manager\BaseManagerInterface

public function reorderCategories($categories, Category $categoryShift, $direction)

{

$categoryCount = (count($categories) - 1);

// Find category in collection to shift and use list order as array key for easier editing.

$sorted = array();

$shiftIndex = null;

foreach ($categories as $categoryIndex => $category) {

if ($categories[$categoryIndex]->getId() == $categoryShift->getId()) {

$shiftIndex = $categoryIndex;

}

$sorted[$categoryIndex] = $category;

}

$incrementKeysAfterIndex = function($index, $arr) {

$hydrated = array();

foreach ($arr as $key => $el) {

if ($key > $index) {

$hydrated[$key + 1] = $el;

} else {

$hydrated[$key] = $el;

}

return $hydrated;

};

$decrementKeysBeforeIndex = function($index, $arr) {

$hydrated = array();

foreach ($arr as $key => $el) {

if ($key < $index) {

$hydrated[$key - 1] = $el;

} else {

$hydrated[$key] = $el;

}

return $hydrated;

};

$shifted = array();

// First Category needs reordering??

if ($shiftIndex == 0) {

if ($direction) { // Down (move down 1)

$shifted = $sorted;

$shifted[$shiftIndex] = $sorted[$shiftIndex + 1];

$shifted[$shiftIndex + 1] = $sorted[$shiftIndex];

} else { // Up (send to bottom)

$shifted[$categoryCount] = $sorted[0];

unset($sorted[0]);

$shifted = array_merge($decrementKeysBeforeIndex($categoryCount + 1, $sorted), $shifted);

}

} else {

// Last category needs reordering??

if ($shiftIndex == $categoryCount) {

if ($direction) { // Down (send to top)

$shifted[0] = $sorted[$categoryCount];

unset($sorted[$categoryCount]);

$shifted = array_merge($shifted, $incrementKeysAfterIndex(-1, $sorted));

} else { // Up (move up 1)

$shifted = $sorted;

$shifted[$shiftIndex] = $sorted[$shiftIndex - 1];

$shifted[$shiftIndex - 1] = $sorted[$shiftIndex];

}

} else {

// Swap 2 categories not at beginning or end.

$shifted = $sorted;

if ($direction) { // Down (move down 1)

$shifted[$shiftIndex] = $sorted[$shiftIndex + 1];

$shifted[$shiftIndex + 1] = $sorted[$shiftIndex];

} else { // Up (move up 1)

$shifted[$shiftIndex] = $sorted[$shiftIndex - 1];

$shifted[$shiftIndex - 1] = $sorted[$shiftIndex];

}

// Set the order from the $index arranged prior and persist.

foreach ($shifted as $index => $category) {

$category->setListOrderPriority($index);

$this->persist($category);

}

$this->flush();

return $this;

}

What do you guys think? Know of a better approach? Let me know!

M	T	W	T	F	S	S
« Aug
					1	2
3	4	5	6	7	8	9
10	11	12	13	14	15	16
17	18	19	20	21	22	23
24	25	26	27	28	29	30
31

Reece Fowells Blog

The home of a lot of crapola…

Tag: forum

Simple Method for Checking for Order With Behat

Sorting/Reording Symfony2 Entities Display Order.

Forum up and running! yay!