Completed
Push — master ( 994c5c...018398 )
by Tim
10s
created

SqlStatementKeys   A

Complexity

Total Complexity 2

Size/Duplication

Total Lines 153
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 1

Test Coverage

Coverage 0%

Importance

Changes 0
Metric Value
wmc 2
lcom 0
cbo 1
dl 0
loc 153
ccs 0
cts 7
cp 0
rs 10
c 0
b 0
f 0

1 Method

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 11 2
1
<?php
2
3
/**
4
 * TechDivision\Import\Product\UrlRewrite\Utils\SqlStatementKeys
5
 *
6
 * NOTICE OF LICENSE
7
 *
8
 * This source file is subject to the Open Software License (OSL 3.0)
9
 * that is available through the world-wide-web at this URL:
10
 * http://opensource.org/licenses/osl-3.0.php
11
 *
12
 * PHP version 5
13
 *
14
 * @author    Tim Wagner <[email protected]>
15
 * @copyright 2016 TechDivision GmbH <[email protected]>
16
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
17
 * @link      https://github.com/techdivision/import-product-url-rewrite
18
 * @link      http://www.techdivision.com
19
 */
20
21
namespace TechDivision\Import\Product\UrlRewrite\Utils;
22
23
/**
24
 * Utility class with the SQL statements to use.
25
 *
26
 * @author    Tim Wagner <[email protected]>
27
 * @copyright 2016 TechDivision GmbH <[email protected]>
28
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
29
 * @link      https://github.com/techdivision/import-product-url-rewrite
30
 * @link      http://www.techdivision.com
31
 */
32
class SqlStatementKeys extends \TechDivision\Import\Product\Utils\SqlStatementKeys
33
{
34
35
    /**
36
     * The SQL statement to create new URL rewrites.
37
     *
38
     * @var string
39
     */
40
    const CREATE_URL_REWRITE = 'create.url_rewrite';
41
42
    /**
43
     * The SQL statement to update an existing URL rewrite.
44
     *
45
     * @var string
46
     */
47
    const UPDATE_URL_REWRITE = 'update.url_rewrite';
48
49
    /**
50
     * The SQL statement to create new URL rewrite product category relations.
51
     *
52
     * @var string
53
     */
54
    const CREATE_URL_REWRITE_PRODUCT_CATEGORY = 'create.url_rewrite_product_category';
55
56
    /**
57
     * The SQL statement to update an existing URL rewrite product category relation.
58
     *
59
     * @var string
60
     */
61
    const UPDATE_URL_REWRITE_PRODUCT_CATEGORY = 'update.url_rewrite_product_category';
62
63
    /**
64
     * The SQL statement to remove a existing URL rewrite product category relation.
65
     *
66
     * @var string
67
     */
68
    const DELETE_URL_REWRITE_PRODUCT_CATEGORY = 'delete.url_rewrite_product_category';
69
70
    /**
71
     * The SQL statement to load the URL rewrite product category relation with the passed ID.
72
     *
73
     * @var string
74
     */
75
    const URL_REWRITE_PRODUCT_CATEGORY = 'ur_rewrite_product_category';
76
77
    /**
78
     * The SQL statement to load the URL rewrites by a SKU.
79
     *
80
     * @var string
81
     */
82
    const URL_REWRITES_BY_SKU = 'ur_rewrites.by.sku';
83
84
    /**
85
     * The SQL statement to load the URL rewrite product category relations for the passed SKU.
86
     *
87
     * @var string
88
     */
89
    const URL_REWRITE_PRODUCT_CATEGORIES_BY_SKU = 'ur_rewrite_product_categories.by.sku';
90
91
    /**
92
     * The SQL statements.
93
     *
94
     * @var array
95
     */
96
    private $statements = array(
97
        SqlStatementKeys::CREATE_URL_REWRITE =>
98
            'INSERT
99
               INTO url_rewrite
100
                    (entity_type,
101
                     entity_id,
102
                     request_path,
103
                     target_path,
104
                     redirect_type,
105
                     store_id,
106
                     description,
107
                     is_autogenerated,
108
                     metadata)
109
            VALUES (:entity_type,
110
                    :entity_id,
111
                    :request_path,
112
                    :target_path,
113
                    :redirect_type,
114
                    :store_id,
115
                    :description,
116
                    :is_autogenerated,
117
                    :metadata)',
118
        SqlStatementKeys::UPDATE_URL_REWRITE =>
119
            'UPDATE url_rewrite
120
                SET entity_type = :entity_type,
121
                    entity_id = :entity_id,
122
                    request_path = :request_path,
123
                    target_path = :target_path,
124
                    redirect_type = :redirect_type,
125
                    store_id = :store_id,
126
                    description = :description,
127
                    is_autogenerated = :is_autogenerated,
128
                    metadata = :metadata
129
              WHERE url_rewrite_id = :url_rewrite_id',
130
        SqlStatementKeys::CREATE_URL_REWRITE_PRODUCT_CATEGORY =>
131
            'INSERT
132
               INTO catalog_url_rewrite_product_category
133
                    (url_rewrite_id,
134
                     category_id,
135
                     product_id)
136
             VALUES (:url_rewrite_id,
137
                     :category_id,
138
                     :product_id)',
139
        SqlStatementKeys::UPDATE_URL_REWRITE_PRODUCT_CATEGORY =>
140
            'UPDATE catalog_url_rewrite_product_category
141
                SET category_id = :category_id,
142
                    product_id = :product_id
143
              WHERE url_rewrite_id = :url_rewrite_id',
144
        SqlStatementKeys::DELETE_URL_REWRITE_PRODUCT_CATEGORY =>
145
            'DELETE
146
               FROM catalog_url_rewrite_product_category
147
              WHERE url_rewrite_id = :url_rewrite_id',
148
        SqlStatementKeys::URL_REWRITE_PRODUCT_CATEGORY =>
149
            'SELECT *
150
               FROM catalog_url_rewrite_product_category
151
              WHERE url_rewrite_id = :url_rewrite_id',
152
        SqlStatementKeys::URL_REWRITES_BY_SKU =>
153
            'SELECT t2.*
154
               FROM catalog_product_entity t1,
155
                    url_rewrite t2
156
              WHERE t1.sku = :sku
157
                AND t2.entity_id = t1.entity_id
158
                AND t2.entity_type = \'product\'',
159
        SqlStatementKeys::URL_REWRITE_PRODUCT_CATEGORIES_BY_SKU =>
160
            'SELECT t3.*
161
               FROM catalog_product_entity t1,
162
                    url_rewrite t2,
163
                    catalog_url_rewrite_product_category t3
164
              WHERE t1.sku = :sku
165
                AND t2.entity_id = t1.entity_id
166
                AND t2.entity_type = \'product\'
167
                AND t3.url_rewrite_id = t2.url_rewrite_id'
168
    );
169
170
    /**
171
     * Initialize the the SQL statements.
172
     */
173
    public function __construct()
174
    {
175
176
        // call the parent constructor
177
        parent::__construct();
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class TechDivision\Import\Product\Utils\SqlStatementKeys as the method __construct() does only exist in the following sub-classes of TechDivision\Import\Product\Utils\SqlStatementKeys: TechDivision\Import\Prod...\Utils\SqlStatementKeys. Maybe you want to instanceof check for one of these explicitly?

Let’s take a look at an example:

abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the parent class:

    abstract class User
    {
        /** @return string */
        abstract public function getPassword();
    
        /** @return string */
        abstract public function getDisplayName();
    }
    
Loading history...
178
179
        // merge the class statements
180
        foreach ($this->statements as $key => $statement) {
181
            $this->preparedStatements[$key] = $statement;
0 ignored issues
show
Bug introduced by
The property preparedStatements does not seem to exist. Did you mean statements?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
182
        }
183
    }
184
}
185