JobEventSubscriber::updateIndex() - Code Metrics - Inspection of "Feature solr nested documents" - cross-solution/YAWIK - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#254)

by Carsten

created 2016-07-15 09:33 UTC

JobEventSubscriber::updateIndex() A

↳ Parent: JobEventSubscriber

Complexity

Conditions	3
Paths	3

Size

Total Lines	12
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	1	Features	0

Metric	Value
dl	0
loc	12
rs	9.4285
c	2
b	1
f	0
cc	3
eloc	7
nc	3
nop	1

<?php
/**
 * YAWIK
 *
 * @filesource
 * @copyright (c) 2013 - 2016 Cross Solution (http://cross-solution.de)
 * @license   MIT
 */

namespace Solr\Listener;


use Doctrine\Common\EventSubscriber;
use Doctrine\ODM\MongoDB\Event\LifecycleEventArgs;
use Doctrine\ODM\MongoDB\Events;
use Jobs\Entity\Job;
use Solr\Bridge\Manager;
use Solr\Bridge\Util;
use Zend\ServiceManager\ServiceLocatorInterface;

/**
 * Class JobEventSubscriber
 *
 * @author  Anthonius Munthi <[email protected]>
 * @since   0.26
 * @package Solr\Event\Listener
 */
class JobEventSubscriber implements EventSubscriber
{

    /**
     * @var Manager
     */
    protected $solrManager;
    /**
     * JobEventSubscriber constructor.
     * @param Manager $manager
     */
    public function __construct(Manager $manager)
    {
        $this->solrManager = $manager;
    }
    /**
     * Define what event this subscriber listen to
     *
     * @return array
     */
    public function getSubscribedEvents()
    {
        return [
            Events::postUpdate,
            Events::postPersist,
        ];
    }
    public function consoleIndex(Job $job)
    {
        $this->updateIndex($job);
    }
    /**
     * Handle doctrine post persist event
     *
     * @param LifecycleEventArgs $eventArgs
     */
    public function postPersist(LifecycleEventArgs $eventArgs)
    {
        $document = $eventArgs->getDocument();
        $this->updateIndex($document);
    }
    /**
     * Handle doctrine postUpdate event
     *
     * @param LifecycleEventArgs $eventArgs
     */
    public function postUpdate(LifecycleEventArgs $eventArgs)
    {
        $document = $eventArgs->getDocument();
        $this->updateIndex($document);
    }
    /**
     * @param ServiceLocatorInterface $serviceLocator
     * @return mixed
     */
    static public function factory(ServiceLocatorInterface $serviceLocator)

    {
        /* @var Manager $manager */
        $manager = $serviceLocator->get('Solr/Manager');
        return new self($manager);
    }
    /**
     * @param $document
     */
    protected function updateIndex($document)
    {
        if(!$document instanceof Job){
            return;
        }
        $solrDoc = $this->generateInputDocument($document, new \SolrInputDocument());
        try{
            $this->solrManager->addDocument($solrDoc,$this->solrManager->getOptions()->getJobsPath());
        }catch (\Exception $e){
            // @TODO: What to do when the process failed?
        }
    }
    /**
     * Generate input document
     *
     * @param   Job                 $job
     * @param   \SolrInputDocument  $document
     * @return  \SolrInputDocument
     */
    public function generateInputDocument(Job $job, $document)
    {
        $document->addField('id',$job->getId());

        $document->addField('entityName','job');

        $document->addField('title',$job->getTitle());

        $document->addField('applicationEmail',$job->getContactEmail());

        if ($job->getLink()) {
            $document->addField('link', $job->getLink());

            $oldErrorReporting=error_reporting(0);
            $dom = new \DOMDocument();
            $dom->loadHTML($job->getLink());
            error_reporting($oldErrorReporting);
            $document->addField('html',$dom->saveHTML());

        }
        if($job->getDateCreated()){
            $document->addField('dateCreated',Util::convertDateTime($job->getDateCreated()));

        }
        if($job->getDateModified()){
            $document->addField('dateModified',Util::convertDateTime($job->getDateModified()));

        }
        if($job->getDatePublishStart()){
            $document->addField('datePublishStart',Util::convertDateTime($job->getDatePublishStart()));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }
        if($job->getDatePublishEnd()){
            $document->addField('datePublishEnd',Util::convertDateTime($job->getDatePublishEnd()));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }
        $document->addField('isActive',$job->isActive());

        $document->addField('lang',$job->getLanguage());

        $this->processLocation($job,$document);
        if(!is_null($job->getOrganization())){
            try {
                $this->processOrganization($job,$document);
            }catch (\Exception $e){
                // @TODO: What to do when the process failed?
            }
        }
        return $document;
    }
    /**
     * Processing organization part
     *
     * @param Job                   $job
     * @param \SolrInputDocument    $document
     */
    public function processOrganization(Job $job,$document)
    {
        if(!is_null($job->getOrganization()->getImage())){
            $uri = $job->getOrganization()->getImage()->getUri();
            $document->addField('companyLogo',$uri);

        }
        $document->addField('organizationName',$job->getOrganization()->getOrganizationName()->getName());

        $document->addField('organizationId',$job->getOrganization()->getId());

    }

    /**
     * Processing location part
     * @param Job                $job
     * @param \SolrInputDocument $document
     */
    public function processLocation(Job $job,$document)
    {
        /* @var \Jobs\Entity\Location $location */
        $locations=$job->getLocations();
        foreach($locations as $location){

            $loc = new \SolrInputDocument();
            $loc->addField('entityName', 'location');

            if(is_object($location->getCoordinates())){
                $coordinate = Util::convertLocationCoordinates($location);
                $loc->addField('point', $coordinate);

                $loc->addField('latLon', $coordinate);

                $document->addField('locations', $coordinate);

                $document->addField('points', $coordinate);

                $loc->addField('id', $job->getId() . '-' . $coordinate);

                $loc->addField('city', $location->getCity());

                $loc->addField('country', $location->getCountry());

                $loc->addField('region', $location->getRegion());

                $loc->addField('postalCode', $location->getPostalCode());

                $document->addField('regionList',$location->getRegion());

                $document->addChildDocument($loc);

            }
            unset($loc);
        }
        $document->addField('location',$job->getLocation());

    }
}

1			<?php
2			/**
3			* YAWIK
4			*
5			* @filesource
6			* @copyright (c) 2013 - 2016 Cross Solution (http://cross-solution.de)
7			* @license MIT
8			*/
9
10			namespace Solr\Listener;
11
12
13			use Doctrine\Common\EventSubscriber;
14			use Doctrine\ODM\MongoDB\Event\LifecycleEventArgs;
15			use Doctrine\ODM\MongoDB\Events;
16			use Jobs\Entity\Job;
17			use Solr\Bridge\Manager;
18			use Solr\Bridge\Util;
19			use Zend\ServiceManager\ServiceLocatorInterface;
20
21			/**
22			* Class JobEventSubscriber
23			*
24			* @author Anthonius Munthi <[email protected]>
25			* @since 0.26
26			* @package Solr\Event\Listener
27			*/
28			class JobEventSubscriber implements EventSubscriber
29			{
30
31			/**
32			* @var Manager
33			*/
34			protected $solrManager;
35			/**
36			* JobEventSubscriber constructor.
37			* @param Manager $manager
38			*/
39			public function __construct(Manager $manager)
40			{
41			$this->solrManager = $manager;
42			}
43			/**
44			* Define what event this subscriber listen to
45			*
46			* @return array
47			*/
48			public function getSubscribedEvents()
49			{
50			return [
51			Events::postUpdate,
52			Events::postPersist,
53			];
54			}
55			public function consoleIndex(Job $job)
56			{
57			$this->updateIndex($job);
58			}
59			/**
60			* Handle doctrine post persist event
61			*
62			* @param LifecycleEventArgs $eventArgs
63			*/
64			public function postPersist(LifecycleEventArgs $eventArgs)
65			{
66			$document = $eventArgs->getDocument();
67			$this->updateIndex($document);
68			}
69			/**
70			* Handle doctrine postUpdate event
71			*
72			* @param LifecycleEventArgs $eventArgs
73			*/
74			public function postUpdate(LifecycleEventArgs $eventArgs)
75			{
76			$document = $eventArgs->getDocument();
77			$this->updateIndex($document);
78			}
79			/**
80			* @param ServiceLocatorInterface $serviceLocator
81			* @return mixed
82			*/
83			static public function factory(ServiceLocatorInterface $serviceLocator)
			0 ignored issues – show Coding Style introduced 2016-07-01 06:20 UTC by Report Bug Copy Issue Report As per PSR2, the `static` declaration should come after the visibility declaration. Loading history...
84			{
85			/* @var Manager $manager */
86			$manager = $serviceLocator->get('Solr/Manager');
87			return new self($manager);
88			}
89			/**
90			* @param $document
91			*/
92			protected function updateIndex($document)
93			{
94			if(!$document instanceof Job){
95			return;
96			}
97			$solrDoc = $this->generateInputDocument($document, new \SolrInputDocument());
98			try{
99			$this->solrManager->addDocument($solrDoc,$this->solrManager->getOptions()->getJobsPath());
100			}catch (\Exception $e){
101			// @TODO: What to do when the process failed?
102			}
103			}
104			/**
105			* Generate input document
106			*
107			* @param Job $job
108			* @param \SolrInputDocument $document
109			* @return \SolrInputDocument
110			*/
111			public function generateInputDocument(Job $job, $document)
112			{
113			$document->addField('id',$job->getId());
			0 ignored issues – show Bug introduced 2016-07-06 15:49 UTC by Report Bug Copy Issue Report The call to `addField()` misses a required argument `$fieldBoostValue`. This check looks for function calls that miss required arguments. Loading history...
114			$document->addField('entityName','job');
			0 ignored issues – show Bug introduced 2016-07-15 09:40 UTC by Report Bug Copy Issue Report The call to `addField()` misses a required argument `$fieldBoostValue`. This check looks for function calls that miss required arguments. Loading history...
115			$document->addField('title',$job->getTitle());
			0 ignored issues – show Bug introduced 2016-07-06 15:49 UTC by Report Bug Copy Issue Report The call to `addField()` misses a required argument `$fieldBoostValue`. This check looks for function calls that miss required arguments. Loading history...
116			$document->addField('applicationEmail',$job->getContactEmail());
			0 ignored issues – show Bug introduced 2016-07-06 15:49 UTC by Report Bug Copy Issue Report The call to `addField()` misses a required argument `$fieldBoostValue`. This check looks for function calls that miss required arguments. Loading history...
117			if ($job->getLink()) {
118			$document->addField('link', $job->getLink());
			0 ignored issues – show Bug introduced 2016-07-15 09:40 UTC by Report Bug Copy Issue Report The call to `addField()` misses a required argument `$fieldBoostValue`. This check looks for function calls that miss required arguments. Loading history...
119			$oldErrorReporting=error_reporting(0);
120			$dom = new \DOMDocument();
121			$dom->loadHTML($job->getLink());
122			error_reporting($oldErrorReporting);
123			$document->addField('html',$dom->saveHTML());
			0 ignored issues – show Bug introduced 2016-07-15 09:40 UTC by Report Bug Copy Issue Report The call to `addField()` misses a required argument `$fieldBoostValue`. This check looks for function calls that miss required arguments. Loading history...
124			}
125			if($job->getDateCreated()){
126			$document->addField('dateCreated',Util::convertDateTime($job->getDateCreated()));
			0 ignored issues – show Bug introduced 2016-07-07 15:20 UTC by Report Bug Copy Issue Report The call to `addField()` misses a required argument `$fieldBoostValue`. This check looks for function calls that miss required arguments. Loading history...
127			}
128			if($job->getDateModified()){
129			$document->addField('dateModified',Util::convertDateTime($job->getDateModified()));
			0 ignored issues – show Bug introduced 2016-07-07 15:20 UTC by Report Bug Copy Issue Report The call to `addField()` misses a required argument `$fieldBoostValue`. This check looks for function calls that miss required arguments. Loading history...
130			}
131			if($job->getDatePublishStart()){
132			$document->addField('datePublishStart',Util::convertDateTime($job->getDatePublishStart()));
			0 ignored issues – show Documentation introduced 2016-07-07 15:20 UTC by Report Bug Copy Issue Report `$job->getDatePublishStart()` is of type `string`, but the function expects a `object<DateTime>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Bug introduced 2016-07-07 15:20 UTC by Report Bug Copy Issue Report The call to `addField()` misses a required argument `$fieldBoostValue`. This check looks for function calls that miss required arguments. Loading history...
133			}
134			if($job->getDatePublishEnd()){
135			$document->addField('datePublishEnd',Util::convertDateTime($job->getDatePublishEnd()));
			0 ignored issues – show Documentation introduced 2016-07-07 15:20 UTC by Report Bug Copy Issue Report `$job->getDatePublishEnd()` is of type `string`, but the function expects a `object<DateTime>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Bug introduced 2016-07-07 15:20 UTC by Report Bug Copy Issue Report The call to `addField()` misses a required argument `$fieldBoostValue`. This check looks for function calls that miss required arguments. Loading history...
136			}
137			$document->addField('isActive',$job->isActive());
			0 ignored issues – show Bug introduced 2016-07-06 15:49 UTC by Report Bug Copy Issue Report The call to `addField()` misses a required argument `$fieldBoostValue`. This check looks for function calls that miss required arguments. Loading history...
138			$document->addField('lang',$job->getLanguage());
			0 ignored issues – show Bug introduced 2016-07-06 15:49 UTC by Report Bug Copy Issue Report The call to `addField()` misses a required argument `$fieldBoostValue`. This check looks for function calls that miss required arguments. Loading history...
139			$this->processLocation($job,$document);
140			if(!is_null($job->getOrganization())){
141			try {
142			$this->processOrganization($job,$document);
143			}catch (\Exception $e){
144			// @TODO: What to do when the process failed?
145			}
146			}
147			return $document;
148			}
149			/**
150			* Processing organization part
151			*
152			* @param Job $job
153			* @param \SolrInputDocument $document
154			*/
155			public function processOrganization(Job $job,$document)
156			{
157			if(!is_null($job->getOrganization()->getImage())){
158			$uri = $job->getOrganization()->getImage()->getUri();
159			$document->addField('companyLogo',$uri);
			0 ignored issues – show Bug introduced 2016-07-06 15:49 UTC by Report Bug Copy Issue Report The call to `addField()` misses a required argument `$fieldBoostValue`. This check looks for function calls that miss required arguments. Loading history...
160			}
161			$document->addField('organizationName',$job->getOrganization()->getOrganizationName()->getName());
			0 ignored issues – show Bug introduced 2016-07-06 15:49 UTC by Report Bug Copy Issue Report The call to `addField()` misses a required argument `$fieldBoostValue`. This check looks for function calls that miss required arguments. Loading history...
162			$document->addField('organizationId',$job->getOrganization()->getId());
			0 ignored issues – show Bug introduced 2016-07-06 15:49 UTC by Report Bug Copy Issue Report The call to `addField()` misses a required argument `$fieldBoostValue`. This check looks for function calls that miss required arguments. Loading history...
163			}
164
165			/**
166			* Processing location part
167			* @param Job $job
168			* @param \SolrInputDocument $document
169			*/
170			public function processLocation(Job $job,$document)
171			{
172			/* @var \Jobs\Entity\Location $location */
173			$locations=$job->getLocations();
174			foreach($locations as $location){
175
176			$loc = new \SolrInputDocument();
177			$loc->addField('entityName', 'location');
			0 ignored issues – show Bug introduced 2016-07-15 09:40 UTC by Report Bug Copy Issue Report The call to `addField()` misses a required argument `$fieldBoostValue`. This check looks for function calls that miss required arguments. Loading history...
178			if(is_object($location->getCoordinates())){
179			$coordinate = Util::convertLocationCoordinates($location);
180			$loc->addField('point', $coordinate);
			0 ignored issues – show Bug introduced 2016-07-15 09:40 UTC by Report Bug Copy Issue Report The call to `addField()` misses a required argument `$fieldBoostValue`. This check looks for function calls that miss required arguments. Loading history...
181			$loc->addField('latLon', $coordinate);
			0 ignored issues – show Bug introduced 2016-07-15 09:40 UTC by Report Bug Copy Issue Report The call to `addField()` misses a required argument `$fieldBoostValue`. This check looks for function calls that miss required arguments. Loading history...
182			$document->addField('locations', $coordinate);
			0 ignored issues – show Bug introduced 2016-07-07 12:44 UTC by Report Bug Copy Issue Report The call to `addField()` misses a required argument `$fieldBoostValue`. This check looks for function calls that miss required arguments. Loading history...
183			$document->addField('points', $coordinate);
			0 ignored issues – show Bug introduced 2016-07-15 09:40 UTC by Report Bug Copy Issue Report The call to `addField()` misses a required argument `$fieldBoostValue`. This check looks for function calls that miss required arguments. Loading history...
184			$loc->addField('id', $job->getId() . '-' . $coordinate);
			0 ignored issues – show Bug introduced 2016-07-15 09:40 UTC by Report Bug Copy Issue Report The call to `addField()` misses a required argument `$fieldBoostValue`. This check looks for function calls that miss required arguments. Loading history...
185			$loc->addField('city', $location->getCity());
			0 ignored issues – show Bug introduced 2016-07-15 09:40 UTC by Report Bug Copy Issue Report The call to `addField()` misses a required argument `$fieldBoostValue`. This check looks for function calls that miss required arguments. Loading history...
186			$loc->addField('country', $location->getCountry());
			0 ignored issues – show Bug introduced 2016-07-15 09:40 UTC by Report Bug Copy Issue Report The call to `addField()` misses a required argument `$fieldBoostValue`. This check looks for function calls that miss required arguments. Loading history...
187			$loc->addField('region', $location->getRegion());
			0 ignored issues – show Bug introduced 2016-07-15 09:40 UTC by Report Bug Copy Issue Report The call to `addField()` misses a required argument `$fieldBoostValue`. This check looks for function calls that miss required arguments. Loading history...
188			$loc->addField('postalCode', $location->getPostalCode());
			0 ignored issues – show Bug introduced 2016-07-06 15:49 UTC by Report Bug Copy Issue Report The call to `addField()` misses a required argument `$fieldBoostValue`. This check looks for function calls that miss required arguments. Loading history...
189			$document->addField('regionList',$location->getRegion());
			0 ignored issues – show Bug introduced 2016-07-06 15:49 UTC by Report Bug Copy Issue Report The call to `addField()` misses a required argument `$fieldBoostValue`. This check looks for function calls that miss required arguments. Loading history...
190			$document->addChildDocument($loc);
			0 ignored issues – show Bug introduced 2016-07-15 09:40 UTC by Report Bug Copy Issue Report The method `addChildDocument()` does not seem to exist on `object<SolrInputDocument>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
191			}
192			unset($loc);
193			}
194			$document->addField('location',$job->getLocation());
			0 ignored issues – show Bug introduced 2016-07-06 15:49 UTC by Report Bug Copy Issue Report The call to `addField()` misses a required argument `$fieldBoostValue`. This check looks for function calls that miss required arguments. Loading history...
195			}
196			}

cross-solution / YAWIK

Pull Request — develop (#254)

JobEventSubscriber::updateIndex() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like