e5c0f158-e116-43f4-afb8-e0d95035e4b2

Committed 07 Aug 2024 10:06AM UTC coverage: 91.753% (+0.04%) from 91.716%

Build # e5c0f158-e116-43f4-afb8-e0d95035e4b2

Build Type

push

circleci

Committed by

aimeos

Commit Message

Simplifies coupon manager

Run Details

21 of 21 new or added lines in 1 file covered. (100.0%)

46 existing lines in 3 files now uncovered.

10825 of 11798 relevant lines covered (91.75%)

57.95 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

71.95

/src/MShop/Common/Manager/Methods.php

<?php

/**
 * @license LGPLv3, https://opensource.org/licenses/LGPL-3.0
 * @copyright Aimeos (aimeos.org), 2023
 * @package MShop
 * @subpackage Common
 */


namespace Aimeos\MShop\Common\Manager;


/**
 * Method trait for managers
 *
 * @package MShop
 * @subpackage Common
 */
trait Methods
{
        private ?\Aimeos\MShop\Common\Manager\Iface $object = null;
        private array $filterFcn = [];
        private string $domain;
        private string $subpath;


        /**
         * Returns the alias of the used table
         *
         * @return string Table alias e.g. "mprolity"
         */
        abstract protected function getAlias() : string;


        /**
         * Adds a filter callback for an item type
         *
         * @param string $iface Interface name of the item to apply the filter to
         * @param \Closure $fcn Anonymous function receiving the item to check as first parameter
         */
        public function addFilter( string $iface, \Closure $fcn )
        {
                if( !isset( $this->filterFcn[$iface] ) ) {
                        $this->filterFcn[$iface] = [];
                }

                $this->filterFcn[$iface][] = $fcn;
        }


        /**
         * Returns the class names of the manager and used decorators.
         *
         * @return array List of class names
         */
        public function classes() : array
        {
                return [get_class( $this )];
        }


        /**
         * Removes old entries from the storage
         *
         * @param iterable $siteids List of IDs for sites whose entries should be deleted
         * @return \Aimeos\MShop\Common\Manager\Iface Manager object for chaining method calls
         */
        public function clear( iterable $siteids ) : \Aimeos\MShop\Common\Manager\Iface
        {
                return $this;
        }


        /**
         * Creates a new empty item instance
         *
         * @param array $values Values the item should be initialized with
         * @return \Aimeos\MShop\Attribute\Item\Iface New attribute item object
         */
        public function create( array $values = [] ) : \Aimeos\MShop\Common\Item\Iface
        {
                return new \Aimeos\MShop\Common\Item\Base( $this->getPrefix(), $values );
        }


        /**
         * Creates a new cursor based on the filter criteria
         *
         * @param \Aimeos\Base\Criteria\Iface $filter Criteria object with conditions, sortations, etc.
         * @return \Aimeos\MShop\Common\Cursor\Iface Cursor object
         */
        public function cursor( \Aimeos\Base\Criteria\Iface $filter ) : \Aimeos\MShop\Common\Cursor\Iface
        {
                return new \Aimeos\MShop\Common\Cursor\Standard( $filter );
        }


        /**
         * Deletes one or more items.
         *
         * @param \Aimeos\MShop\Common\Item\Iface|\Aimeos\Map|array|string $items Item object, ID or a list of them
         * @return \Aimeos\MShop\Common\Manager\Iface Manager object for chaining method calls
         */
        public function delete( $items ) : \Aimeos\MShop\Common\Manager\Iface
        {
                return $this;
        }


        /**
         * Creates a filter object.
         *
         * @param bool|null $default Add default criteria or NULL for relaxed default criteria
         * @param bool $site TRUE for adding site criteria to limit items by the site of related items
         * @return \Aimeos\Base\Criteria\Iface Returns the filter object
         */
        public function filter( ?bool $default = false, bool $site = false ) : \Aimeos\Base\Criteria\Iface
        {
                throw new \LogicException( 'Not implemented' );
        }


        /**
         * Returns the item specified by its ID
         *
         * @param string $id Id of item
         * @param string[] $ref List of domains to fetch list items and referenced items for
         * @param bool|null $default Add default criteria or NULL for relaxed default criteria
         * @return \Aimeos\MShop\Common\Item\Iface Item object
         */
        public function get( string $id, array $ref = [], ?bool $default = false ) : \Aimeos\MShop\Common\Item\Iface
        {
                throw new \LogicException( 'Not implemented' );
        }


        /**
         * Returns the available manager types
         *
         * @param bool $withsub Return also the resource type of sub-managers if true
         * @return string[] Type of the manager and submanagers, subtypes are separated by slashes
         */
        public function getResourceType( bool $withsub = true ) : array
        {
                return [$this->getManagerPath()];
        }


        /**
         * Returns the additional column/search definitions
         *
         * @return array Associative list of column names as keys and items implementing \Aimeos\Base\Criteria\Attribute\Iface
         */
        public function getSaveAttributes() : array
        {
                return [];
        }


        /**
         * Returns the attributes that can be used for searching.
         *
         * @param bool $withsub Return also attributes of sub-managers if true
         * @return \Aimeos\Base\Criteria\Attribute\Iface[] List of attribute items
         */
        public function getSearchAttributes( bool $withsub = true ) : array
        {
                return [];
        }


        /**
         * Returns a new manager for attribute extensions
         *
         * @param string $manager Name of the sub manager type in lower case
         * @param string|null $name Name of the implementation, will be from configuration (or Default) if null
         * @return \Aimeos\MShop\Common\Manager\Iface Manager for different extensions, e.g Type, List's etc.
         */
        public function getSubManager( string $manager, string $name = null ) : \Aimeos\MShop\Common\Manager\Iface
        {
                throw new \LogicException( 'Not implemented' );
        }


        /**
         * Iterates over all matched items and returns the found ones
         *
         * @param \Aimeos\MShop\Common\Cursor\Iface $cursor Cursor object with filter, domains and cursor
         * @param string[] $ref List of domains whose items should be fetched too
         * @return \Aimeos\Map|null List of items implementing \Aimeos\MShop\Common\Item\Iface with ids as keys
         */
        public function iterate( \Aimeos\MShop\Common\Cursor\Iface $cursor, array $ref = [] ) : ?\Aimeos\Map
        {
                return null;
        }


        /**
         * Adds or updates an item object or a list of them.
         *
         * @param \Aimeos\MShop\Common\Item\Iface[]|\Aimeos\MShop\Common\Item\Iface $items Item or list of items whose data should be saved
         * @param bool $fetch True if the new ID should be returned in the item
         * @return \Aimeos\MShop\Common\Item\Iface[]|\Aimeos\MShop\Common\Item\Iface Saved item or items
         */
        public function save( $items, bool $fetch = true )
        {
                return $items;
        }


        /**
         * Searches for all items matching the given critera.
         *
         * @param \Aimeos\Base\Criteria\Iface $filter Criteria object with conditions, sortations, etc.
         * @param string[] $ref List of domains to fetch list items and referenced items for
         * @param int &$total Number of items that are available in total
         * @return \Aimeos\Map List of items implementing \Aimeos\MShop\Common\Item\Iface with ids as keys
         */
        public function search( \Aimeos\Base\Criteria\Iface $filter, array $ref = [], int &$total = null ) : \Aimeos\Map
        {
                return map();
        }


        /**
         * Injects the reference of the outmost object
         *
         * @param \Aimeos\MShop\Common\Manager\Iface $object Reference to the outmost manager or decorator
         * @return \Aimeos\MShop\Common\Manager\Iface Manager object for chaining method calls
         */
        public function setObject( \Aimeos\MShop\Common\Manager\Iface $object ) : \Aimeos\MShop\Common\Manager\Iface
        {
                $this->object = $object;
                return $this;
        }


        /**
         * Starts a database transaction on the connection identified by the given name
         *
         * @return \Aimeos\MShop\Common\Manager\Iface Manager object for chaining method calls
         */
        public function begin() : \Aimeos\MShop\Common\Manager\Iface
        {
                return $this;
        }


        /**
         * Commits the running database transaction on the connection identified by the given name
         *
         * @return \Aimeos\MShop\Common\Manager\Iface Manager object for chaining method calls
         */
        public function commit() : \Aimeos\MShop\Common\Manager\Iface
        {
                return $this;
        }


        /**
         * Rolls back the running database transaction on the connection identified by the given name
         *
         * @return \Aimeos\MShop\Common\Manager\Iface Manager object for chaining method calls
         */
        public function rollback() : \Aimeos\MShop\Common\Manager\Iface
        {
                return $this;
        }


        /**
         * Applies the filters for the item type to the item
         *
         * @param object $item Item to apply the filter to
         * @return object|null Object if the item should be used, null if not
         */
        protected function applyFilter( $item )
        {
                foreach( $this->filterFcn as $iface => $fcnList )
                {
                        if( is_object( $item ) && $item instanceof $iface )
                        {
                                foreach( $fcnList as $fcn )
                                {
                                        if( $fcn( $item ) === null ) {
                                                return null;
                                        }
                                }
                        }
                }

                return $item;
        }


        /**
         * Creates the criteria attribute items from the list of entries
         *
         * @param array $list Associative array of code as key and array with properties as values
         * @return \Aimeos\Base\Criteria\Attribute\Standard[] List of criteria attribute items
         */
        protected function createAttributes( array $list ) : array
        {
                $attr = [];

                foreach( $list as $key => $fields )
                {
                        $fields['code'] = $fields['code'] ?? $key;
                        $fields['internalcode'] = $fields['internalcode'] ?? $key;
                        $attr[$key] = new \Aimeos\Base\Criteria\Attribute\Standard( $fields );
                }

                return $attr;
        }


        /**
         * Returns the full configuration key for the passed last part
         *
         * @param string $name Configuration last part
         * @return string Full configuration key
         */
        protected function getConfigKey( string $name ) : string
        {
                $subPath = $this->getSubPath();
                return 'mshop/' . $this->getDomain() . '/manager/' . ( $subPath ? $subPath . '/' : '' ) . $name;
        }


        /**
         * Returns the manager domain
         *
         * @return string Manager domain e.g. "product"
         */
        protected function getDomain() : string
        {
                if( !isset( $this->domain ) ) {
                        $this->initMethods();
                }

                return $this->domain;
        }


        /**
         * Returns the manager path
         *
         * @return string Manager path e.g. "product/lists/type"
         */
        protected function getManagerPath() : string
        {
                $subPath = $this->getSubPath();
                return $this->getDomain() . ( $subPath ? '/' . $subPath : '' );
        }


        /**
         * Returns the prefix for the item properties and search keys.
         *
         * @return string Prefix for the item properties and search keys
         */
        protected function getPrefix() : string
        {
                return '';
        }


        /**
         * Returns the attribute helper functions for searching defined by the manager.
         *
         * @param \Aimeos\Base\Criteria\Attribute\Iface[] $attributes List of search attribute items
         * @return array Associative array of attribute code and helper function
         */
        protected function getSearchFunctions( array $attributes ) : array
        {
                $list = [];
                $iface = \Aimeos\Base\Criteria\Attribute\Iface::class;

                foreach( $attributes as $key => $item )
                {
                        if( $item instanceof $iface ) {
                                $list[$item->getCode()] = $item->getFunction();
                        } else if( isset( $item['code'] ) ) {
                                $list[$item['code']] = $item['function'] ?? null;
                        } else {
                                throw new \Aimeos\MShop\Exception( sprintf( 'Invalid attribute at position "%1$d"', $key ) );
                        }
                }

                return $list;
        }


        /**
         * Returns the item search key for the passed name
         *
         * @return string Item prefix e.g. "product.lists.type.id"
         */
        protected function getSearchKey( string $name = '' ) : string
        {
                $subPath = $this->getSubPath();
                return $this->getDomain() . ( $subPath ? '.' . $subPath : '' ) . ( $name ? '.' . $name : '' );
        }


        /**
         * Returns the attribute translations for searching defined by the manager.
         *
         * @param \Aimeos\Base\Criteria\Attribute\Iface[] $attributes List of search attribute items
         * @return array Associative array of attribute code and internal attribute code
         */
        protected function getSearchTranslations( array $attributes ) : array
        {
                $translations = [];
                $alias = $this->getAlias();
                $iface = \Aimeos\Base\Criteria\Attribute\Iface::class;

                foreach( $attributes as $key => $item )
                {
                        if( $alias && strpos( $item->getInternalCode(), '"' ) === false ) {
                                $translations[$item->getCode()] = $alias . '."' . $item->getInternalCode() . '"';
                        } else {
                                $translations[$item->getCode()] = $item->getInternalCode();
                        }
                }

                return $translations;
        }


        /**
         * Returns the attribute types for searching defined by the manager.
         *
         * @param \Aimeos\Base\Criteria\Attribute\Iface[] $attributes List of search attribute items
         * @return array Associative array of attribute code and internal attribute type
         */
        protected function getSearchTypes( array $attributes ) : array
        {
                $types = [];
                $iface = \Aimeos\Base\Criteria\Attribute\Iface::class;

                foreach( $attributes as $key => $item )
                {
                        if( $item instanceof $iface ) {
                                $types[$item->getCode()] = $item->getInternalType();
                        } else if( isset( $item['code'] ) ) {
                                $types[$item['code']] = $item['internaltype'];
                        } else {
                                throw new \Aimeos\MShop\Exception( sprintf( 'Invalid attribute at position "%1$d"', $key ) );
                        }
                }

                return $types;
        }


        /**
         * Returns the manager domain sub-path
         *
         * @return string Manager domain sub-path e.g. "lists/type"
         */
        protected function getSubPath() : string
        {
                if( !isset( $this->subpath ) ) {
                        $this->initMethods();
                }

                return $this->subpath;
        }


        /**
         * Returns the name of the used table
         *
         * @return string Table name e.g. "mshop_product_lists_type"
         */
        protected function getTable() : string
        {
                $subPath = $this->getSubPath();
                return 'mshop_' . $this->getDomain() . ( $subPath ? '_' . str_replace( '/', '_', $subPath ) : '' );
        }


        /**
         * Initializes the trait
         */
        protected function initMethods()
        {
                $parts = explode( '\\', strtolower( current( $this->classes() ) ) );
                array_shift( $parts ); array_shift( $parts ); // remove "Aimeos\MShop"
                array_pop( $parts );

                $this->domain = array_shift( $parts ) ?: '';
                array_shift( $parts ); // remove "manager"
                $this->subpath = join( '/', $parts );
        }


        /**
         * Returns the outmost decorator of the decorator stack
         *
         * @return \Aimeos\MShop\Common\Manager\Iface Outmost decorator object
         */
        protected function object() : \Aimeos\MShop\Common\Manager\Iface
        {
                return $this->object ?? $this;
        }
}

1	<?php
2
3	/**
4	* @license LGPLv3, https://opensource.org/licenses/LGPL-3.0
5	* @copyright Aimeos (aimeos.org), 2023
6	* @package MShop
7	* @subpackage Common
8	*/
9
10
11	namespace Aimeos\MShop\Common\Manager;
12
13
14	/**
15	* Method trait for managers
16	*
17	* @package MShop
18	* @subpackage Common
19	*/
20	trait Methods
21	{
22	private ?\Aimeos\MShop\Common\Manager\Iface $object = null;
23	private array $filterFcn = [];
24	private string $domain;
25	private string $subpath;
26
27
28	/**
29	* Returns the alias of the used table
30	*
31	* @return string Table alias e.g. "mprolity"
32	*/
33	abstract protected function getAlias() : string;
34
35
36	/**
37	* Adds a filter callback for an item type
38	*
39	* @param string $iface Interface name of the item to apply the filter to
40	* @param \Closure $fcn Anonymous function receiving the item to check as first parameter
41	*/
42	public function addFilter( string $iface, \Closure $fcn )
43	{
44	if( !isset( $this->filterFcn[$iface] ) ) {	1✔
45	$this->filterFcn[$iface] = [];	1✔
46	}
47
48	$this->filterFcn[$iface][] = $fcn;	1✔
49	}
50
51
52	/**
53	* Returns the class names of the manager and used decorators.
54	*
55	* @return array List of class names
56	*/
57	public function classes() : array
58	{
59	return [get_class( $this )];	1,771✔
60	}
61
62
63	/**
64	* Removes old entries from the storage
65	*
66	* @param iterable $siteids List of IDs for sites whose entries should be deleted
67	* @return \Aimeos\MShop\Common\Manager\Iface Manager object for chaining method calls
68	*/
69	public function clear( iterable $siteids ) : \Aimeos\MShop\Common\Manager\Iface
70	{
UNCOV 71	return $this;	×
72	}
73
74
75	/**
76	* Creates a new empty item instance
77	*
78	* @param array $values Values the item should be initialized with
79	* @return \Aimeos\MShop\Attribute\Item\Iface New attribute item object
80	*/
81	public function create( array $values = [] ) : \Aimeos\MShop\Common\Item\Iface
82	{
UNCOV 83	return new \Aimeos\MShop\Common\Item\Base( $this->getPrefix(), $values );	×
84	}
85
86
87	/**
88	* Creates a new cursor based on the filter criteria
89	*
90	* @param \Aimeos\Base\Criteria\Iface $filter Criteria object with conditions, sortations, etc.
91	* @return \Aimeos\MShop\Common\Cursor\Iface Cursor object
92	*/
93	public function cursor( \Aimeos\Base\Criteria\Iface $filter ) : \Aimeos\MShop\Common\Cursor\Iface
94	{
95	return new \Aimeos\MShop\Common\Cursor\Standard( $filter );	9✔
96	}
97
98
99	/**
100	* Deletes one or more items.
101	*
102	* @param \Aimeos\MShop\Common\Item\Iface\|\Aimeos\Map\|array\|string $items Item object, ID or a list of them
103	* @return \Aimeos\MShop\Common\Manager\Iface Manager object for chaining method calls
104	*/
105	public function delete( $items ) : \Aimeos\MShop\Common\Manager\Iface
106	{
UNCOV 107	return $this;	×
108	}
109
110
111	/**
112	* Creates a filter object.
113	*
114	* @param bool\|null $default Add default criteria or NULL for relaxed default criteria
115	* @param bool $site TRUE for adding site criteria to limit items by the site of related items
116	* @return \Aimeos\Base\Criteria\Iface Returns the filter object
117	*/
118	public function filter( ?bool $default = false, bool $site = false ) : \Aimeos\Base\Criteria\Iface
119	{
UNCOV 120	throw new \LogicException( 'Not implemented' );	×
121	}
122
123
124	/**
125	* Returns the item specified by its ID
126	*
127	* @param string $id Id of item
128	* @param string[] $ref List of domains to fetch list items and referenced items for
129	* @param bool\|null $default Add default criteria or NULL for relaxed default criteria
130	* @return \Aimeos\MShop\Common\Item\Iface Item object
131	*/
132	public function get( string $id, array $ref = [], ?bool $default = false ) : \Aimeos\MShop\Common\Item\Iface
133	{
UNCOV 134	throw new \LogicException( 'Not implemented' );	×
135	}
136
137
138	/**
139	* Returns the available manager types
140	*
141	* @param bool $withsub Return also the resource type of sub-managers if true
142	* @return string[] Type of the manager and submanagers, subtypes are separated by slashes
143	*/
144	public function getResourceType( bool $withsub = true ) : array
145	{
UNCOV 146	return [$this->getManagerPath()];	×
147	}
148
149
150	/**
151	* Returns the additional column/search definitions
152	*
153	* @return array Associative list of column names as keys and items implementing \Aimeos\Base\Criteria\Attribute\Iface
154	*/
155	public function getSaveAttributes() : array
156	{
157	return [];	116✔
158	}
159
160
161	/**
162	* Returns the attributes that can be used for searching.
163	*
164	* @param bool $withsub Return also attributes of sub-managers if true
165	* @return \Aimeos\Base\Criteria\Attribute\Iface[] List of attribute items
166	*/
167	public function getSearchAttributes( bool $withsub = true ) : array
168	{
UNCOV 169	return [];	×
170	}
171
172
173	/**
174	* Returns a new manager for attribute extensions
175	*
176	* @param string $manager Name of the sub manager type in lower case
177	* @param string\|null $name Name of the implementation, will be from configuration (or Default) if null
178	* @return \Aimeos\MShop\Common\Manager\Iface Manager for different extensions, e.g Type, List's etc.
179	*/
180	public function getSubManager( string $manager, string $name = null ) : \Aimeos\MShop\Common\Manager\Iface
181	{
UNCOV 182	throw new \LogicException( 'Not implemented' );	×
183	}
184
185
186	/**
187	* Iterates over all matched items and returns the found ones
188	*
189	* @param \Aimeos\MShop\Common\Cursor\Iface $cursor Cursor object with filter, domains and cursor
190	* @param string[] $ref List of domains whose items should be fetched too
191	* @return \Aimeos\Map\|null List of items implementing \Aimeos\MShop\Common\Item\Iface with ids as keys
192	*/
193	public function iterate( \Aimeos\MShop\Common\Cursor\Iface $cursor, array $ref = [] ) : ?\Aimeos\Map
194	{
UNCOV 195	return null;	×
196	}
197
198
199	/**
200	* Adds or updates an item object or a list of them.
201	*
202	* @param \Aimeos\MShop\Common\Item\Iface[]\|\Aimeos\MShop\Common\Item\Iface $items Item or list of items whose data should be saved
203	* @param bool $fetch True if the new ID should be returned in the item
204	* @return \Aimeos\MShop\Common\Item\Iface[]\|\Aimeos\MShop\Common\Item\Iface Saved item or items
205	*/
206	public function save( $items, bool $fetch = true )
207	{
UNCOV 208	return $items;	×
209	}
210
211
212	/**
213	* Searches for all items matching the given critera.
214	*
215	* @param \Aimeos\Base\Criteria\Iface $filter Criteria object with conditions, sortations, etc.
216	* @param string[] $ref List of domains to fetch list items and referenced items for
217	* @param int &$total Number of items that are available in total
218	* @return \Aimeos\Map List of items implementing \Aimeos\MShop\Common\Item\Iface with ids as keys
219	*/
220	public function search( \Aimeos\Base\Criteria\Iface $filter, array $ref = [], int &$total = null ) : \Aimeos\Map
221	{
UNCOV 222	return map();	×
223	}
224
225
226	/**
227	* Injects the reference of the outmost object
228	*
229	* @param \Aimeos\MShop\Common\Manager\Iface $object Reference to the outmost manager or decorator
230	* @return \Aimeos\MShop\Common\Manager\Iface Manager object for chaining method calls
231	*/
232	public function setObject( \Aimeos\MShop\Common\Manager\Iface $object ) : \Aimeos\MShop\Common\Manager\Iface
233	{
234	$this->object = $object;	1,203✔
235	return $this;	1,203✔
236	}
237
238
239	/**
240	* Starts a database transaction on the connection identified by the given name
241	*
242	* @return \Aimeos\MShop\Common\Manager\Iface Manager object for chaining method calls
243	*/
244	public function begin() : \Aimeos\MShop\Common\Manager\Iface
245	{
UNCOV 246	return $this;	×
247	}
248
249
250	/**
251	* Commits the running database transaction on the connection identified by the given name
252	*
253	* @return \Aimeos\MShop\Common\Manager\Iface Manager object for chaining method calls
254	*/
255	public function commit() : \Aimeos\MShop\Common\Manager\Iface
256	{
UNCOV 257	return $this;	×
258	}
259
260
261	/**
262	* Rolls back the running database transaction on the connection identified by the given name
263	*
264	* @return \Aimeos\MShop\Common\Manager\Iface Manager object for chaining method calls
265	*/
266	public function rollback() : \Aimeos\MShop\Common\Manager\Iface
267	{
UNCOV 268	return $this;	×
269	}
270
271
272	/**
273	* Applies the filters for the item type to the item
274	*
275	* @param object $item Item to apply the filter to
276	* @return object\|null Object if the item should be used, null if not
277	*/
278	protected function applyFilter( $item )
279	{
280	foreach( $this->filterFcn as $iface => $fcnList )	838✔
281	{
282	if( is_object( $item ) && $item instanceof $iface )	1✔
283	{
284	foreach( $fcnList as $fcn )	1✔
285	{
286	if( $fcn( $item ) === null ) {	1✔
287	return null;	1✔
288	}
289	}
290	}
291	}
292
293	return $item;	838✔
294	}
295
296
297	/**
298	* Creates the criteria attribute items from the list of entries
299	*
300	* @param array $list Associative array of code as key and array with properties as values
301	* @return \Aimeos\Base\Criteria\Attribute\Standard[] List of criteria attribute items
302	*/
303	protected function createAttributes( array $list ) : array
304	{
305	$attr = [];	939✔
306
307	foreach( $list as $key => $fields )	939✔
308	{
309	$fields['code'] = $fields['code'] ?? $key;	939✔
310	$fields['internalcode'] = $fields['internalcode'] ?? $key;	939✔
311	$attr[$key] = new \Aimeos\Base\Criteria\Attribute\Standard( $fields );	939✔
312	}
313
314	return $attr;	939✔
315	}
316
317
318	/**
319	* Returns the full configuration key for the passed last part
320	*
321	* @param string $name Configuration last part
322	* @return string Full configuration key
323	*/
324	protected function getConfigKey( string $name ) : string
325	{
326	$subPath = $this->getSubPath();	368✔
327	return 'mshop/' . $this->getDomain() . '/manager/' . ( $subPath ? $subPath . '/' : '' ) . $name;	368✔
328	}
329
330
331	/**
332	* Returns the manager domain
333	*
334	* @return string Manager domain e.g. "product"
335	*/
336	protected function getDomain() : string
337	{
338	if( !isset( $this->domain ) ) {	1,785✔
339	$this->initMethods();	1,785✔
340	}
341
342	return $this->domain;	1,785✔
343	}
344
345
346	/**
347	* Returns the manager path
348	*
349	* @return string Manager path e.g. "product/lists/type"
350	*/
351	protected function getManagerPath() : string
352	{
UNCOV 353	$subPath = $this->getSubPath();	×
UNCOV 354	return $this->getDomain() . ( $subPath ? '/' . $subPath : '' );	×
355	}
356
357
358	/**
359	* Returns the prefix for the item properties and search keys.
360	*
361	* @return string Prefix for the item properties and search keys
362	*/
363	protected function getPrefix() : string
364	{
365	return '';	5✔
366	}
367
368
369	/**
370	* Returns the attribute helper functions for searching defined by the manager.
371	*
372	* @param \Aimeos\Base\Criteria\Attribute\Iface[] $attributes List of search attribute items
373	* @return array Associative array of attribute code and helper function
374	*/
375	protected function getSearchFunctions( array $attributes ) : array
376	{
377	$list = [];	878✔
378	$iface = \Aimeos\Base\Criteria\Attribute\Iface::class;	878✔
379
380	foreach( $attributes as $key => $item )	878✔
381	{
382	if( $item instanceof $iface ) {	878✔
383	$list[$item->getCode()] = $item->getFunction();	878✔
UNCOV 384	} else if( isset( $item['code'] ) ) {	×
UNCOV 385	$list[$item['code']] = $item['function'] ?? null;	×
386	} else {
UNCOV 387	throw new \Aimeos\MShop\Exception( sprintf( 'Invalid attribute at position "%1$d"', $key ) );	×
388	}
389	}
390
391	return $list;	878✔
392	}
393
394
395	/**
396	* Returns the item search key for the passed name
397	*
398	* @return string Item prefix e.g. "product.lists.type.id"
399	*/
400	protected function getSearchKey( string $name = '' ) : string
401	{
402	$subPath = $this->getSubPath();	343✔
403	return $this->getDomain() . ( $subPath ? '.' . $subPath : '' ) . ( $name ? '.' . $name : '' );	343✔
404	}
405
406
407	/**
408	* Returns the attribute translations for searching defined by the manager.
409	*
410	* @param \Aimeos\Base\Criteria\Attribute\Iface[] $attributes List of search attribute items
411	* @return array Associative array of attribute code and internal attribute code
412	*/
413	protected function getSearchTranslations( array $attributes ) : array
414	{
415	$translations = [];	878✔
416	$alias = $this->getAlias();	878✔
417	$iface = \Aimeos\Base\Criteria\Attribute\Iface::class;	878✔
418
419	foreach( $attributes as $key => $item )	878✔
420	{
421	if( $alias && strpos( $item->getInternalCode(), '"' ) === false ) {	878✔
422	$translations[$item->getCode()] = $alias . '."' . $item->getInternalCode() . '"';	345✔
423	} else {
424	$translations[$item->getCode()] = $item->getInternalCode();	645✔
425	}
426	}
427
428	return $translations;	878✔
429	}
430
431
432	/**
433	* Returns the attribute types for searching defined by the manager.
434	*
435	* @param \Aimeos\Base\Criteria\Attribute\Iface[] $attributes List of search attribute items
436	* @return array Associative array of attribute code and internal attribute type
437	*/
438	protected function getSearchTypes( array $attributes ) : array
439	{
440	$types = [];	878✔
441	$iface = \Aimeos\Base\Criteria\Attribute\Iface::class;	878✔
442
443	foreach( $attributes as $key => $item )	878✔
444	{
445	if( $item instanceof $iface ) {	878✔
446	$types[$item->getCode()] = $item->getInternalType();	878✔
UNCOV 447	} else if( isset( $item['code'] ) ) {	×
UNCOV 448	$types[$item['code']] = $item['internaltype'];	×
449	} else {
UNCOV 450	throw new \Aimeos\MShop\Exception( sprintf( 'Invalid attribute at position "%1$d"', $key ) );	×
451	}
452	}
453
454	return $types;	878✔
455	}
456
457
458	/**
459	* Returns the manager domain sub-path
460	*
461	* @return string Manager domain sub-path e.g. "lists/type"
462	*/
463	protected function getSubPath() : string
464	{
465	if( !isset( $this->subpath ) ) {	1,016✔
UNCOV 466	$this->initMethods();	×
467	}
468
469	return $this->subpath;	1,016✔
470	}
471
472
473	/**
474	* Returns the name of the used table
475	*
476	* @return string Table name e.g. "mshop_product_lists_type"
477	*/
478	protected function getTable() : string
479	{
480	$subPath = $this->getSubPath();	1,008✔
481	return 'mshop_' . $this->getDomain() . ( $subPath ? '_' . str_replace( '/', '_', $subPath ) : '' );	1,008✔
482	}
483
484
485	/**
486	* Initializes the trait
487	*/
488	protected function initMethods()
489	{
490	$parts = explode( '\\', strtolower( current( $this->classes() ) ) );	1,785✔
491	array_shift( $parts ); array_shift( $parts ); // remove "Aimeos\MShop"	1,785✔
492	array_pop( $parts );	1,785✔
493
494	$this->domain = array_shift( $parts ) ?: '';	1,785✔
495	array_shift( $parts ); // remove "manager"	1,785✔
496	$this->subpath = join( '/', $parts );	1,785✔
497	}
498
499
500	/**
501	* Returns the outmost decorator of the decorator stack
502	*
503	* @return \Aimeos\MShop\Common\Manager\Iface Outmost decorator object
504	*/
505	protected function object() : \Aimeos\MShop\Common\Manager\Iface
506	{
507	return $this->object ?? $this;	999✔
508	}
509	}

aimeos / aimeos-core / e5c0f158-e116-43f4-afb8-e0d95035e4b2

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous