aimeos /
ai-client-html
@@ -19,266 +19,266 @@ |
||
| 19 | 19 | * @subpackage Html |
| 20 | 20 | */ |
| 21 | 21 | class Standard |
| 22 | - extends \Aimeos\Client\Html\Common\Client\Factory\Base |
|
| 23 | - implements \Aimeos\Client\Html\Common\Client\Factory\Iface |
|
| 22 | + extends \Aimeos\Client\Html\Common\Client\Factory\Base |
|
| 23 | + implements \Aimeos\Client\Html\Common\Client\Factory\Iface |
|
| 24 | 24 | { |
| 25 | - /** client/html/catalog/detail/basket/attribute/standard/subparts |
|
| 26 | - * List of HTML sub-clients rendered within the catalog detail basket attribute section |
|
| 27 | - * |
|
| 28 | - * The output of the frontend is composed of the code generated by the HTML |
|
| 29 | - * clients. Each HTML client can consist of serveral (or none) sub-clients |
|
| 30 | - * that are responsible for rendering certain sub-parts of the output. The |
|
| 31 | - * sub-clients can contain HTML clients themselves and therefore a |
|
| 32 | - * hierarchical tree of HTML clients is composed. Each HTML client creates |
|
| 33 | - * the output that is placed inside the container of its parent. |
|
| 34 | - * |
|
| 35 | - * At first, always the HTML code generated by the parent is printed, then |
|
| 36 | - * the HTML code of its sub-clients. The order of the HTML sub-clients |
|
| 37 | - * determines the order of the output of these sub-clients inside the parent |
|
| 38 | - * container. If the configured list of clients is |
|
| 39 | - * |
|
| 40 | - * array( "subclient1", "subclient2" ) |
|
| 41 | - * |
|
| 42 | - * you can easily change the order of the output by reordering the subparts: |
|
| 43 | - * |
|
| 44 | - * client/html/<clients>/subparts = array( "subclient1", "subclient2" ) |
|
| 45 | - * |
|
| 46 | - * You can also remove one or more parts if they shouldn't be rendered: |
|
| 47 | - * |
|
| 48 | - * client/html/<clients>/subparts = array( "subclient1" ) |
|
| 49 | - * |
|
| 50 | - * As the clients only generates structural HTML, the layout defined via CSS |
|
| 51 | - * should support adding, removing or reordering content by a fluid like |
|
| 52 | - * design. |
|
| 53 | - * |
|
| 54 | - * @param array List of sub-client names |
|
| 55 | - * @since 2014.03 |
|
| 56 | - * @category Developer |
|
| 57 | - */ |
|
| 58 | - private $subPartPath = 'client/html/catalog/detail/basket/attribute/standard/subparts'; |
|
| 59 | - private $subPartNames = array(); |
|
| 60 | - private $cache; |
|
| 25 | + /** client/html/catalog/detail/basket/attribute/standard/subparts |
|
| 26 | + * List of HTML sub-clients rendered within the catalog detail basket attribute section |
|
| 27 | + * |
|
| 28 | + * The output of the frontend is composed of the code generated by the HTML |
|
| 29 | + * clients. Each HTML client can consist of serveral (or none) sub-clients |
|
| 30 | + * that are responsible for rendering certain sub-parts of the output. The |
|
| 31 | + * sub-clients can contain HTML clients themselves and therefore a |
|
| 32 | + * hierarchical tree of HTML clients is composed. Each HTML client creates |
|
| 33 | + * the output that is placed inside the container of its parent. |
|
| 34 | + * |
|
| 35 | + * At first, always the HTML code generated by the parent is printed, then |
|
| 36 | + * the HTML code of its sub-clients. The order of the HTML sub-clients |
|
| 37 | + * determines the order of the output of these sub-clients inside the parent |
|
| 38 | + * container. If the configured list of clients is |
|
| 39 | + * |
|
| 40 | + * array( "subclient1", "subclient2" ) |
|
| 41 | + * |
|
| 42 | + * you can easily change the order of the output by reordering the subparts: |
|
| 43 | + * |
|
| 44 | + * client/html/<clients>/subparts = array( "subclient1", "subclient2" ) |
|
| 45 | + * |
|
| 46 | + * You can also remove one or more parts if they shouldn't be rendered: |
|
| 47 | + * |
|
| 48 | + * client/html/<clients>/subparts = array( "subclient1" ) |
|
| 49 | + * |
|
| 50 | + * As the clients only generates structural HTML, the layout defined via CSS |
|
| 51 | + * should support adding, removing or reordering content by a fluid like |
|
| 52 | + * design. |
|
| 53 | + * |
|
| 54 | + * @param array List of sub-client names |
|
| 55 | + * @since 2014.03 |
|
| 56 | + * @category Developer |
|
| 57 | + */ |
|
| 58 | + private $subPartPath = 'client/html/catalog/detail/basket/attribute/standard/subparts'; |
|
| 59 | + private $subPartNames = array(); |
|
| 60 | + private $cache; |
|
| 61 | 61 | |
| 62 | 62 | |
| 63 | - /** |
|
| 64 | - * Returns the HTML code for insertion into the body. |
|
| 65 | - * |
|
| 66 | - * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
|
| 67 | - * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 68 | - * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 69 | - * @return string HTML code |
|
| 70 | - */ |
|
| 71 | - public function getBody( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 72 | - { |
|
| 73 | - $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 63 | + /** |
|
| 64 | + * Returns the HTML code for insertion into the body. |
|
| 65 | + * |
|
| 66 | + * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
|
| 67 | + * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 68 | + * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 69 | + * @return string HTML code |
|
| 70 | + */ |
|
| 71 | + public function getBody( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 72 | + { |
|
| 73 | + $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 74 | 74 | |
| 75 | - $html = ''; |
|
| 76 | - foreach( $this->getSubClients() as $subclient ) { |
|
| 77 | - $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire ); |
|
| 78 | - } |
|
| 79 | - $view->attributeBody = $html; |
|
| 75 | + $html = ''; |
|
| 76 | + foreach( $this->getSubClients() as $subclient ) { |
|
| 77 | + $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire ); |
|
| 78 | + } |
|
| 79 | + $view->attributeBody = $html; |
|
| 80 | 80 | |
| 81 | - /** client/html/catalog/detail/basket/attribute/standard/template-body |
|
| 82 | - * Relative path to the HTML body template of the catalog detail basket attribute client. |
|
| 83 | - * |
|
| 84 | - * The template file contains the HTML code and processing instructions |
|
| 85 | - * to generate the result shown in the body of the frontend. The |
|
| 86 | - * configuration string is the path to the template file relative |
|
| 87 | - * to the templates directory (usually in client/html/templates). |
|
| 88 | - * |
|
| 89 | - * You can overwrite the template file configuration in extensions and |
|
| 90 | - * provide alternative templates. These alternative templates should be |
|
| 91 | - * named like the default one but with the string "standard" replaced by |
|
| 92 | - * an unique name. You may use the name of your project for this. If |
|
| 93 | - * you've implemented an alternative client class as well, "standard" |
|
| 94 | - * should be replaced by the name of the new class. |
|
| 95 | - * |
|
| 96 | - * @param string Relative path to the template creating code for the HTML page body |
|
| 97 | - * @since 2014.03 |
|
| 98 | - * @category Developer |
|
| 99 | - * @see client/html/catalog/detail/basket/attribute/standard/template-header |
|
| 100 | - */ |
|
| 101 | - $tplconf = 'client/html/catalog/detail/basket/attribute/standard/template-body'; |
|
| 102 | - $default = 'catalog/detail/basket-attribute-body-default.php'; |
|
| 81 | + /** client/html/catalog/detail/basket/attribute/standard/template-body |
|
| 82 | + * Relative path to the HTML body template of the catalog detail basket attribute client. |
|
| 83 | + * |
|
| 84 | + * The template file contains the HTML code and processing instructions |
|
| 85 | + * to generate the result shown in the body of the frontend. The |
|
| 86 | + * configuration string is the path to the template file relative |
|
| 87 | + * to the templates directory (usually in client/html/templates). |
|
| 88 | + * |
|
| 89 | + * You can overwrite the template file configuration in extensions and |
|
| 90 | + * provide alternative templates. These alternative templates should be |
|
| 91 | + * named like the default one but with the string "standard" replaced by |
|
| 92 | + * an unique name. You may use the name of your project for this. If |
|
| 93 | + * you've implemented an alternative client class as well, "standard" |
|
| 94 | + * should be replaced by the name of the new class. |
|
| 95 | + * |
|
| 96 | + * @param string Relative path to the template creating code for the HTML page body |
|
| 97 | + * @since 2014.03 |
|
| 98 | + * @category Developer |
|
| 99 | + * @see client/html/catalog/detail/basket/attribute/standard/template-header |
|
| 100 | + */ |
|
| 101 | + $tplconf = 'client/html/catalog/detail/basket/attribute/standard/template-body'; |
|
| 102 | + $default = 'catalog/detail/basket-attribute-body-default.php'; |
|
| 103 | 103 | |
| 104 | - return $view->render( $view->config( $tplconf, $default ) ); |
|
| 105 | - } |
|
| 104 | + return $view->render( $view->config( $tplconf, $default ) ); |
|
| 105 | + } |
|
| 106 | 106 | |
| 107 | 107 | |
| 108 | - /** |
|
| 109 | - * Returns the HTML string for insertion into the header. |
|
| 110 | - * |
|
| 111 | - * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
|
| 112 | - * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 113 | - * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 114 | - * @return string|null String including HTML tags for the header on error |
|
| 115 | - */ |
|
| 116 | - public function getHeader( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 117 | - { |
|
| 118 | - $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 108 | + /** |
|
| 109 | + * Returns the HTML string for insertion into the header. |
|
| 110 | + * |
|
| 111 | + * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
|
| 112 | + * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 113 | + * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 114 | + * @return string|null String including HTML tags for the header on error |
|
| 115 | + */ |
|
| 116 | + public function getHeader( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 117 | + { |
|
| 118 | + $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 119 | 119 | |
| 120 | - $html = ''; |
|
| 121 | - foreach( $this->getSubClients() as $subclient ) { |
|
| 122 | - $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire ); |
|
| 123 | - } |
|
| 124 | - $view->attributeHeader = $html; |
|
| 120 | + $html = ''; |
|
| 121 | + foreach( $this->getSubClients() as $subclient ) { |
|
| 122 | + $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire ); |
|
| 123 | + } |
|
| 124 | + $view->attributeHeader = $html; |
|
| 125 | 125 | |
| 126 | - /** client/html/catalog/detail/basket/attribute/standard/template-header |
|
| 127 | - * Relative path to the HTML header template of the catalog detail basket attribute client. |
|
| 128 | - * |
|
| 129 | - * The template file contains the HTML code and processing instructions |
|
| 130 | - * to generate the HTML code that is inserted into the HTML page header |
|
| 131 | - * of the rendered page in the frontend. The configuration string is the |
|
| 132 | - * path to the template file relative to the templates directory (usually |
|
| 133 | - * in client/html/templates). |
|
| 134 | - * |
|
| 135 | - * You can overwrite the template file configuration in extensions and |
|
| 136 | - * provide alternative templates. These alternative templates should be |
|
| 137 | - * named like the default one but with the string "standard" replaced by |
|
| 138 | - * an unique name. You may use the name of your project for this. If |
|
| 139 | - * you've implemented an alternative client class as well, "standard" |
|
| 140 | - * should be replaced by the name of the new class. |
|
| 141 | - * |
|
| 142 | - * @param string Relative path to the template creating code for the HTML page head |
|
| 143 | - * @since 2014.03 |
|
| 144 | - * @category Developer |
|
| 145 | - * @see client/html/catalog/detail/basket/attribute/standard/template-body |
|
| 146 | - */ |
|
| 147 | - $tplconf = 'client/html/catalog/detail/basket/attribute/standard/template-header'; |
|
| 148 | - $default = 'catalog/detail/basket-attribute-header-default.php'; |
|
| 126 | + /** client/html/catalog/detail/basket/attribute/standard/template-header |
|
| 127 | + * Relative path to the HTML header template of the catalog detail basket attribute client. |
|
| 128 | + * |
|
| 129 | + * The template file contains the HTML code and processing instructions |
|
| 130 | + * to generate the HTML code that is inserted into the HTML page header |
|
| 131 | + * of the rendered page in the frontend. The configuration string is the |
|
| 132 | + * path to the template file relative to the templates directory (usually |
|
| 133 | + * in client/html/templates). |
|
| 134 | + * |
|
| 135 | + * You can overwrite the template file configuration in extensions and |
|
| 136 | + * provide alternative templates. These alternative templates should be |
|
| 137 | + * named like the default one but with the string "standard" replaced by |
|
| 138 | + * an unique name. You may use the name of your project for this. If |
|
| 139 | + * you've implemented an alternative client class as well, "standard" |
|
| 140 | + * should be replaced by the name of the new class. |
|
| 141 | + * |
|
| 142 | + * @param string Relative path to the template creating code for the HTML page head |
|
| 143 | + * @since 2014.03 |
|
| 144 | + * @category Developer |
|
| 145 | + * @see client/html/catalog/detail/basket/attribute/standard/template-body |
|
| 146 | + */ |
|
| 147 | + $tplconf = 'client/html/catalog/detail/basket/attribute/standard/template-header'; |
|
| 148 | + $default = 'catalog/detail/basket-attribute-header-default.php'; |
|
| 149 | 149 | |
| 150 | - return $view->render( $view->config( $tplconf, $default ) ); |
|
| 151 | - } |
|
| 150 | + return $view->render( $view->config( $tplconf, $default ) ); |
|
| 151 | + } |
|
| 152 | 152 | |
| 153 | 153 | |
| 154 | - /** |
|
| 155 | - * Returns the sub-client given by its name. |
|
| 156 | - * |
|
| 157 | - * @param string $type Name of the client type |
|
| 158 | - * @param string|null $name Name of the sub-client (Default if null) |
|
| 159 | - * @return \Aimeos\Client\Html\Iface Sub-client object |
|
| 160 | - */ |
|
| 161 | - public function getSubClient( $type, $name = null ) |
|
| 162 | - { |
|
| 163 | - /** client/html/catalog/detail/basket/attribute/decorators/excludes |
|
| 164 | - * Excludes decorators added by the "common" option from the catalog detail basket attribute html client |
|
| 165 | - * |
|
| 166 | - * Decorators extend the functionality of a class by adding new aspects |
|
| 167 | - * (e.g. log what is currently done), executing the methods of the underlying |
|
| 168 | - * class only in certain conditions (e.g. only for logged in users) or |
|
| 169 | - * modify what is returned to the caller. |
|
| 170 | - * |
|
| 171 | - * This option allows you to remove a decorator added via |
|
| 172 | - * "client/html/common/decorators/default" before they are wrapped |
|
| 173 | - * around the html client. |
|
| 174 | - * |
|
| 175 | - * client/html/catalog/detail/basket/attribute/decorators/excludes = array( 'decorator1' ) |
|
| 176 | - * |
|
| 177 | - * This would remove the decorator named "decorator1" from the list of |
|
| 178 | - * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via |
|
| 179 | - * "client/html/common/decorators/default" to the html client. |
|
| 180 | - * |
|
| 181 | - * @param array List of decorator names |
|
| 182 | - * @since 2015.08 |
|
| 183 | - * @category Developer |
|
| 184 | - * @see client/html/common/decorators/default |
|
| 185 | - * @see client/html/catalog/detail/basket/attribute/decorators/global |
|
| 186 | - * @see client/html/catalog/detail/basket/attribute/decorators/local |
|
| 187 | - */ |
|
| 154 | + /** |
|
| 155 | + * Returns the sub-client given by its name. |
|
| 156 | + * |
|
| 157 | + * @param string $type Name of the client type |
|
| 158 | + * @param string|null $name Name of the sub-client (Default if null) |
|
| 159 | + * @return \Aimeos\Client\Html\Iface Sub-client object |
|
| 160 | + */ |
|
| 161 | + public function getSubClient( $type, $name = null ) |
|
| 162 | + { |
|
| 163 | + /** client/html/catalog/detail/basket/attribute/decorators/excludes |
|
| 164 | + * Excludes decorators added by the "common" option from the catalog detail basket attribute html client |
|
| 165 | + * |
|
| 166 | + * Decorators extend the functionality of a class by adding new aspects |
|
| 167 | + * (e.g. log what is currently done), executing the methods of the underlying |
|
| 168 | + * class only in certain conditions (e.g. only for logged in users) or |
|
| 169 | + * modify what is returned to the caller. |
|
| 170 | + * |
|
| 171 | + * This option allows you to remove a decorator added via |
|
| 172 | + * "client/html/common/decorators/default" before they are wrapped |
|
| 173 | + * around the html client. |
|
| 174 | + * |
|
| 175 | + * client/html/catalog/detail/basket/attribute/decorators/excludes = array( 'decorator1' ) |
|
| 176 | + * |
|
| 177 | + * This would remove the decorator named "decorator1" from the list of |
|
| 178 | + * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via |
|
| 179 | + * "client/html/common/decorators/default" to the html client. |
|
| 180 | + * |
|
| 181 | + * @param array List of decorator names |
|
| 182 | + * @since 2015.08 |
|
| 183 | + * @category Developer |
|
| 184 | + * @see client/html/common/decorators/default |
|
| 185 | + * @see client/html/catalog/detail/basket/attribute/decorators/global |
|
| 186 | + * @see client/html/catalog/detail/basket/attribute/decorators/local |
|
| 187 | + */ |
|
| 188 | 188 | |
| 189 | - /** client/html/catalog/detail/basket/attribute/decorators/global |
|
| 190 | - * Adds a list of globally available decorators only to the catalog detail basket attribute html client |
|
| 191 | - * |
|
| 192 | - * Decorators extend the functionality of a class by adding new aspects |
|
| 193 | - * (e.g. log what is currently done), executing the methods of the underlying |
|
| 194 | - * class only in certain conditions (e.g. only for logged in users) or |
|
| 195 | - * modify what is returned to the caller. |
|
| 196 | - * |
|
| 197 | - * This option allows you to wrap global decorators |
|
| 198 | - * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client. |
|
| 199 | - * |
|
| 200 | - * client/html/catalog/detail/basket/attribute/decorators/global = array( 'decorator1' ) |
|
| 201 | - * |
|
| 202 | - * This would add the decorator named "decorator1" defined by |
|
| 203 | - * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client. |
|
| 204 | - * |
|
| 205 | - * @param array List of decorator names |
|
| 206 | - * @since 2015.08 |
|
| 207 | - * @category Developer |
|
| 208 | - * @see client/html/common/decorators/default |
|
| 209 | - * @see client/html/catalog/detail/basket/attribute/decorators/excludes |
|
| 210 | - * @see client/html/catalog/detail/basket/attribute/decorators/local |
|
| 211 | - */ |
|
| 189 | + /** client/html/catalog/detail/basket/attribute/decorators/global |
|
| 190 | + * Adds a list of globally available decorators only to the catalog detail basket attribute html client |
|
| 191 | + * |
|
| 192 | + * Decorators extend the functionality of a class by adding new aspects |
|
| 193 | + * (e.g. log what is currently done), executing the methods of the underlying |
|
| 194 | + * class only in certain conditions (e.g. only for logged in users) or |
|
| 195 | + * modify what is returned to the caller. |
|
| 196 | + * |
|
| 197 | + * This option allows you to wrap global decorators |
|
| 198 | + * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client. |
|
| 199 | + * |
|
| 200 | + * client/html/catalog/detail/basket/attribute/decorators/global = array( 'decorator1' ) |
|
| 201 | + * |
|
| 202 | + * This would add the decorator named "decorator1" defined by |
|
| 203 | + * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client. |
|
| 204 | + * |
|
| 205 | + * @param array List of decorator names |
|
| 206 | + * @since 2015.08 |
|
| 207 | + * @category Developer |
|
| 208 | + * @see client/html/common/decorators/default |
|
| 209 | + * @see client/html/catalog/detail/basket/attribute/decorators/excludes |
|
| 210 | + * @see client/html/catalog/detail/basket/attribute/decorators/local |
|
| 211 | + */ |
|
| 212 | 212 | |
| 213 | - /** client/html/catalog/detail/basket/attribute/decorators/local |
|
| 214 | - * Adds a list of local decorators only to the catalog detail basket attribute html client |
|
| 215 | - * |
|
| 216 | - * Decorators extend the functionality of a class by adding new aspects |
|
| 217 | - * (e.g. log what is currently done), executing the methods of the underlying |
|
| 218 | - * class only in certain conditions (e.g. only for logged in users) or |
|
| 219 | - * modify what is returned to the caller. |
|
| 220 | - * |
|
| 221 | - * This option allows you to wrap local decorators |
|
| 222 | - * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client. |
|
| 223 | - * |
|
| 224 | - * client/html/catalog/detail/basket/attribute/decorators/local = array( 'decorator2' ) |
|
| 225 | - * |
|
| 226 | - * This would add the decorator named "decorator2" defined by |
|
| 227 | - * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client. |
|
| 228 | - * |
|
| 229 | - * @param array List of decorator names |
|
| 230 | - * @since 2015.08 |
|
| 231 | - * @category Developer |
|
| 232 | - * @see client/html/common/decorators/default |
|
| 233 | - * @see client/html/catalog/detail/basket/attribute/decorators/excludes |
|
| 234 | - * @see client/html/catalog/detail/basket/attribute/attribute/decorators/global |
|
| 235 | - */ |
|
| 213 | + /** client/html/catalog/detail/basket/attribute/decorators/local |
|
| 214 | + * Adds a list of local decorators only to the catalog detail basket attribute html client |
|
| 215 | + * |
|
| 216 | + * Decorators extend the functionality of a class by adding new aspects |
|
| 217 | + * (e.g. log what is currently done), executing the methods of the underlying |
|
| 218 | + * class only in certain conditions (e.g. only for logged in users) or |
|
| 219 | + * modify what is returned to the caller. |
|
| 220 | + * |
|
| 221 | + * This option allows you to wrap local decorators |
|
| 222 | + * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client. |
|
| 223 | + * |
|
| 224 | + * client/html/catalog/detail/basket/attribute/decorators/local = array( 'decorator2' ) |
|
| 225 | + * |
|
| 226 | + * This would add the decorator named "decorator2" defined by |
|
| 227 | + * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client. |
|
| 228 | + * |
|
| 229 | + * @param array List of decorator names |
|
| 230 | + * @since 2015.08 |
|
| 231 | + * @category Developer |
|
| 232 | + * @see client/html/common/decorators/default |
|
| 233 | + * @see client/html/catalog/detail/basket/attribute/decorators/excludes |
|
| 234 | + * @see client/html/catalog/detail/basket/attribute/attribute/decorators/global |
|
| 235 | + */ |
|
| 236 | 236 | |
| 237 | - return $this->createSubClient( 'catalog/detail/basket/attribute/' . $type, $name ); |
|
| 238 | - } |
|
| 237 | + return $this->createSubClient( 'catalog/detail/basket/attribute/' . $type, $name ); |
|
| 238 | + } |
|
| 239 | 239 | |
| 240 | 240 | |
| 241 | - /** |
|
| 242 | - * Returns the list of sub-client names configured for the client. |
|
| 243 | - * |
|
| 244 | - * @return array List of HTML client names |
|
| 245 | - */ |
|
| 246 | - protected function getSubClientNames() |
|
| 247 | - { |
|
| 248 | - return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames ); |
|
| 249 | - } |
|
| 241 | + /** |
|
| 242 | + * Returns the list of sub-client names configured for the client. |
|
| 243 | + * |
|
| 244 | + * @return array List of HTML client names |
|
| 245 | + */ |
|
| 246 | + protected function getSubClientNames() |
|
| 247 | + { |
|
| 248 | + return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames ); |
|
| 249 | + } |
|
| 250 | 250 | |
| 251 | 251 | |
| 252 | - /** |
|
| 253 | - * Sets the necessary parameter values in the view. |
|
| 254 | - * |
|
| 255 | - * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output |
|
| 256 | - * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 257 | - * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 258 | - * @return \Aimeos\MW\View\Iface Modified view object |
|
| 259 | - */ |
|
| 260 | - protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null ) |
|
| 261 | - { |
|
| 262 | - if( !isset( $this->cache ) ) |
|
| 263 | - { |
|
| 264 | - $attributeTypes = array(); |
|
| 265 | - $attrItems = $view->get( 'detailProductAttributeItems', array() ); |
|
| 266 | - $configAttributes = $view->detailProductItem->getRefItems( 'attribute', null, 'config' ); |
|
| 252 | + /** |
|
| 253 | + * Sets the necessary parameter values in the view. |
|
| 254 | + * |
|
| 255 | + * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output |
|
| 256 | + * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 257 | + * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 258 | + * @return \Aimeos\MW\View\Iface Modified view object |
|
| 259 | + */ |
|
| 260 | + protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null ) |
|
| 261 | + { |
|
| 262 | + if( !isset( $this->cache ) ) |
|
| 263 | + { |
|
| 264 | + $attributeTypes = array(); |
|
| 265 | + $attrItems = $view->get( 'detailProductAttributeItems', array() ); |
|
| 266 | + $configAttributes = $view->detailProductItem->getRefItems( 'attribute', null, 'config' ); |
|
| 267 | 267 | |
| 268 | - foreach( $configAttributes as $id => $attribute ) |
|
| 269 | - { |
|
| 270 | - if( isset( $attrItems[$id] ) ) { |
|
| 271 | - $attributeTypes[$attrItems[$id]->getType()][$id] = $attrItems[$id]; |
|
| 272 | - } |
|
| 273 | - } |
|
| 268 | + foreach( $configAttributes as $id => $attribute ) |
|
| 269 | + { |
|
| 270 | + if( isset( $attrItems[$id] ) ) { |
|
| 271 | + $attributeTypes[$attrItems[$id]->getType()][$id] = $attrItems[$id]; |
|
| 272 | + } |
|
| 273 | + } |
|
| 274 | 274 | |
| 275 | - $view->attributeConfigItems = $attributeTypes; |
|
| 276 | - $view->attributeCustomItems = $view->detailProductItem->getRefItems( 'attribute', null, 'custom' ); |
|
| 277 | - $view->attributeHiddenItems = $view->detailProductItem->getRefItems( 'attribute', null, 'hidden' ); |
|
| 275 | + $view->attributeConfigItems = $attributeTypes; |
|
| 276 | + $view->attributeCustomItems = $view->detailProductItem->getRefItems( 'attribute', null, 'custom' ); |
|
| 277 | + $view->attributeHiddenItems = $view->detailProductItem->getRefItems( 'attribute', null, 'hidden' ); |
|
| 278 | 278 | |
| 279 | - $this->cache = $view; |
|
| 280 | - } |
|
| 279 | + $this->cache = $view; |
|
| 280 | + } |
|
| 281 | 281 | |
| 282 | - return $this->cache; |
|
| 283 | - } |
|
| 282 | + return $this->cache; |
|
| 283 | + } |
|
| 284 | 284 | } |
| 285 | 285 | \ No newline at end of file |
@@ -68,13 +68,13 @@ discard block |
||
| 68 | 68 | * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
| 69 | 69 | * @return string HTML code |
| 70 | 70 | */ |
| 71 | - public function getBody( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 71 | + public function getBody($uid = '', array &$tags = array(), &$expire = null) |
|
| 72 | 72 | { |
| 73 | - $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 73 | + $view = $this->setViewParams($this->getView(), $tags, $expire); |
|
| 74 | 74 | |
| 75 | 75 | $html = ''; |
| 76 | - foreach( $this->getSubClients() as $subclient ) { |
|
| 77 | - $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire ); |
|
| 76 | + foreach ($this->getSubClients() as $subclient) { |
|
| 77 | + $html .= $subclient->setView($view)->getBody($uid, $tags, $expire); |
|
| 78 | 78 | } |
| 79 | 79 | $view->attributeBody = $html; |
| 80 | 80 | |
@@ -101,7 +101,7 @@ discard block |
||
| 101 | 101 | $tplconf = 'client/html/catalog/detail/basket/attribute/standard/template-body'; |
| 102 | 102 | $default = 'catalog/detail/basket-attribute-body-default.php'; |
| 103 | 103 | |
| 104 | - return $view->render( $view->config( $tplconf, $default ) ); |
|
| 104 | + return $view->render($view->config($tplconf, $default)); |
|
| 105 | 105 | } |
| 106 | 106 | |
| 107 | 107 | |
@@ -113,13 +113,13 @@ discard block |
||
| 113 | 113 | * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
| 114 | 114 | * @return string|null String including HTML tags for the header on error |
| 115 | 115 | */ |
| 116 | - public function getHeader( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 116 | + public function getHeader($uid = '', array &$tags = array(), &$expire = null) |
|
| 117 | 117 | { |
| 118 | - $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 118 | + $view = $this->setViewParams($this->getView(), $tags, $expire); |
|
| 119 | 119 | |
| 120 | 120 | $html = ''; |
| 121 | - foreach( $this->getSubClients() as $subclient ) { |
|
| 122 | - $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire ); |
|
| 121 | + foreach ($this->getSubClients() as $subclient) { |
|
| 122 | + $html .= $subclient->setView($view)->getHeader($uid, $tags, $expire); |
|
| 123 | 123 | } |
| 124 | 124 | $view->attributeHeader = $html; |
| 125 | 125 | |
@@ -147,7 +147,7 @@ discard block |
||
| 147 | 147 | $tplconf = 'client/html/catalog/detail/basket/attribute/standard/template-header'; |
| 148 | 148 | $default = 'catalog/detail/basket-attribute-header-default.php'; |
| 149 | 149 | |
| 150 | - return $view->render( $view->config( $tplconf, $default ) ); |
|
| 150 | + return $view->render($view->config($tplconf, $default)); |
|
| 151 | 151 | } |
| 152 | 152 | |
| 153 | 153 | |
@@ -158,7 +158,7 @@ discard block |
||
| 158 | 158 | * @param string|null $name Name of the sub-client (Default if null) |
| 159 | 159 | * @return \Aimeos\Client\Html\Iface Sub-client object |
| 160 | 160 | */ |
| 161 | - public function getSubClient( $type, $name = null ) |
|
| 161 | + public function getSubClient($type, $name = null) |
|
| 162 | 162 | { |
| 163 | 163 | /** client/html/catalog/detail/basket/attribute/decorators/excludes |
| 164 | 164 | * Excludes decorators added by the "common" option from the catalog detail basket attribute html client |
@@ -234,7 +234,7 @@ discard block |
||
| 234 | 234 | * @see client/html/catalog/detail/basket/attribute/attribute/decorators/global |
| 235 | 235 | */ |
| 236 | 236 | |
| 237 | - return $this->createSubClient( 'catalog/detail/basket/attribute/' . $type, $name ); |
|
| 237 | + return $this->createSubClient('catalog/detail/basket/attribute/'.$type, $name); |
|
| 238 | 238 | } |
| 239 | 239 | |
| 240 | 240 | |
@@ -245,7 +245,7 @@ discard block |
||
| 245 | 245 | */ |
| 246 | 246 | protected function getSubClientNames() |
| 247 | 247 | { |
| 248 | - return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames ); |
|
| 248 | + return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames); |
|
| 249 | 249 | } |
| 250 | 250 | |
| 251 | 251 | |
@@ -257,24 +257,24 @@ discard block |
||
| 257 | 257 | * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
| 258 | 258 | * @return \Aimeos\MW\View\Iface Modified view object |
| 259 | 259 | */ |
| 260 | - protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null ) |
|
| 260 | + protected function setViewParams(\Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null) |
|
| 261 | 261 | { |
| 262 | - if( !isset( $this->cache ) ) |
|
| 262 | + if (!isset($this->cache)) |
|
| 263 | 263 | { |
| 264 | 264 | $attributeTypes = array(); |
| 265 | - $attrItems = $view->get( 'detailProductAttributeItems', array() ); |
|
| 266 | - $configAttributes = $view->detailProductItem->getRefItems( 'attribute', null, 'config' ); |
|
| 265 | + $attrItems = $view->get('detailProductAttributeItems', array()); |
|
| 266 | + $configAttributes = $view->detailProductItem->getRefItems('attribute', null, 'config'); |
|
| 267 | 267 | |
| 268 | - foreach( $configAttributes as $id => $attribute ) |
|
| 268 | + foreach ($configAttributes as $id => $attribute) |
|
| 269 | 269 | { |
| 270 | - if( isset( $attrItems[$id] ) ) { |
|
| 270 | + if (isset($attrItems[$id])) { |
|
| 271 | 271 | $attributeTypes[$attrItems[$id]->getType()][$id] = $attrItems[$id]; |
| 272 | 272 | } |
| 273 | 273 | } |
| 274 | 274 | |
| 275 | 275 | $view->attributeConfigItems = $attributeTypes; |
| 276 | - $view->attributeCustomItems = $view->detailProductItem->getRefItems( 'attribute', null, 'custom' ); |
|
| 277 | - $view->attributeHiddenItems = $view->detailProductItem->getRefItems( 'attribute', null, 'hidden' ); |
|
| 276 | + $view->attributeCustomItems = $view->detailProductItem->getRefItems('attribute', null, 'custom'); |
|
| 277 | + $view->attributeHiddenItems = $view->detailProductItem->getRefItems('attribute', null, 'hidden'); |
|
| 278 | 278 | |
| 279 | 279 | $this->cache = $view; |
| 280 | 280 | } |
@@ -110,7 +110,7 @@ |
||
| 110 | 110 | * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
| 111 | 111 | * @param array &$tags Result array for the list of tags that are associated to the output |
| 112 | 112 | * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
| 113 | - * @return string|null String including HTML tags for the header on error |
|
| 113 | + * @return string String including HTML tags for the header on error |
|
| 114 | 114 | */ |
| 115 | 115 | public function getHeader( $uid = '', array &$tags = array(), &$expire = null ) |
| 116 | 116 | { |
@@ -19,326 +19,326 @@ |
||
| 19 | 19 | * @subpackage Html |
| 20 | 20 | */ |
| 21 | 21 | class Standard |
| 22 | - extends \Aimeos\Client\Html\Common\Client\Factory\Base |
|
| 23 | - implements \Aimeos\Client\Html\Common\Client\Factory\Iface |
|
| 22 | + extends \Aimeos\Client\Html\Common\Client\Factory\Base |
|
| 23 | + implements \Aimeos\Client\Html\Common\Client\Factory\Iface |
|
| 24 | 24 | { |
| 25 | - /** client/html/catalog/detail/basket/standard/subparts |
|
| 26 | - * List of HTML sub-clients rendered within the catalog detail basket section |
|
| 27 | - * |
|
| 28 | - * The output of the frontend is composed of the code generated by the HTML |
|
| 29 | - * clients. Each HTML client can consist of serveral (or none) sub-clients |
|
| 30 | - * that are responsible for rendering certain sub-parts of the output. The |
|
| 31 | - * sub-clients can contain HTML clients themselves and therefore a |
|
| 32 | - * hierarchical tree of HTML clients is composed. Each HTML client creates |
|
| 33 | - * the output that is placed inside the container of its parent. |
|
| 34 | - * |
|
| 35 | - * At first, always the HTML code generated by the parent is printed, then |
|
| 36 | - * the HTML code of its sub-clients. The order of the HTML sub-clients |
|
| 37 | - * determines the order of the output of these sub-clients inside the parent |
|
| 38 | - * container. If the configured list of clients is |
|
| 39 | - * |
|
| 40 | - * array( "subclient1", "subclient2" ) |
|
| 41 | - * |
|
| 42 | - * you can easily change the order of the output by reordering the subparts: |
|
| 43 | - * |
|
| 44 | - * client/html/<clients>/subparts = array( "subclient1", "subclient2" ) |
|
| 45 | - * |
|
| 46 | - * You can also remove one or more parts if they shouldn't be rendered: |
|
| 47 | - * |
|
| 48 | - * client/html/<clients>/subparts = array( "subclient1" ) |
|
| 49 | - * |
|
| 50 | - * As the clients only generates structural HTML, the layout defined via CSS |
|
| 51 | - * should support adding, removing or reordering content by a fluid like |
|
| 52 | - * design. |
|
| 53 | - * |
|
| 54 | - * @param array List of sub-client names |
|
| 55 | - * @since 2014.03 |
|
| 56 | - * @category Developer |
|
| 57 | - */ |
|
| 58 | - private $subPartPath = 'client/html/catalog/detail/basket/standard/subparts'; |
|
| 59 | - |
|
| 60 | - /** client/html/catalog/detail/basket/selection/name |
|
| 61 | - * Name of the selection part used by the catalog detail basket client implementation |
|
| 62 | - * |
|
| 63 | - * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Detail\Basket\Selection\Myname". |
|
| 64 | - * The name is case-sensitive and you should avoid camel case names like "MyName". |
|
| 65 | - * |
|
| 66 | - * @param string Last part of the client class name |
|
| 67 | - * @since 2014.03 |
|
| 68 | - * @category Developer |
|
| 69 | - */ |
|
| 70 | - |
|
| 71 | - /** client/html/catalog/detail/basket/attribute/name |
|
| 72 | - * Name of the attribute part used by the catalog detail basket client implementation |
|
| 73 | - * |
|
| 74 | - * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Detail\Basket\Attribute\Myname". |
|
| 75 | - * The name is case-sensitive and you should avoid camel case names like "MyName". |
|
| 76 | - * |
|
| 77 | - * @param string Last part of the client class name |
|
| 78 | - * @since 2014.03 |
|
| 79 | - * @category Developer |
|
| 80 | - */ |
|
| 81 | - private $subPartNames = array( 'service', 'selection', 'attribute' ); |
|
| 82 | - private $cache; |
|
| 83 | - |
|
| 84 | - |
|
| 85 | - /** |
|
| 86 | - * Returns the HTML code for insertion into the body. |
|
| 87 | - * |
|
| 88 | - * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
|
| 89 | - * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 90 | - * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 91 | - * @return string HTML code |
|
| 92 | - */ |
|
| 93 | - public function getBody( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 94 | - { |
|
| 95 | - $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 96 | - |
|
| 97 | - $html = ''; |
|
| 98 | - foreach( $this->getSubClients() as $subclient ) { |
|
| 99 | - $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire ); |
|
| 100 | - } |
|
| 101 | - $view->basketBody = $html; |
|
| 102 | - |
|
| 103 | - /** client/html/catalog/detail/basket/standard/template-body |
|
| 104 | - * Relative path to the HTML body template of the catalog detail basket client. |
|
| 105 | - * |
|
| 106 | - * The template file contains the HTML code and processing instructions |
|
| 107 | - * to generate the result shown in the body of the frontend. The |
|
| 108 | - * configuration string is the path to the template file relative |
|
| 109 | - * to the templates directory (usually in client/html/templates). |
|
| 110 | - * |
|
| 111 | - * You can overwrite the template file configuration in extensions and |
|
| 112 | - * provide alternative templates. These alternative templates should be |
|
| 113 | - * named like the default one but with the string "standard" replaced by |
|
| 114 | - * an unique name. You may use the name of your project for this. If |
|
| 115 | - * you've implemented an alternative client class as well, "standard" |
|
| 116 | - * should be replaced by the name of the new class. |
|
| 117 | - * |
|
| 118 | - * @param string Relative path to the template creating code for the HTML page body |
|
| 119 | - * @since 2014.03 |
|
| 120 | - * @category Developer |
|
| 121 | - * @see client/html/catalog/detail/basket/standard/template-header |
|
| 122 | - */ |
|
| 123 | - $tplconf = 'client/html/catalog/detail/basket/standard/template-body'; |
|
| 124 | - $default = 'catalog/detail/basket-body-default.php'; |
|
| 125 | - |
|
| 126 | - return $view->render( $view->config( $tplconf, $default ) ); |
|
| 127 | - } |
|
| 128 | - |
|
| 129 | - |
|
| 130 | - /** |
|
| 131 | - * Returns the HTML string for insertion into the header. |
|
| 132 | - * |
|
| 133 | - * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
|
| 134 | - * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 135 | - * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 136 | - * @return string|null String including HTML tags for the header on error |
|
| 137 | - */ |
|
| 138 | - public function getHeader( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 139 | - { |
|
| 140 | - $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 141 | - |
|
| 142 | - $html = ''; |
|
| 143 | - foreach( $this->getSubClients() as $subclient ) { |
|
| 144 | - $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire ); |
|
| 145 | - } |
|
| 146 | - $view->basketHeader = $html; |
|
| 147 | - |
|
| 148 | - /** client/html/catalog/detail/basket/standard/template-header |
|
| 149 | - * Relative path to the HTML header template of the catalog detail basket client. |
|
| 150 | - * |
|
| 151 | - * The template file contains the HTML code and processing instructions |
|
| 152 | - * to generate the HTML code that is inserted into the HTML page header |
|
| 153 | - * of the rendered page in the frontend. The configuration string is the |
|
| 154 | - * path to the template file relative to the templates directory (usually |
|
| 155 | - * in client/html/templates). |
|
| 156 | - * |
|
| 157 | - * You can overwrite the template file configuration in extensions and |
|
| 158 | - * provide alternative templates. These alternative templates should be |
|
| 159 | - * named like the default one but with the string "standard" replaced by |
|
| 160 | - * an unique name. You may use the name of your project for this. If |
|
| 161 | - * you've implemented an alternative client class as well, "standard" |
|
| 162 | - * should be replaced by the name of the new class. |
|
| 163 | - * |
|
| 164 | - * @param string Relative path to the template creating code for the HTML page head |
|
| 165 | - * @since 2014.03 |
|
| 166 | - * @category Developer |
|
| 167 | - * @see client/html/catalog/detail/basket/standard/template-body |
|
| 168 | - */ |
|
| 169 | - $tplconf = 'client/html/catalog/detail/basket/standard/template-header'; |
|
| 170 | - $default = 'catalog/detail/basket-header-default.php'; |
|
| 171 | - |
|
| 172 | - return $view->render( $view->config( $tplconf, $default ) ); |
|
| 173 | - } |
|
| 174 | - |
|
| 175 | - |
|
| 176 | - /** |
|
| 177 | - * Returns the sub-client given by its name. |
|
| 178 | - * |
|
| 179 | - * @param string $type Name of the client type |
|
| 180 | - * @param string|null $name Name of the sub-client (Default if null) |
|
| 181 | - * @return \Aimeos\Client\Html\Iface Sub-client object |
|
| 182 | - */ |
|
| 183 | - public function getSubClient( $type, $name = null ) |
|
| 184 | - { |
|
| 185 | - /** client/html/catalog/detail/basket/decorators/excludes |
|
| 186 | - * Excludes decorators added by the "common" option from the catalog detail basket html client |
|
| 187 | - * |
|
| 188 | - * Decorators extend the functionality of a class by adding new aspects |
|
| 189 | - * (e.g. log what is currently done), executing the methods of the underlying |
|
| 190 | - * class only in certain conditions (e.g. only for logged in users) or |
|
| 191 | - * modify what is returned to the caller. |
|
| 192 | - * |
|
| 193 | - * This option allows you to remove a decorator added via |
|
| 194 | - * "client/html/common/decorators/default" before they are wrapped |
|
| 195 | - * around the html client. |
|
| 196 | - * |
|
| 197 | - * client/html/catalog/detail/basket/decorators/excludes = array( 'decorator1' ) |
|
| 198 | - * |
|
| 199 | - * This would remove the decorator named "decorator1" from the list of |
|
| 200 | - * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via |
|
| 201 | - * "client/html/common/decorators/default" to the html client. |
|
| 202 | - * |
|
| 203 | - * @param array List of decorator names |
|
| 204 | - * @since 2015.08 |
|
| 205 | - * @category Developer |
|
| 206 | - * @see client/html/common/decorators/default |
|
| 207 | - * @see client/html/catalog/detail/basket/decorators/global |
|
| 208 | - * @see client/html/catalog/detail/basket/decorators/local |
|
| 209 | - */ |
|
| 210 | - |
|
| 211 | - /** client/html/catalog/detail/basket/decorators/global |
|
| 212 | - * Adds a list of globally available decorators only to the catalog detail basket html client |
|
| 213 | - * |
|
| 214 | - * Decorators extend the functionality of a class by adding new aspects |
|
| 215 | - * (e.g. log what is currently done), executing the methods of the underlying |
|
| 216 | - * class only in certain conditions (e.g. only for logged in users) or |
|
| 217 | - * modify what is returned to the caller. |
|
| 218 | - * |
|
| 219 | - * This option allows you to wrap global decorators |
|
| 220 | - * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client. |
|
| 221 | - * |
|
| 222 | - * client/html/catalog/detail/basket/decorators/global = array( 'decorator1' ) |
|
| 223 | - * |
|
| 224 | - * This would add the decorator named "decorator1" defined by |
|
| 225 | - * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client. |
|
| 226 | - * |
|
| 227 | - * @param array List of decorator names |
|
| 228 | - * @since 2015.08 |
|
| 229 | - * @category Developer |
|
| 230 | - * @see client/html/common/decorators/default |
|
| 231 | - * @see client/html/catalog/detail/basket/decorators/excludes |
|
| 232 | - * @see client/html/catalog/detail/basket/decorators/local |
|
| 233 | - */ |
|
| 234 | - |
|
| 235 | - /** client/html/catalog/detail/basket/decorators/local |
|
| 236 | - * Adds a list of local decorators only to the catalog detail basket html client |
|
| 237 | - * |
|
| 238 | - * Decorators extend the functionality of a class by adding new aspects |
|
| 239 | - * (e.g. log what is currently done), executing the methods of the underlying |
|
| 240 | - * class only in certain conditions (e.g. only for logged in users) or |
|
| 241 | - * modify what is returned to the caller. |
|
| 242 | - * |
|
| 243 | - * This option allows you to wrap local decorators |
|
| 244 | - * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client. |
|
| 245 | - * |
|
| 246 | - * client/html/catalog/detail/basket/decorators/local = array( 'decorator2' ) |
|
| 247 | - * |
|
| 248 | - * This would add the decorator named "decorator2" defined by |
|
| 249 | - * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client. |
|
| 250 | - * |
|
| 251 | - * @param array List of decorator names |
|
| 252 | - * @since 2015.08 |
|
| 253 | - * @category Developer |
|
| 254 | - * @see client/html/common/decorators/default |
|
| 255 | - * @see client/html/catalog/detail/basket/decorators/excludes |
|
| 256 | - * @see client/html/catalog/detail/basket/decorators/global |
|
| 257 | - */ |
|
| 258 | - |
|
| 259 | - return $this->createSubClient( 'catalog/detail/basket/' . $type, $name ); |
|
| 260 | - } |
|
| 261 | - |
|
| 262 | - |
|
| 263 | - /** |
|
| 264 | - * Modifies the cached body content to replace content based on sessions or cookies. |
|
| 265 | - * |
|
| 266 | - * @param string $content Cached content |
|
| 267 | - * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
|
| 268 | - * @return string Modified body content |
|
| 269 | - */ |
|
| 270 | - public function modifyBody( $content, $uid ) |
|
| 271 | - { |
|
| 272 | - $content = parent::modifyBody( $content, $uid ); |
|
| 273 | - |
|
| 274 | - return $this->replaceSection( $content, $this->getView()->csrf()->formfield(), 'catalog.detail.basket.csrf' ); |
|
| 275 | - } |
|
| 276 | - |
|
| 277 | - |
|
| 278 | - /** |
|
| 279 | - * Returns the list of sub-client names configured for the client. |
|
| 280 | - * |
|
| 281 | - * @return array List of HTML client names |
|
| 282 | - */ |
|
| 283 | - protected function getSubClientNames() |
|
| 284 | - { |
|
| 285 | - return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames ); |
|
| 286 | - } |
|
| 287 | - |
|
| 288 | - |
|
| 289 | - /** |
|
| 290 | - * Sets the necessary parameter values in the view. |
|
| 291 | - * |
|
| 292 | - * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output |
|
| 293 | - * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 294 | - * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 295 | - * @return \Aimeos\MW\View\Iface Modified view object |
|
| 296 | - */ |
|
| 297 | - protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null ) |
|
| 298 | - { |
|
| 299 | - if( !isset( $this->cache ) ) |
|
| 300 | - { |
|
| 301 | - $config = $this->getContext()->getConfig(); |
|
| 302 | - |
|
| 303 | - /** client/html/catalog/detail/stock/enable |
|
| 304 | - * Enables or disables displaying product stock levels in product detail view |
|
| 305 | - * |
|
| 306 | - * This configuration option allows shop owners to display product |
|
| 307 | - * stock levels for each product in the detail views or to disable |
|
| 308 | - * fetching product stock information. |
|
| 309 | - * |
|
| 310 | - * The stock information is fetched via AJAX and inserted via Javascript. |
|
| 311 | - * This allows to cache product items by leaving out such highly |
|
| 312 | - * dynamic content like stock levels which changes with each order. |
|
| 313 | - * |
|
| 314 | - * @param boolean Value of "1" to display stock levels, "0" to disable displaying them |
|
| 315 | - * @since 2014.03 |
|
| 316 | - * @category User |
|
| 317 | - * @category Developer |
|
| 318 | - * @see client/html/catalog/lists/stock/enable |
|
| 319 | - * @see client/html/catalog/stock/url/target |
|
| 320 | - * @see client/html/catalog/stock/url/controller |
|
| 321 | - * @see client/html/catalog/stock/url/action |
|
| 322 | - * @see client/html/catalog/stock/url/config |
|
| 323 | - */ |
|
| 324 | - if( isset( $view->detailProductItem ) && $config->get( 'client/html/catalog/detail/stock/enable', true ) === true ) |
|
| 325 | - { |
|
| 326 | - $stockTarget = $config->get( 'client/html/catalog/stock/url/target' ); |
|
| 327 | - $stockController = $config->get( 'client/html/catalog/stock/url/controller', 'catalog' ); |
|
| 328 | - $stockAction = $config->get( 'client/html/catalog/stock/url/action', 'stock' ); |
|
| 329 | - $stockConfig = $config->get( 'client/html/catalog/stock/url/config', array() ); |
|
| 330 | - |
|
| 331 | - $prodIds = array_keys( $view->detailProductItem->getRefItems( 'product', null, 'default' ) ); |
|
| 332 | - array_unshift( $prodIds, $view->detailProductItem->getId() ); |
|
| 333 | - $params = array( 's_prodid' => $prodIds ); |
|
| 334 | - |
|
| 335 | - $view->basketStockUrl = $view->url( $stockTarget, $stockController, $stockAction, $params, array(), $stockConfig ); |
|
| 336 | - $view->basketProductIds = $prodIds; |
|
| 337 | - } |
|
| 338 | - |
|
| 339 | - $this->cache = $view; |
|
| 340 | - } |
|
| 341 | - |
|
| 342 | - return $this->cache; |
|
| 343 | - } |
|
| 25 | + /** client/html/catalog/detail/basket/standard/subparts |
|
| 26 | + * List of HTML sub-clients rendered within the catalog detail basket section |
|
| 27 | + * |
|
| 28 | + * The output of the frontend is composed of the code generated by the HTML |
|
| 29 | + * clients. Each HTML client can consist of serveral (or none) sub-clients |
|
| 30 | + * that are responsible for rendering certain sub-parts of the output. The |
|
| 31 | + * sub-clients can contain HTML clients themselves and therefore a |
|
| 32 | + * hierarchical tree of HTML clients is composed. Each HTML client creates |
|
| 33 | + * the output that is placed inside the container of its parent. |
|
| 34 | + * |
|
| 35 | + * At first, always the HTML code generated by the parent is printed, then |
|
| 36 | + * the HTML code of its sub-clients. The order of the HTML sub-clients |
|
| 37 | + * determines the order of the output of these sub-clients inside the parent |
|
| 38 | + * container. If the configured list of clients is |
|
| 39 | + * |
|
| 40 | + * array( "subclient1", "subclient2" ) |
|
| 41 | + * |
|
| 42 | + * you can easily change the order of the output by reordering the subparts: |
|
| 43 | + * |
|
| 44 | + * client/html/<clients>/subparts = array( "subclient1", "subclient2" ) |
|
| 45 | + * |
|
| 46 | + * You can also remove one or more parts if they shouldn't be rendered: |
|
| 47 | + * |
|
| 48 | + * client/html/<clients>/subparts = array( "subclient1" ) |
|
| 49 | + * |
|
| 50 | + * As the clients only generates structural HTML, the layout defined via CSS |
|
| 51 | + * should support adding, removing or reordering content by a fluid like |
|
| 52 | + * design. |
|
| 53 | + * |
|
| 54 | + * @param array List of sub-client names |
|
| 55 | + * @since 2014.03 |
|
| 56 | + * @category Developer |
|
| 57 | + */ |
|
| 58 | + private $subPartPath = 'client/html/catalog/detail/basket/standard/subparts'; |
|
| 59 | + |
|
| 60 | + /** client/html/catalog/detail/basket/selection/name |
|
| 61 | + * Name of the selection part used by the catalog detail basket client implementation |
|
| 62 | + * |
|
| 63 | + * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Detail\Basket\Selection\Myname". |
|
| 64 | + * The name is case-sensitive and you should avoid camel case names like "MyName". |
|
| 65 | + * |
|
| 66 | + * @param string Last part of the client class name |
|
| 67 | + * @since 2014.03 |
|
| 68 | + * @category Developer |
|
| 69 | + */ |
|
| 70 | + |
|
| 71 | + /** client/html/catalog/detail/basket/attribute/name |
|
| 72 | + * Name of the attribute part used by the catalog detail basket client implementation |
|
| 73 | + * |
|
| 74 | + * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Detail\Basket\Attribute\Myname". |
|
| 75 | + * The name is case-sensitive and you should avoid camel case names like "MyName". |
|
| 76 | + * |
|
| 77 | + * @param string Last part of the client class name |
|
| 78 | + * @since 2014.03 |
|
| 79 | + * @category Developer |
|
| 80 | + */ |
|
| 81 | + private $subPartNames = array( 'service', 'selection', 'attribute' ); |
|
| 82 | + private $cache; |
|
| 83 | + |
|
| 84 | + |
|
| 85 | + /** |
|
| 86 | + * Returns the HTML code for insertion into the body. |
|
| 87 | + * |
|
| 88 | + * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
|
| 89 | + * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 90 | + * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 91 | + * @return string HTML code |
|
| 92 | + */ |
|
| 93 | + public function getBody( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 94 | + { |
|
| 95 | + $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 96 | + |
|
| 97 | + $html = ''; |
|
| 98 | + foreach( $this->getSubClients() as $subclient ) { |
|
| 99 | + $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire ); |
|
| 100 | + } |
|
| 101 | + $view->basketBody = $html; |
|
| 102 | + |
|
| 103 | + /** client/html/catalog/detail/basket/standard/template-body |
|
| 104 | + * Relative path to the HTML body template of the catalog detail basket client. |
|
| 105 | + * |
|
| 106 | + * The template file contains the HTML code and processing instructions |
|
| 107 | + * to generate the result shown in the body of the frontend. The |
|
| 108 | + * configuration string is the path to the template file relative |
|
| 109 | + * to the templates directory (usually in client/html/templates). |
|
| 110 | + * |
|
| 111 | + * You can overwrite the template file configuration in extensions and |
|
| 112 | + * provide alternative templates. These alternative templates should be |
|
| 113 | + * named like the default one but with the string "standard" replaced by |
|
| 114 | + * an unique name. You may use the name of your project for this. If |
|
| 115 | + * you've implemented an alternative client class as well, "standard" |
|
| 116 | + * should be replaced by the name of the new class. |
|
| 117 | + * |
|
| 118 | + * @param string Relative path to the template creating code for the HTML page body |
|
| 119 | + * @since 2014.03 |
|
| 120 | + * @category Developer |
|
| 121 | + * @see client/html/catalog/detail/basket/standard/template-header |
|
| 122 | + */ |
|
| 123 | + $tplconf = 'client/html/catalog/detail/basket/standard/template-body'; |
|
| 124 | + $default = 'catalog/detail/basket-body-default.php'; |
|
| 125 | + |
|
| 126 | + return $view->render( $view->config( $tplconf, $default ) ); |
|
| 127 | + } |
|
| 128 | + |
|
| 129 | + |
|
| 130 | + /** |
|
| 131 | + * Returns the HTML string for insertion into the header. |
|
| 132 | + * |
|
| 133 | + * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
|
| 134 | + * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 135 | + * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 136 | + * @return string|null String including HTML tags for the header on error |
|
| 137 | + */ |
|
| 138 | + public function getHeader( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 139 | + { |
|
| 140 | + $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 141 | + |
|
| 142 | + $html = ''; |
|
| 143 | + foreach( $this->getSubClients() as $subclient ) { |
|
| 144 | + $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire ); |
|
| 145 | + } |
|
| 146 | + $view->basketHeader = $html; |
|
| 147 | + |
|
| 148 | + /** client/html/catalog/detail/basket/standard/template-header |
|
| 149 | + * Relative path to the HTML header template of the catalog detail basket client. |
|
| 150 | + * |
|
| 151 | + * The template file contains the HTML code and processing instructions |
|
| 152 | + * to generate the HTML code that is inserted into the HTML page header |
|
| 153 | + * of the rendered page in the frontend. The configuration string is the |
|
| 154 | + * path to the template file relative to the templates directory (usually |
|
| 155 | + * in client/html/templates). |
|
| 156 | + * |
|
| 157 | + * You can overwrite the template file configuration in extensions and |
|
| 158 | + * provide alternative templates. These alternative templates should be |
|
| 159 | + * named like the default one but with the string "standard" replaced by |
|
| 160 | + * an unique name. You may use the name of your project for this. If |
|
| 161 | + * you've implemented an alternative client class as well, "standard" |
|
| 162 | + * should be replaced by the name of the new class. |
|
| 163 | + * |
|
| 164 | + * @param string Relative path to the template creating code for the HTML page head |
|
| 165 | + * @since 2014.03 |
|
| 166 | + * @category Developer |
|
| 167 | + * @see client/html/catalog/detail/basket/standard/template-body |
|
| 168 | + */ |
|
| 169 | + $tplconf = 'client/html/catalog/detail/basket/standard/template-header'; |
|
| 170 | + $default = 'catalog/detail/basket-header-default.php'; |
|
| 171 | + |
|
| 172 | + return $view->render( $view->config( $tplconf, $default ) ); |
|
| 173 | + } |
|
| 174 | + |
|
| 175 | + |
|
| 176 | + /** |
|
| 177 | + * Returns the sub-client given by its name. |
|
| 178 | + * |
|
| 179 | + * @param string $type Name of the client type |
|
| 180 | + * @param string|null $name Name of the sub-client (Default if null) |
|
| 181 | + * @return \Aimeos\Client\Html\Iface Sub-client object |
|
| 182 | + */ |
|
| 183 | + public function getSubClient( $type, $name = null ) |
|
| 184 | + { |
|
| 185 | + /** client/html/catalog/detail/basket/decorators/excludes |
|
| 186 | + * Excludes decorators added by the "common" option from the catalog detail basket html client |
|
| 187 | + * |
|
| 188 | + * Decorators extend the functionality of a class by adding new aspects |
|
| 189 | + * (e.g. log what is currently done), executing the methods of the underlying |
|
| 190 | + * class only in certain conditions (e.g. only for logged in users) or |
|
| 191 | + * modify what is returned to the caller. |
|
| 192 | + * |
|
| 193 | + * This option allows you to remove a decorator added via |
|
| 194 | + * "client/html/common/decorators/default" before they are wrapped |
|
| 195 | + * around the html client. |
|
| 196 | + * |
|
| 197 | + * client/html/catalog/detail/basket/decorators/excludes = array( 'decorator1' ) |
|
| 198 | + * |
|
| 199 | + * This would remove the decorator named "decorator1" from the list of |
|
| 200 | + * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via |
|
| 201 | + * "client/html/common/decorators/default" to the html client. |
|
| 202 | + * |
|
| 203 | + * @param array List of decorator names |
|
| 204 | + * @since 2015.08 |
|
| 205 | + * @category Developer |
|
| 206 | + * @see client/html/common/decorators/default |
|
| 207 | + * @see client/html/catalog/detail/basket/decorators/global |
|
| 208 | + * @see client/html/catalog/detail/basket/decorators/local |
|
| 209 | + */ |
|
| 210 | + |
|
| 211 | + /** client/html/catalog/detail/basket/decorators/global |
|
| 212 | + * Adds a list of globally available decorators only to the catalog detail basket html client |
|
| 213 | + * |
|
| 214 | + * Decorators extend the functionality of a class by adding new aspects |
|
| 215 | + * (e.g. log what is currently done), executing the methods of the underlying |
|
| 216 | + * class only in certain conditions (e.g. only for logged in users) or |
|
| 217 | + * modify what is returned to the caller. |
|
| 218 | + * |
|
| 219 | + * This option allows you to wrap global decorators |
|
| 220 | + * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client. |
|
| 221 | + * |
|
| 222 | + * client/html/catalog/detail/basket/decorators/global = array( 'decorator1' ) |
|
| 223 | + * |
|
| 224 | + * This would add the decorator named "decorator1" defined by |
|
| 225 | + * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client. |
|
| 226 | + * |
|
| 227 | + * @param array List of decorator names |
|
| 228 | + * @since 2015.08 |
|
| 229 | + * @category Developer |
|
| 230 | + * @see client/html/common/decorators/default |
|
| 231 | + * @see client/html/catalog/detail/basket/decorators/excludes |
|
| 232 | + * @see client/html/catalog/detail/basket/decorators/local |
|
| 233 | + */ |
|
| 234 | + |
|
| 235 | + /** client/html/catalog/detail/basket/decorators/local |
|
| 236 | + * Adds a list of local decorators only to the catalog detail basket html client |
|
| 237 | + * |
|
| 238 | + * Decorators extend the functionality of a class by adding new aspects |
|
| 239 | + * (e.g. log what is currently done), executing the methods of the underlying |
|
| 240 | + * class only in certain conditions (e.g. only for logged in users) or |
|
| 241 | + * modify what is returned to the caller. |
|
| 242 | + * |
|
| 243 | + * This option allows you to wrap local decorators |
|
| 244 | + * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client. |
|
| 245 | + * |
|
| 246 | + * client/html/catalog/detail/basket/decorators/local = array( 'decorator2' ) |
|
| 247 | + * |
|
| 248 | + * This would add the decorator named "decorator2" defined by |
|
| 249 | + * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client. |
|
| 250 | + * |
|
| 251 | + * @param array List of decorator names |
|
| 252 | + * @since 2015.08 |
|
| 253 | + * @category Developer |
|
| 254 | + * @see client/html/common/decorators/default |
|
| 255 | + * @see client/html/catalog/detail/basket/decorators/excludes |
|
| 256 | + * @see client/html/catalog/detail/basket/decorators/global |
|
| 257 | + */ |
|
| 258 | + |
|
| 259 | + return $this->createSubClient( 'catalog/detail/basket/' . $type, $name ); |
|
| 260 | + } |
|
| 261 | + |
|
| 262 | + |
|
| 263 | + /** |
|
| 264 | + * Modifies the cached body content to replace content based on sessions or cookies. |
|
| 265 | + * |
|
| 266 | + * @param string $content Cached content |
|
| 267 | + * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
|
| 268 | + * @return string Modified body content |
|
| 269 | + */ |
|
| 270 | + public function modifyBody( $content, $uid ) |
|
| 271 | + { |
|
| 272 | + $content = parent::modifyBody( $content, $uid ); |
|
| 273 | + |
|
| 274 | + return $this->replaceSection( $content, $this->getView()->csrf()->formfield(), 'catalog.detail.basket.csrf' ); |
|
| 275 | + } |
|
| 276 | + |
|
| 277 | + |
|
| 278 | + /** |
|
| 279 | + * Returns the list of sub-client names configured for the client. |
|
| 280 | + * |
|
| 281 | + * @return array List of HTML client names |
|
| 282 | + */ |
|
| 283 | + protected function getSubClientNames() |
|
| 284 | + { |
|
| 285 | + return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames ); |
|
| 286 | + } |
|
| 287 | + |
|
| 288 | + |
|
| 289 | + /** |
|
| 290 | + * Sets the necessary parameter values in the view. |
|
| 291 | + * |
|
| 292 | + * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output |
|
| 293 | + * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 294 | + * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 295 | + * @return \Aimeos\MW\View\Iface Modified view object |
|
| 296 | + */ |
|
| 297 | + protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null ) |
|
| 298 | + { |
|
| 299 | + if( !isset( $this->cache ) ) |
|
| 300 | + { |
|
| 301 | + $config = $this->getContext()->getConfig(); |
|
| 302 | + |
|
| 303 | + /** client/html/catalog/detail/stock/enable |
|
| 304 | + * Enables or disables displaying product stock levels in product detail view |
|
| 305 | + * |
|
| 306 | + * This configuration option allows shop owners to display product |
|
| 307 | + * stock levels for each product in the detail views or to disable |
|
| 308 | + * fetching product stock information. |
|
| 309 | + * |
|
| 310 | + * The stock information is fetched via AJAX and inserted via Javascript. |
|
| 311 | + * This allows to cache product items by leaving out such highly |
|
| 312 | + * dynamic content like stock levels which changes with each order. |
|
| 313 | + * |
|
| 314 | + * @param boolean Value of "1" to display stock levels, "0" to disable displaying them |
|
| 315 | + * @since 2014.03 |
|
| 316 | + * @category User |
|
| 317 | + * @category Developer |
|
| 318 | + * @see client/html/catalog/lists/stock/enable |
|
| 319 | + * @see client/html/catalog/stock/url/target |
|
| 320 | + * @see client/html/catalog/stock/url/controller |
|
| 321 | + * @see client/html/catalog/stock/url/action |
|
| 322 | + * @see client/html/catalog/stock/url/config |
|
| 323 | + */ |
|
| 324 | + if( isset( $view->detailProductItem ) && $config->get( 'client/html/catalog/detail/stock/enable', true ) === true ) |
|
| 325 | + { |
|
| 326 | + $stockTarget = $config->get( 'client/html/catalog/stock/url/target' ); |
|
| 327 | + $stockController = $config->get( 'client/html/catalog/stock/url/controller', 'catalog' ); |
|
| 328 | + $stockAction = $config->get( 'client/html/catalog/stock/url/action', 'stock' ); |
|
| 329 | + $stockConfig = $config->get( 'client/html/catalog/stock/url/config', array() ); |
|
| 330 | + |
|
| 331 | + $prodIds = array_keys( $view->detailProductItem->getRefItems( 'product', null, 'default' ) ); |
|
| 332 | + array_unshift( $prodIds, $view->detailProductItem->getId() ); |
|
| 333 | + $params = array( 's_prodid' => $prodIds ); |
|
| 334 | + |
|
| 335 | + $view->basketStockUrl = $view->url( $stockTarget, $stockController, $stockAction, $params, array(), $stockConfig ); |
|
| 336 | + $view->basketProductIds = $prodIds; |
|
| 337 | + } |
|
| 338 | + |
|
| 339 | + $this->cache = $view; |
|
| 340 | + } |
|
| 341 | + |
|
| 342 | + return $this->cache; |
|
| 343 | + } |
|
| 344 | 344 | } |
| 345 | 345 | \ No newline at end of file |
@@ -78,7 +78,7 @@ discard block |
||
| 78 | 78 | * @since 2014.03 |
| 79 | 79 | * @category Developer |
| 80 | 80 | */ |
| 81 | - private $subPartNames = array( 'service', 'selection', 'attribute' ); |
|
| 81 | + private $subPartNames = array('service', 'selection', 'attribute'); |
|
| 82 | 82 | private $cache; |
| 83 | 83 | |
| 84 | 84 | |
@@ -90,13 +90,13 @@ discard block |
||
| 90 | 90 | * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
| 91 | 91 | * @return string HTML code |
| 92 | 92 | */ |
| 93 | - public function getBody( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 93 | + public function getBody($uid = '', array &$tags = array(), &$expire = null) |
|
| 94 | 94 | { |
| 95 | - $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 95 | + $view = $this->setViewParams($this->getView(), $tags, $expire); |
|
| 96 | 96 | |
| 97 | 97 | $html = ''; |
| 98 | - foreach( $this->getSubClients() as $subclient ) { |
|
| 99 | - $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire ); |
|
| 98 | + foreach ($this->getSubClients() as $subclient) { |
|
| 99 | + $html .= $subclient->setView($view)->getBody($uid, $tags, $expire); |
|
| 100 | 100 | } |
| 101 | 101 | $view->basketBody = $html; |
| 102 | 102 | |
@@ -123,7 +123,7 @@ discard block |
||
| 123 | 123 | $tplconf = 'client/html/catalog/detail/basket/standard/template-body'; |
| 124 | 124 | $default = 'catalog/detail/basket-body-default.php'; |
| 125 | 125 | |
| 126 | - return $view->render( $view->config( $tplconf, $default ) ); |
|
| 126 | + return $view->render($view->config($tplconf, $default)); |
|
| 127 | 127 | } |
| 128 | 128 | |
| 129 | 129 | |
@@ -135,13 +135,13 @@ discard block |
||
| 135 | 135 | * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
| 136 | 136 | * @return string|null String including HTML tags for the header on error |
| 137 | 137 | */ |
| 138 | - public function getHeader( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 138 | + public function getHeader($uid = '', array &$tags = array(), &$expire = null) |
|
| 139 | 139 | { |
| 140 | - $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 140 | + $view = $this->setViewParams($this->getView(), $tags, $expire); |
|
| 141 | 141 | |
| 142 | 142 | $html = ''; |
| 143 | - foreach( $this->getSubClients() as $subclient ) { |
|
| 144 | - $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire ); |
|
| 143 | + foreach ($this->getSubClients() as $subclient) { |
|
| 144 | + $html .= $subclient->setView($view)->getHeader($uid, $tags, $expire); |
|
| 145 | 145 | } |
| 146 | 146 | $view->basketHeader = $html; |
| 147 | 147 | |
@@ -169,7 +169,7 @@ discard block |
||
| 169 | 169 | $tplconf = 'client/html/catalog/detail/basket/standard/template-header'; |
| 170 | 170 | $default = 'catalog/detail/basket-header-default.php'; |
| 171 | 171 | |
| 172 | - return $view->render( $view->config( $tplconf, $default ) ); |
|
| 172 | + return $view->render($view->config($tplconf, $default)); |
|
| 173 | 173 | } |
| 174 | 174 | |
| 175 | 175 | |
@@ -180,7 +180,7 @@ discard block |
||
| 180 | 180 | * @param string|null $name Name of the sub-client (Default if null) |
| 181 | 181 | * @return \Aimeos\Client\Html\Iface Sub-client object |
| 182 | 182 | */ |
| 183 | - public function getSubClient( $type, $name = null ) |
|
| 183 | + public function getSubClient($type, $name = null) |
|
| 184 | 184 | { |
| 185 | 185 | /** client/html/catalog/detail/basket/decorators/excludes |
| 186 | 186 | * Excludes decorators added by the "common" option from the catalog detail basket html client |
@@ -256,7 +256,7 @@ discard block |
||
| 256 | 256 | * @see client/html/catalog/detail/basket/decorators/global |
| 257 | 257 | */ |
| 258 | 258 | |
| 259 | - return $this->createSubClient( 'catalog/detail/basket/' . $type, $name ); |
|
| 259 | + return $this->createSubClient('catalog/detail/basket/'.$type, $name); |
|
| 260 | 260 | } |
| 261 | 261 | |
| 262 | 262 | |
@@ -267,11 +267,11 @@ discard block |
||
| 267 | 267 | * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
| 268 | 268 | * @return string Modified body content |
| 269 | 269 | */ |
| 270 | - public function modifyBody( $content, $uid ) |
|
| 270 | + public function modifyBody($content, $uid) |
|
| 271 | 271 | { |
| 272 | - $content = parent::modifyBody( $content, $uid ); |
|
| 272 | + $content = parent::modifyBody($content, $uid); |
|
| 273 | 273 | |
| 274 | - return $this->replaceSection( $content, $this->getView()->csrf()->formfield(), 'catalog.detail.basket.csrf' ); |
|
| 274 | + return $this->replaceSection($content, $this->getView()->csrf()->formfield(), 'catalog.detail.basket.csrf'); |
|
| 275 | 275 | } |
| 276 | 276 | |
| 277 | 277 | |
@@ -282,7 +282,7 @@ discard block |
||
| 282 | 282 | */ |
| 283 | 283 | protected function getSubClientNames() |
| 284 | 284 | { |
| 285 | - return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames ); |
|
| 285 | + return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames); |
|
| 286 | 286 | } |
| 287 | 287 | |
| 288 | 288 | |
@@ -294,9 +294,9 @@ discard block |
||
| 294 | 294 | * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
| 295 | 295 | * @return \Aimeos\MW\View\Iface Modified view object |
| 296 | 296 | */ |
| 297 | - protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null ) |
|
| 297 | + protected function setViewParams(\Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null) |
|
| 298 | 298 | { |
| 299 | - if( !isset( $this->cache ) ) |
|
| 299 | + if (!isset($this->cache)) |
|
| 300 | 300 | { |
| 301 | 301 | $config = $this->getContext()->getConfig(); |
| 302 | 302 | |
@@ -321,18 +321,18 @@ discard block |
||
| 321 | 321 | * @see client/html/catalog/stock/url/action |
| 322 | 322 | * @see client/html/catalog/stock/url/config |
| 323 | 323 | */ |
| 324 | - if( isset( $view->detailProductItem ) && $config->get( 'client/html/catalog/detail/stock/enable', true ) === true ) |
|
| 324 | + if (isset($view->detailProductItem) && $config->get('client/html/catalog/detail/stock/enable', true) === true) |
|
| 325 | 325 | { |
| 326 | - $stockTarget = $config->get( 'client/html/catalog/stock/url/target' ); |
|
| 327 | - $stockController = $config->get( 'client/html/catalog/stock/url/controller', 'catalog' ); |
|
| 328 | - $stockAction = $config->get( 'client/html/catalog/stock/url/action', 'stock' ); |
|
| 329 | - $stockConfig = $config->get( 'client/html/catalog/stock/url/config', array() ); |
|
| 326 | + $stockTarget = $config->get('client/html/catalog/stock/url/target'); |
|
| 327 | + $stockController = $config->get('client/html/catalog/stock/url/controller', 'catalog'); |
|
| 328 | + $stockAction = $config->get('client/html/catalog/stock/url/action', 'stock'); |
|
| 329 | + $stockConfig = $config->get('client/html/catalog/stock/url/config', array()); |
|
| 330 | 330 | |
| 331 | - $prodIds = array_keys( $view->detailProductItem->getRefItems( 'product', null, 'default' ) ); |
|
| 332 | - array_unshift( $prodIds, $view->detailProductItem->getId() ); |
|
| 333 | - $params = array( 's_prodid' => $prodIds ); |
|
| 331 | + $prodIds = array_keys($view->detailProductItem->getRefItems('product', null, 'default')); |
|
| 332 | + array_unshift($prodIds, $view->detailProductItem->getId()); |
|
| 333 | + $params = array('s_prodid' => $prodIds); |
|
| 334 | 334 | |
| 335 | - $view->basketStockUrl = $view->url( $stockTarget, $stockController, $stockAction, $params, array(), $stockConfig ); |
|
| 335 | + $view->basketStockUrl = $view->url($stockTarget, $stockController, $stockAction, $params, array(), $stockConfig); |
|
| 336 | 336 | $view->basketProductIds = $prodIds; |
| 337 | 337 | } |
| 338 | 338 | |
@@ -110,7 +110,7 @@ |
||
| 110 | 110 | * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
| 111 | 111 | * @param array &$tags Result array for the list of tags that are associated to the output |
| 112 | 112 | * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
| 113 | - * @return string|null String including HTML tags for the header on error |
|
| 113 | + * @return string String including HTML tags for the header on error |
|
| 114 | 114 | */ |
| 115 | 115 | public function getHeader( $uid = '', array &$tags = array(), &$expire = null ) |
| 116 | 116 | { |
@@ -19,345 +19,345 @@ |
||
| 19 | 19 | * @subpackage Html |
| 20 | 20 | */ |
| 21 | 21 | class Standard |
| 22 | - extends \Aimeos\Client\Html\Common\Client\Factory\Base |
|
| 23 | - implements \Aimeos\Client\Html\Common\Client\Factory\Iface |
|
| 22 | + extends \Aimeos\Client\Html\Common\Client\Factory\Base |
|
| 23 | + implements \Aimeos\Client\Html\Common\Client\Factory\Iface |
|
| 24 | 24 | { |
| 25 | - /** client/html/catalog/detail/basket/selection/standard/subparts |
|
| 26 | - * List of HTML sub-clients rendered within the catalog detail basket selection section |
|
| 27 | - * |
|
| 28 | - * The output of the frontend is composed of the code generated by the HTML |
|
| 29 | - * clients. Each HTML client can consist of serveral (or none) sub-clients |
|
| 30 | - * that are responsible for rendering certain sub-parts of the output. The |
|
| 31 | - * sub-clients can contain HTML clients themselves and therefore a |
|
| 32 | - * hierarchical tree of HTML clients is composed. Each HTML client creates |
|
| 33 | - * the output that is placed inside the container of its parent. |
|
| 34 | - * |
|
| 35 | - * At first, always the HTML code generated by the parent is printed, then |
|
| 36 | - * the HTML code of its sub-clients. The order of the HTML sub-clients |
|
| 37 | - * determines the order of the output of these sub-clients inside the parent |
|
| 38 | - * container. If the configured list of clients is |
|
| 39 | - * |
|
| 40 | - * array( "subclient1", "subclient2" ) |
|
| 41 | - * |
|
| 42 | - * you can easily change the order of the output by reordering the subparts: |
|
| 43 | - * |
|
| 44 | - * client/html/<clients>/subparts = array( "subclient1", "subclient2" ) |
|
| 45 | - * |
|
| 46 | - * You can also remove one or more parts if they shouldn't be rendered: |
|
| 47 | - * |
|
| 48 | - * client/html/<clients>/subparts = array( "subclient1" ) |
|
| 49 | - * |
|
| 50 | - * As the clients only generates structural HTML, the layout defined via CSS |
|
| 51 | - * should support adding, removing or reordering content by a fluid like |
|
| 52 | - * design. |
|
| 53 | - * |
|
| 54 | - * @param array List of sub-client names |
|
| 55 | - * @since 2014.03 |
|
| 56 | - * @category Developer |
|
| 57 | - */ |
|
| 58 | - private $subPartPath = 'client/html/catalog/detail/basket/selection/standard/subparts'; |
|
| 59 | - private $subPartNames = array(); |
|
| 60 | - private $tags = array(); |
|
| 61 | - private $expire; |
|
| 62 | - private $cache; |
|
| 63 | - |
|
| 64 | - |
|
| 65 | - /** |
|
| 66 | - * Returns the HTML code for insertion into the body. |
|
| 67 | - * |
|
| 68 | - * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
|
| 69 | - * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 70 | - * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 71 | - * @return string HTML code |
|
| 72 | - */ |
|
| 73 | - public function getBody( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 74 | - { |
|
| 75 | - $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 76 | - |
|
| 77 | - $html = ''; |
|
| 78 | - foreach( $this->getSubClients() as $subclient ) { |
|
| 79 | - $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire ); |
|
| 80 | - } |
|
| 81 | - $view->selectionBody = $html; |
|
| 82 | - |
|
| 83 | - /** client/html/catalog/detail/basket/selection/standard/template-body |
|
| 84 | - * Relative path to the HTML body template of the catalog detail basket selection client. |
|
| 85 | - * |
|
| 86 | - * The template file contains the HTML code and processing instructions |
|
| 87 | - * to generate the result shown in the body of the frontend. The |
|
| 88 | - * configuration string is the path to the template file relative |
|
| 89 | - * to the templates directory (usually in client/html/templates). |
|
| 90 | - * |
|
| 91 | - * You can overwrite the template file configuration in extensions and |
|
| 92 | - * provide alternative templates. These alternative templates should be |
|
| 93 | - * named like the default one but with the string "standard" replaced by |
|
| 94 | - * an unique name. You may use the name of your project for this. If |
|
| 95 | - * you've implemented an alternative client class as well, "standard" |
|
| 96 | - * should be replaced by the name of the new class. |
|
| 97 | - * |
|
| 98 | - * @param string Relative path to the template creating code for the HTML page body |
|
| 99 | - * @since 2014.03 |
|
| 100 | - * @category Developer |
|
| 101 | - * @see client/html/catalog/detail/basket/selection/standard/template-header |
|
| 102 | - */ |
|
| 103 | - $tplconf = 'client/html/catalog/detail/basket/selection/standard/template-body'; |
|
| 104 | - $default = 'catalog/detail/basket-selection-body-default.php'; |
|
| 105 | - |
|
| 106 | - return $view->render( $view->config( $tplconf, $default ) ); |
|
| 107 | - } |
|
| 108 | - |
|
| 109 | - |
|
| 110 | - /** |
|
| 111 | - * Returns the HTML string for insertion into the header. |
|
| 112 | - * |
|
| 113 | - * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
|
| 114 | - * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 115 | - * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 116 | - * @return string|null String including HTML tags for the header on error |
|
| 117 | - */ |
|
| 118 | - public function getHeader( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 119 | - { |
|
| 120 | - $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 121 | - |
|
| 122 | - $html = ''; |
|
| 123 | - foreach( $this->getSubClients() as $subclient ) { |
|
| 124 | - $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire ); |
|
| 125 | - } |
|
| 126 | - $view->selectionHeader = $html; |
|
| 127 | - |
|
| 128 | - /** client/html/catalog/detail/basket/selection/standard/template-header |
|
| 129 | - * Relative path to the HTML header template of the catalog detail basket selection client. |
|
| 130 | - * |
|
| 131 | - * The template file contains the HTML code and processing instructions |
|
| 132 | - * to generate the HTML code that is inserted into the HTML page header |
|
| 133 | - * of the rendered page in the frontend. The configuration string is the |
|
| 134 | - * path to the template file relative to the templates directory (usually |
|
| 135 | - * in client/html/templates). |
|
| 136 | - * |
|
| 137 | - * You can overwrite the template file configuration in extensions and |
|
| 138 | - * provide alternative templates. These alternative templates should be |
|
| 139 | - * named like the default one but with the string "standard" replaced by |
|
| 140 | - * an unique name. You may use the name of your project for this. If |
|
| 141 | - * you've implemented an alternative client class as well, "standard" |
|
| 142 | - * should be replaced by the name of the new class. |
|
| 143 | - * |
|
| 144 | - * @param string Relative path to the template creating code for the HTML page head |
|
| 145 | - * @since 2014.03 |
|
| 146 | - * @category Developer |
|
| 147 | - * @see client/html/catalog/detail/basket/selection/standard/template-body |
|
| 148 | - */ |
|
| 149 | - $tplconf = 'client/html/catalog/detail/basket/selection/standard/template-header'; |
|
| 150 | - $default = 'catalog/detail/basket-selection-header-default.php'; |
|
| 151 | - |
|
| 152 | - return $view->render( $view->config( $tplconf, $default ) ); |
|
| 153 | - } |
|
| 154 | - |
|
| 155 | - |
|
| 156 | - /** |
|
| 157 | - * Returns the sub-client given by its name. |
|
| 158 | - * |
|
| 159 | - * @param string $type Name of the client type |
|
| 160 | - * @param string|null $name Name of the sub-client (Default if null) |
|
| 161 | - * @return \Aimeos\Client\Html\Iface Sub-client object |
|
| 162 | - */ |
|
| 163 | - public function getSubClient( $type, $name = null ) |
|
| 164 | - { |
|
| 165 | - /** client/html/catalog/detail/basket/selection/decorators/excludes |
|
| 166 | - * Excludes decorators added by the "common" option from the catalog detail basket selection html client |
|
| 167 | - * |
|
| 168 | - * Decorators extend the functionality of a class by adding new aspects |
|
| 169 | - * (e.g. log what is currently done), executing the methods of the underlying |
|
| 170 | - * class only in certain conditions (e.g. only for logged in users) or |
|
| 171 | - * modify what is returned to the caller. |
|
| 172 | - * |
|
| 173 | - * This option allows you to remove a decorator added via |
|
| 174 | - * "client/html/common/decorators/default" before they are wrapped |
|
| 175 | - * around the html client. |
|
| 176 | - * |
|
| 177 | - * client/html/catalog/detail/basket/selection/decorators/excludes = array( 'decorator1' ) |
|
| 178 | - * |
|
| 179 | - * This would remove the decorator named "decorator1" from the list of |
|
| 180 | - * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via |
|
| 181 | - * "client/html/common/decorators/default" to the html client. |
|
| 182 | - * |
|
| 183 | - * @param array List of decorator names |
|
| 184 | - * @since 2015.08 |
|
| 185 | - * @category Developer |
|
| 186 | - * @see client/html/common/decorators/default |
|
| 187 | - * @see client/html/catalog/detail/basket/selection/decorators/global |
|
| 188 | - * @see client/html/catalog/detail/basket/selection/decorators/local |
|
| 189 | - */ |
|
| 190 | - |
|
| 191 | - /** client/html/catalog/detail/basket/selection/decorators/global |
|
| 192 | - * Adds a list of globally available decorators only to the catalog detail basket selection html client |
|
| 193 | - * |
|
| 194 | - * Decorators extend the functionality of a class by adding new aspects |
|
| 195 | - * (e.g. log what is currently done), executing the methods of the underlying |
|
| 196 | - * class only in certain conditions (e.g. only for logged in users) or |
|
| 197 | - * modify what is returned to the caller. |
|
| 198 | - * |
|
| 199 | - * This option allows you to wrap global decorators |
|
| 200 | - * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client. |
|
| 201 | - * |
|
| 202 | - * client/html/catalog/detail/basket/selection/decorators/global = array( 'decorator1' ) |
|
| 203 | - * |
|
| 204 | - * This would add the decorator named "decorator1" defined by |
|
| 205 | - * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client. |
|
| 206 | - * |
|
| 207 | - * @param array List of decorator names |
|
| 208 | - * @since 2015.08 |
|
| 209 | - * @category Developer |
|
| 210 | - * @see client/html/common/decorators/default |
|
| 211 | - * @see client/html/catalog/detail/basket/selection/decorators/excludes |
|
| 212 | - * @see client/html/catalog/detail/basket/selection/decorators/local |
|
| 213 | - */ |
|
| 214 | - |
|
| 215 | - /** client/html/catalog/detail/basket/selection/decorators/local |
|
| 216 | - * Adds a list of local decorators only to the catalog detail basket selection html client |
|
| 217 | - * |
|
| 218 | - * Decorators extend the functionality of a class by adding new aspects |
|
| 219 | - * (e.g. log what is currently done), executing the methods of the underlying |
|
| 220 | - * class only in certain conditions (e.g. only for logged in users) or |
|
| 221 | - * modify what is returned to the caller. |
|
| 222 | - * |
|
| 223 | - * This option allows you to wrap local decorators |
|
| 224 | - * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client. |
|
| 225 | - * |
|
| 226 | - * client/html/catalog/detail/basket/selection/decorators/local = array( 'decorator2' ) |
|
| 227 | - * |
|
| 228 | - * This would add the decorator named "decorator2" defined by |
|
| 229 | - * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client. |
|
| 230 | - * |
|
| 231 | - * @param array List of decorator names |
|
| 232 | - * @since 2015.08 |
|
| 233 | - * @category Developer |
|
| 234 | - * @see client/html/common/decorators/default |
|
| 235 | - * @see client/html/catalog/detail/basket/selection/decorators/excludes |
|
| 236 | - * @see client/html/catalog/detail/basket/selection/decorators/global |
|
| 237 | - */ |
|
| 238 | - |
|
| 239 | - return $this->createSubClient( 'catalog/detail/basket/selection/' . $type, $name ); |
|
| 240 | - } |
|
| 241 | - |
|
| 242 | - |
|
| 243 | - /** |
|
| 244 | - * Returns the list of sub-client names configured for the client. |
|
| 245 | - * |
|
| 246 | - * @return array List of HTML client names |
|
| 247 | - */ |
|
| 248 | - protected function getSubClientNames() |
|
| 249 | - { |
|
| 250 | - return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames ); |
|
| 251 | - } |
|
| 252 | - |
|
| 253 | - |
|
| 254 | - /** |
|
| 255 | - * Sets the necessary parameter values in the view. |
|
| 256 | - * |
|
| 257 | - * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output |
|
| 258 | - * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 259 | - * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 260 | - * @return \Aimeos\MW\View\Iface Modified view object |
|
| 261 | - */ |
|
| 262 | - protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null ) |
|
| 263 | - { |
|
| 264 | - if( !isset( $this->cache ) ) |
|
| 265 | - { |
|
| 266 | - if( $view->detailProductItem->getType() === 'select' ) |
|
| 267 | - { |
|
| 268 | - $context = $this->getContext(); |
|
| 269 | - $config = $context->getConfig(); |
|
| 270 | - $domains = array( 'text', 'price', 'media', 'attribute' ); |
|
| 271 | - $products = $view->detailProductItem->getRefItems( 'product', 'default', 'default' ); |
|
| 272 | - |
|
| 273 | - /** client/html/catalog/detail/basket/selection/domains |
|
| 274 | - * A list of domain names whose items should be available in the basket |
|
| 275 | - * selection part of the catalog detail view templates |
|
| 276 | - * |
|
| 277 | - * The templates rendering basket selection related data usually add |
|
| 278 | - * the images and texts associated to each item. If you want to |
|
| 279 | - * display additional content like the attributes, you can configure |
|
| 280 | - * your own list of domains (attribute, media, price, product, text, |
|
| 281 | - * etc. are domains) whose items are fetched from the storage. |
|
| 282 | - * Please keep in mind that the more domains you add to the |
|
| 283 | - * configuration, the more time is required for fetching the content! |
|
| 284 | - * |
|
| 285 | - * @param array List of domain names |
|
| 286 | - * @since 2015.09 |
|
| 287 | - * @category Developer |
|
| 288 | - * @see client/html/catalog/detail/basket/selection/domains-attributes |
|
| 289 | - */ |
|
| 290 | - $domains = $config->get( 'client/html/catalog/detail/basket/selection/domains', $domains ); |
|
| 291 | - |
|
| 292 | - $controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' ); |
|
| 293 | - $subproducts = $controller->getProductItems( array_keys( $products ), $domains ); |
|
| 294 | - $attrIds = $prodDeps = $attrDeps = $attrTypeDeps = array(); |
|
| 295 | - |
|
| 296 | - foreach( $subproducts as $subProdId => $subProduct ) |
|
| 297 | - { |
|
| 298 | - foreach( $subProduct->getRefItems( 'attribute', null, 'variant' ) as $attrId => $attrItem ) |
|
| 299 | - { |
|
| 300 | - $attrTypeDeps[$attrItem->getType()][$attrId] = $attrItem->getPosition(); |
|
| 301 | - $attrDeps[$attrId][] = $subProdId; |
|
| 302 | - $prodDeps[$subProdId][] = $attrId; |
|
| 303 | - $attrIds[] = $attrId; |
|
| 304 | - } |
|
| 305 | - } |
|
| 306 | - |
|
| 307 | - ksort( $attrTypeDeps ); |
|
| 308 | - |
|
| 309 | - $this->addMetaItem( $subproducts, 'product', $this->expire, $this->tags ); |
|
| 310 | - $this->addMetaList( array_keys( $subproducts ), 'product', $this->expire ); |
|
| 311 | - |
|
| 312 | - |
|
| 313 | - $attrManager = $controller->createManager( 'attribute' ); |
|
| 314 | - |
|
| 315 | - $search = $attrManager->createSearch( true ); |
|
| 316 | - $expr = array( |
|
| 317 | - $search->compare( '==', 'attribute.id', $attrIds ), |
|
| 318 | - $search->getConditions(), |
|
| 319 | - ); |
|
| 320 | - $search->setConditions( $search->combine( '&&', $expr ) ); |
|
| 321 | - |
|
| 322 | - /** client/html/catalog/detail/basket/selection/domains-attributes |
|
| 323 | - * A list of domain names whose items should be available for the attributes |
|
| 324 | - * in the basket selection part of the catalog detail view templates |
|
| 325 | - * |
|
| 326 | - * The templates rendering basket selection related data usually add |
|
| 327 | - * the images and texts associated to each item. If you want to |
|
| 328 | - * display additional content like the attributes, you can configure |
|
| 329 | - * your own list of domains (attribute, media, price, product, text, |
|
| 330 | - * etc. are domains) whose items are fetched from the storage. |
|
| 331 | - * Please keep in mind that the more domains you add to the |
|
| 332 | - * configuration, the more time is required for fetching the content! |
|
| 333 | - * |
|
| 334 | - * @param array List of domain names |
|
| 335 | - * @since 2015.09 |
|
| 336 | - * @category Developer |
|
| 337 | - * @see client/html/catalog/detail/basket/selection/domains |
|
| 338 | - */ |
|
| 339 | - $domains = array( 'text', 'media' ); |
|
| 340 | - $domains = $config->get( 'client/html/catalog/detail/basket/selection/domains-attributes', $domains ); |
|
| 341 | - |
|
| 342 | - $attributes = $attrManager->searchItems( $search, $domains ); |
|
| 343 | - |
|
| 344 | - $this->addMetaItem( $attributes, 'attribute', $this->expire, $this->tags ); |
|
| 345 | - $this->addMetaList( array_keys( $attributes ), 'attribute', $this->expire ); |
|
| 346 | - |
|
| 347 | - |
|
| 348 | - $view->selectionProducts = $subproducts; |
|
| 349 | - $view->selectionProductDependencies = $prodDeps; |
|
| 350 | - $view->selectionAttributeDependencies = $attrDeps; |
|
| 351 | - $view->selectionAttributeTypeDependencies = $attrTypeDeps; |
|
| 352 | - $view->selectionAttributeItems = $attributes; |
|
| 353 | - } |
|
| 354 | - |
|
| 355 | - $this->cache = $view; |
|
| 356 | - } |
|
| 357 | - |
|
| 358 | - $expire = $this->expires( $this->expire, $expire ); |
|
| 359 | - $tags = array_merge( $tags, $this->tags ); |
|
| 360 | - |
|
| 361 | - return $this->cache; |
|
| 362 | - } |
|
| 25 | + /** client/html/catalog/detail/basket/selection/standard/subparts |
|
| 26 | + * List of HTML sub-clients rendered within the catalog detail basket selection section |
|
| 27 | + * |
|
| 28 | + * The output of the frontend is composed of the code generated by the HTML |
|
| 29 | + * clients. Each HTML client can consist of serveral (or none) sub-clients |
|
| 30 | + * that are responsible for rendering certain sub-parts of the output. The |
|
| 31 | + * sub-clients can contain HTML clients themselves and therefore a |
|
| 32 | + * hierarchical tree of HTML clients is composed. Each HTML client creates |
|
| 33 | + * the output that is placed inside the container of its parent. |
|
| 34 | + * |
|
| 35 | + * At first, always the HTML code generated by the parent is printed, then |
|
| 36 | + * the HTML code of its sub-clients. The order of the HTML sub-clients |
|
| 37 | + * determines the order of the output of these sub-clients inside the parent |
|
| 38 | + * container. If the configured list of clients is |
|
| 39 | + * |
|
| 40 | + * array( "subclient1", "subclient2" ) |
|
| 41 | + * |
|
| 42 | + * you can easily change the order of the output by reordering the subparts: |
|
| 43 | + * |
|
| 44 | + * client/html/<clients>/subparts = array( "subclient1", "subclient2" ) |
|
| 45 | + * |
|
| 46 | + * You can also remove one or more parts if they shouldn't be rendered: |
|
| 47 | + * |
|
| 48 | + * client/html/<clients>/subparts = array( "subclient1" ) |
|
| 49 | + * |
|
| 50 | + * As the clients only generates structural HTML, the layout defined via CSS |
|
| 51 | + * should support adding, removing or reordering content by a fluid like |
|
| 52 | + * design. |
|
| 53 | + * |
|
| 54 | + * @param array List of sub-client names |
|
| 55 | + * @since 2014.03 |
|
| 56 | + * @category Developer |
|
| 57 | + */ |
|
| 58 | + private $subPartPath = 'client/html/catalog/detail/basket/selection/standard/subparts'; |
|
| 59 | + private $subPartNames = array(); |
|
| 60 | + private $tags = array(); |
|
| 61 | + private $expire; |
|
| 62 | + private $cache; |
|
| 63 | + |
|
| 64 | + |
|
| 65 | + /** |
|
| 66 | + * Returns the HTML code for insertion into the body. |
|
| 67 | + * |
|
| 68 | + * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
|
| 69 | + * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 70 | + * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 71 | + * @return string HTML code |
|
| 72 | + */ |
|
| 73 | + public function getBody( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 74 | + { |
|
| 75 | + $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 76 | + |
|
| 77 | + $html = ''; |
|
| 78 | + foreach( $this->getSubClients() as $subclient ) { |
|
| 79 | + $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire ); |
|
| 80 | + } |
|
| 81 | + $view->selectionBody = $html; |
|
| 82 | + |
|
| 83 | + /** client/html/catalog/detail/basket/selection/standard/template-body |
|
| 84 | + * Relative path to the HTML body template of the catalog detail basket selection client. |
|
| 85 | + * |
|
| 86 | + * The template file contains the HTML code and processing instructions |
|
| 87 | + * to generate the result shown in the body of the frontend. The |
|
| 88 | + * configuration string is the path to the template file relative |
|
| 89 | + * to the templates directory (usually in client/html/templates). |
|
| 90 | + * |
|
| 91 | + * You can overwrite the template file configuration in extensions and |
|
| 92 | + * provide alternative templates. These alternative templates should be |
|
| 93 | + * named like the default one but with the string "standard" replaced by |
|
| 94 | + * an unique name. You may use the name of your project for this. If |
|
| 95 | + * you've implemented an alternative client class as well, "standard" |
|
| 96 | + * should be replaced by the name of the new class. |
|
| 97 | + * |
|
| 98 | + * @param string Relative path to the template creating code for the HTML page body |
|
| 99 | + * @since 2014.03 |
|
| 100 | + * @category Developer |
|
| 101 | + * @see client/html/catalog/detail/basket/selection/standard/template-header |
|
| 102 | + */ |
|
| 103 | + $tplconf = 'client/html/catalog/detail/basket/selection/standard/template-body'; |
|
| 104 | + $default = 'catalog/detail/basket-selection-body-default.php'; |
|
| 105 | + |
|
| 106 | + return $view->render( $view->config( $tplconf, $default ) ); |
|
| 107 | + } |
|
| 108 | + |
|
| 109 | + |
|
| 110 | + /** |
|
| 111 | + * Returns the HTML string for insertion into the header. |
|
| 112 | + * |
|
| 113 | + * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
|
| 114 | + * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 115 | + * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 116 | + * @return string|null String including HTML tags for the header on error |
|
| 117 | + */ |
|
| 118 | + public function getHeader( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 119 | + { |
|
| 120 | + $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 121 | + |
|
| 122 | + $html = ''; |
|
| 123 | + foreach( $this->getSubClients() as $subclient ) { |
|
| 124 | + $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire ); |
|
| 125 | + } |
|
| 126 | + $view->selectionHeader = $html; |
|
| 127 | + |
|
| 128 | + /** client/html/catalog/detail/basket/selection/standard/template-header |
|
| 129 | + * Relative path to the HTML header template of the catalog detail basket selection client. |
|
| 130 | + * |
|
| 131 | + * The template file contains the HTML code and processing instructions |
|
| 132 | + * to generate the HTML code that is inserted into the HTML page header |
|
| 133 | + * of the rendered page in the frontend. The configuration string is the |
|
| 134 | + * path to the template file relative to the templates directory (usually |
|
| 135 | + * in client/html/templates). |
|
| 136 | + * |
|
| 137 | + * You can overwrite the template file configuration in extensions and |
|
| 138 | + * provide alternative templates. These alternative templates should be |
|
| 139 | + * named like the default one but with the string "standard" replaced by |
|
| 140 | + * an unique name. You may use the name of your project for this. If |
|
| 141 | + * you've implemented an alternative client class as well, "standard" |
|
| 142 | + * should be replaced by the name of the new class. |
|
| 143 | + * |
|
| 144 | + * @param string Relative path to the template creating code for the HTML page head |
|
| 145 | + * @since 2014.03 |
|
| 146 | + * @category Developer |
|
| 147 | + * @see client/html/catalog/detail/basket/selection/standard/template-body |
|
| 148 | + */ |
|
| 149 | + $tplconf = 'client/html/catalog/detail/basket/selection/standard/template-header'; |
|
| 150 | + $default = 'catalog/detail/basket-selection-header-default.php'; |
|
| 151 | + |
|
| 152 | + return $view->render( $view->config( $tplconf, $default ) ); |
|
| 153 | + } |
|
| 154 | + |
|
| 155 | + |
|
| 156 | + /** |
|
| 157 | + * Returns the sub-client given by its name. |
|
| 158 | + * |
|
| 159 | + * @param string $type Name of the client type |
|
| 160 | + * @param string|null $name Name of the sub-client (Default if null) |
|
| 161 | + * @return \Aimeos\Client\Html\Iface Sub-client object |
|
| 162 | + */ |
|
| 163 | + public function getSubClient( $type, $name = null ) |
|
| 164 | + { |
|
| 165 | + /** client/html/catalog/detail/basket/selection/decorators/excludes |
|
| 166 | + * Excludes decorators added by the "common" option from the catalog detail basket selection html client |
|
| 167 | + * |
|
| 168 | + * Decorators extend the functionality of a class by adding new aspects |
|
| 169 | + * (e.g. log what is currently done), executing the methods of the underlying |
|
| 170 | + * class only in certain conditions (e.g. only for logged in users) or |
|
| 171 | + * modify what is returned to the caller. |
|
| 172 | + * |
|
| 173 | + * This option allows you to remove a decorator added via |
|
| 174 | + * "client/html/common/decorators/default" before they are wrapped |
|
| 175 | + * around the html client. |
|
| 176 | + * |
|
| 177 | + * client/html/catalog/detail/basket/selection/decorators/excludes = array( 'decorator1' ) |
|
| 178 | + * |
|
| 179 | + * This would remove the decorator named "decorator1" from the list of |
|
| 180 | + * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via |
|
| 181 | + * "client/html/common/decorators/default" to the html client. |
|
| 182 | + * |
|
| 183 | + * @param array List of decorator names |
|
| 184 | + * @since 2015.08 |
|
| 185 | + * @category Developer |
|
| 186 | + * @see client/html/common/decorators/default |
|
| 187 | + * @see client/html/catalog/detail/basket/selection/decorators/global |
|
| 188 | + * @see client/html/catalog/detail/basket/selection/decorators/local |
|
| 189 | + */ |
|
| 190 | + |
|
| 191 | + /** client/html/catalog/detail/basket/selection/decorators/global |
|
| 192 | + * Adds a list of globally available decorators only to the catalog detail basket selection html client |
|
| 193 | + * |
|
| 194 | + * Decorators extend the functionality of a class by adding new aspects |
|
| 195 | + * (e.g. log what is currently done), executing the methods of the underlying |
|
| 196 | + * class only in certain conditions (e.g. only for logged in users) or |
|
| 197 | + * modify what is returned to the caller. |
|
| 198 | + * |
|
| 199 | + * This option allows you to wrap global decorators |
|
| 200 | + * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client. |
|
| 201 | + * |
|
| 202 | + * client/html/catalog/detail/basket/selection/decorators/global = array( 'decorator1' ) |
|
| 203 | + * |
|
| 204 | + * This would add the decorator named "decorator1" defined by |
|
| 205 | + * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client. |
|
| 206 | + * |
|
| 207 | + * @param array List of decorator names |
|
| 208 | + * @since 2015.08 |
|
| 209 | + * @category Developer |
|
| 210 | + * @see client/html/common/decorators/default |
|
| 211 | + * @see client/html/catalog/detail/basket/selection/decorators/excludes |
|
| 212 | + * @see client/html/catalog/detail/basket/selection/decorators/local |
|
| 213 | + */ |
|
| 214 | + |
|
| 215 | + /** client/html/catalog/detail/basket/selection/decorators/local |
|
| 216 | + * Adds a list of local decorators only to the catalog detail basket selection html client |
|
| 217 | + * |
|
| 218 | + * Decorators extend the functionality of a class by adding new aspects |
|
| 219 | + * (e.g. log what is currently done), executing the methods of the underlying |
|
| 220 | + * class only in certain conditions (e.g. only for logged in users) or |
|
| 221 | + * modify what is returned to the caller. |
|
| 222 | + * |
|
| 223 | + * This option allows you to wrap local decorators |
|
| 224 | + * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client. |
|
| 225 | + * |
|
| 226 | + * client/html/catalog/detail/basket/selection/decorators/local = array( 'decorator2' ) |
|
| 227 | + * |
|
| 228 | + * This would add the decorator named "decorator2" defined by |
|
| 229 | + * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client. |
|
| 230 | + * |
|
| 231 | + * @param array List of decorator names |
|
| 232 | + * @since 2015.08 |
|
| 233 | + * @category Developer |
|
| 234 | + * @see client/html/common/decorators/default |
|
| 235 | + * @see client/html/catalog/detail/basket/selection/decorators/excludes |
|
| 236 | + * @see client/html/catalog/detail/basket/selection/decorators/global |
|
| 237 | + */ |
|
| 238 | + |
|
| 239 | + return $this->createSubClient( 'catalog/detail/basket/selection/' . $type, $name ); |
|
| 240 | + } |
|
| 241 | + |
|
| 242 | + |
|
| 243 | + /** |
|
| 244 | + * Returns the list of sub-client names configured for the client. |
|
| 245 | + * |
|
| 246 | + * @return array List of HTML client names |
|
| 247 | + */ |
|
| 248 | + protected function getSubClientNames() |
|
| 249 | + { |
|
| 250 | + return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames ); |
|
| 251 | + } |
|
| 252 | + |
|
| 253 | + |
|
| 254 | + /** |
|
| 255 | + * Sets the necessary parameter values in the view. |
|
| 256 | + * |
|
| 257 | + * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output |
|
| 258 | + * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 259 | + * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 260 | + * @return \Aimeos\MW\View\Iface Modified view object |
|
| 261 | + */ |
|
| 262 | + protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null ) |
|
| 263 | + { |
|
| 264 | + if( !isset( $this->cache ) ) |
|
| 265 | + { |
|
| 266 | + if( $view->detailProductItem->getType() === 'select' ) |
|
| 267 | + { |
|
| 268 | + $context = $this->getContext(); |
|
| 269 | + $config = $context->getConfig(); |
|
| 270 | + $domains = array( 'text', 'price', 'media', 'attribute' ); |
|
| 271 | + $products = $view->detailProductItem->getRefItems( 'product', 'default', 'default' ); |
|
| 272 | + |
|
| 273 | + /** client/html/catalog/detail/basket/selection/domains |
|
| 274 | + * A list of domain names whose items should be available in the basket |
|
| 275 | + * selection part of the catalog detail view templates |
|
| 276 | + * |
|
| 277 | + * The templates rendering basket selection related data usually add |
|
| 278 | + * the images and texts associated to each item. If you want to |
|
| 279 | + * display additional content like the attributes, you can configure |
|
| 280 | + * your own list of domains (attribute, media, price, product, text, |
|
| 281 | + * etc. are domains) whose items are fetched from the storage. |
|
| 282 | + * Please keep in mind that the more domains you add to the |
|
| 283 | + * configuration, the more time is required for fetching the content! |
|
| 284 | + * |
|
| 285 | + * @param array List of domain names |
|
| 286 | + * @since 2015.09 |
|
| 287 | + * @category Developer |
|
| 288 | + * @see client/html/catalog/detail/basket/selection/domains-attributes |
|
| 289 | + */ |
|
| 290 | + $domains = $config->get( 'client/html/catalog/detail/basket/selection/domains', $domains ); |
|
| 291 | + |
|
| 292 | + $controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' ); |
|
| 293 | + $subproducts = $controller->getProductItems( array_keys( $products ), $domains ); |
|
| 294 | + $attrIds = $prodDeps = $attrDeps = $attrTypeDeps = array(); |
|
| 295 | + |
|
| 296 | + foreach( $subproducts as $subProdId => $subProduct ) |
|
| 297 | + { |
|
| 298 | + foreach( $subProduct->getRefItems( 'attribute', null, 'variant' ) as $attrId => $attrItem ) |
|
| 299 | + { |
|
| 300 | + $attrTypeDeps[$attrItem->getType()][$attrId] = $attrItem->getPosition(); |
|
| 301 | + $attrDeps[$attrId][] = $subProdId; |
|
| 302 | + $prodDeps[$subProdId][] = $attrId; |
|
| 303 | + $attrIds[] = $attrId; |
|
| 304 | + } |
|
| 305 | + } |
|
| 306 | + |
|
| 307 | + ksort( $attrTypeDeps ); |
|
| 308 | + |
|
| 309 | + $this->addMetaItem( $subproducts, 'product', $this->expire, $this->tags ); |
|
| 310 | + $this->addMetaList( array_keys( $subproducts ), 'product', $this->expire ); |
|
| 311 | + |
|
| 312 | + |
|
| 313 | + $attrManager = $controller->createManager( 'attribute' ); |
|
| 314 | + |
|
| 315 | + $search = $attrManager->createSearch( true ); |
|
| 316 | + $expr = array( |
|
| 317 | + $search->compare( '==', 'attribute.id', $attrIds ), |
|
| 318 | + $search->getConditions(), |
|
| 319 | + ); |
|
| 320 | + $search->setConditions( $search->combine( '&&', $expr ) ); |
|
| 321 | + |
|
| 322 | + /** client/html/catalog/detail/basket/selection/domains-attributes |
|
| 323 | + * A list of domain names whose items should be available for the attributes |
|
| 324 | + * in the basket selection part of the catalog detail view templates |
|
| 325 | + * |
|
| 326 | + * The templates rendering basket selection related data usually add |
|
| 327 | + * the images and texts associated to each item. If you want to |
|
| 328 | + * display additional content like the attributes, you can configure |
|
| 329 | + * your own list of domains (attribute, media, price, product, text, |
|
| 330 | + * etc. are domains) whose items are fetched from the storage. |
|
| 331 | + * Please keep in mind that the more domains you add to the |
|
| 332 | + * configuration, the more time is required for fetching the content! |
|
| 333 | + * |
|
| 334 | + * @param array List of domain names |
|
| 335 | + * @since 2015.09 |
|
| 336 | + * @category Developer |
|
| 337 | + * @see client/html/catalog/detail/basket/selection/domains |
|
| 338 | + */ |
|
| 339 | + $domains = array( 'text', 'media' ); |
|
| 340 | + $domains = $config->get( 'client/html/catalog/detail/basket/selection/domains-attributes', $domains ); |
|
| 341 | + |
|
| 342 | + $attributes = $attrManager->searchItems( $search, $domains ); |
|
| 343 | + |
|
| 344 | + $this->addMetaItem( $attributes, 'attribute', $this->expire, $this->tags ); |
|
| 345 | + $this->addMetaList( array_keys( $attributes ), 'attribute', $this->expire ); |
|
| 346 | + |
|
| 347 | + |
|
| 348 | + $view->selectionProducts = $subproducts; |
|
| 349 | + $view->selectionProductDependencies = $prodDeps; |
|
| 350 | + $view->selectionAttributeDependencies = $attrDeps; |
|
| 351 | + $view->selectionAttributeTypeDependencies = $attrTypeDeps; |
|
| 352 | + $view->selectionAttributeItems = $attributes; |
|
| 353 | + } |
|
| 354 | + |
|
| 355 | + $this->cache = $view; |
|
| 356 | + } |
|
| 357 | + |
|
| 358 | + $expire = $this->expires( $this->expire, $expire ); |
|
| 359 | + $tags = array_merge( $tags, $this->tags ); |
|
| 360 | + |
|
| 361 | + return $this->cache; |
|
| 362 | + } |
|
| 363 | 363 | } |
| 364 | 364 | \ No newline at end of file |
@@ -70,13 +70,13 @@ discard block |
||
| 70 | 70 | * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
| 71 | 71 | * @return string HTML code |
| 72 | 72 | */ |
| 73 | - public function getBody( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 73 | + public function getBody($uid = '', array &$tags = array(), &$expire = null) |
|
| 74 | 74 | { |
| 75 | - $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 75 | + $view = $this->setViewParams($this->getView(), $tags, $expire); |
|
| 76 | 76 | |
| 77 | 77 | $html = ''; |
| 78 | - foreach( $this->getSubClients() as $subclient ) { |
|
| 79 | - $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire ); |
|
| 78 | + foreach ($this->getSubClients() as $subclient) { |
|
| 79 | + $html .= $subclient->setView($view)->getBody($uid, $tags, $expire); |
|
| 80 | 80 | } |
| 81 | 81 | $view->selectionBody = $html; |
| 82 | 82 | |
@@ -103,7 +103,7 @@ discard block |
||
| 103 | 103 | $tplconf = 'client/html/catalog/detail/basket/selection/standard/template-body'; |
| 104 | 104 | $default = 'catalog/detail/basket-selection-body-default.php'; |
| 105 | 105 | |
| 106 | - return $view->render( $view->config( $tplconf, $default ) ); |
|
| 106 | + return $view->render($view->config($tplconf, $default)); |
|
| 107 | 107 | } |
| 108 | 108 | |
| 109 | 109 | |
@@ -115,13 +115,13 @@ discard block |
||
| 115 | 115 | * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
| 116 | 116 | * @return string|null String including HTML tags for the header on error |
| 117 | 117 | */ |
| 118 | - public function getHeader( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 118 | + public function getHeader($uid = '', array &$tags = array(), &$expire = null) |
|
| 119 | 119 | { |
| 120 | - $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 120 | + $view = $this->setViewParams($this->getView(), $tags, $expire); |
|
| 121 | 121 | |
| 122 | 122 | $html = ''; |
| 123 | - foreach( $this->getSubClients() as $subclient ) { |
|
| 124 | - $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire ); |
|
| 123 | + foreach ($this->getSubClients() as $subclient) { |
|
| 124 | + $html .= $subclient->setView($view)->getHeader($uid, $tags, $expire); |
|
| 125 | 125 | } |
| 126 | 126 | $view->selectionHeader = $html; |
| 127 | 127 | |
@@ -149,7 +149,7 @@ discard block |
||
| 149 | 149 | $tplconf = 'client/html/catalog/detail/basket/selection/standard/template-header'; |
| 150 | 150 | $default = 'catalog/detail/basket-selection-header-default.php'; |
| 151 | 151 | |
| 152 | - return $view->render( $view->config( $tplconf, $default ) ); |
|
| 152 | + return $view->render($view->config($tplconf, $default)); |
|
| 153 | 153 | } |
| 154 | 154 | |
| 155 | 155 | |
@@ -160,7 +160,7 @@ discard block |
||
| 160 | 160 | * @param string|null $name Name of the sub-client (Default if null) |
| 161 | 161 | * @return \Aimeos\Client\Html\Iface Sub-client object |
| 162 | 162 | */ |
| 163 | - public function getSubClient( $type, $name = null ) |
|
| 163 | + public function getSubClient($type, $name = null) |
|
| 164 | 164 | { |
| 165 | 165 | /** client/html/catalog/detail/basket/selection/decorators/excludes |
| 166 | 166 | * Excludes decorators added by the "common" option from the catalog detail basket selection html client |
@@ -236,7 +236,7 @@ discard block |
||
| 236 | 236 | * @see client/html/catalog/detail/basket/selection/decorators/global |
| 237 | 237 | */ |
| 238 | 238 | |
| 239 | - return $this->createSubClient( 'catalog/detail/basket/selection/' . $type, $name ); |
|
| 239 | + return $this->createSubClient('catalog/detail/basket/selection/'.$type, $name); |
|
| 240 | 240 | } |
| 241 | 241 | |
| 242 | 242 | |
@@ -247,7 +247,7 @@ discard block |
||
| 247 | 247 | */ |
| 248 | 248 | protected function getSubClientNames() |
| 249 | 249 | { |
| 250 | - return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames ); |
|
| 250 | + return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames); |
|
| 251 | 251 | } |
| 252 | 252 | |
| 253 | 253 | |
@@ -259,16 +259,16 @@ discard block |
||
| 259 | 259 | * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
| 260 | 260 | * @return \Aimeos\MW\View\Iface Modified view object |
| 261 | 261 | */ |
| 262 | - protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null ) |
|
| 262 | + protected function setViewParams(\Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null) |
|
| 263 | 263 | { |
| 264 | - if( !isset( $this->cache ) ) |
|
| 264 | + if (!isset($this->cache)) |
|
| 265 | 265 | { |
| 266 | - if( $view->detailProductItem->getType() === 'select' ) |
|
| 266 | + if ($view->detailProductItem->getType() === 'select') |
|
| 267 | 267 | { |
| 268 | 268 | $context = $this->getContext(); |
| 269 | 269 | $config = $context->getConfig(); |
| 270 | - $domains = array( 'text', 'price', 'media', 'attribute' ); |
|
| 271 | - $products = $view->detailProductItem->getRefItems( 'product', 'default', 'default' ); |
|
| 270 | + $domains = array('text', 'price', 'media', 'attribute'); |
|
| 271 | + $products = $view->detailProductItem->getRefItems('product', 'default', 'default'); |
|
| 272 | 272 | |
| 273 | 273 | /** client/html/catalog/detail/basket/selection/domains |
| 274 | 274 | * A list of domain names whose items should be available in the basket |
@@ -287,15 +287,15 @@ discard block |
||
| 287 | 287 | * @category Developer |
| 288 | 288 | * @see client/html/catalog/detail/basket/selection/domains-attributes |
| 289 | 289 | */ |
| 290 | - $domains = $config->get( 'client/html/catalog/detail/basket/selection/domains', $domains ); |
|
| 290 | + $domains = $config->get('client/html/catalog/detail/basket/selection/domains', $domains); |
|
| 291 | 291 | |
| 292 | - $controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' ); |
|
| 293 | - $subproducts = $controller->getProductItems( array_keys( $products ), $domains ); |
|
| 292 | + $controller = \Aimeos\Controller\Frontend\Factory::createController($context, 'catalog'); |
|
| 293 | + $subproducts = $controller->getProductItems(array_keys($products), $domains); |
|
| 294 | 294 | $attrIds = $prodDeps = $attrDeps = $attrTypeDeps = array(); |
| 295 | 295 | |
| 296 | - foreach( $subproducts as $subProdId => $subProduct ) |
|
| 296 | + foreach ($subproducts as $subProdId => $subProduct) |
|
| 297 | 297 | { |
| 298 | - foreach( $subProduct->getRefItems( 'attribute', null, 'variant' ) as $attrId => $attrItem ) |
|
| 298 | + foreach ($subProduct->getRefItems('attribute', null, 'variant') as $attrId => $attrItem) |
|
| 299 | 299 | { |
| 300 | 300 | $attrTypeDeps[$attrItem->getType()][$attrId] = $attrItem->getPosition(); |
| 301 | 301 | $attrDeps[$attrId][] = $subProdId; |
@@ -304,20 +304,20 @@ discard block |
||
| 304 | 304 | } |
| 305 | 305 | } |
| 306 | 306 | |
| 307 | - ksort( $attrTypeDeps ); |
|
| 307 | + ksort($attrTypeDeps); |
|
| 308 | 308 | |
| 309 | - $this->addMetaItem( $subproducts, 'product', $this->expire, $this->tags ); |
|
| 310 | - $this->addMetaList( array_keys( $subproducts ), 'product', $this->expire ); |
|
| 309 | + $this->addMetaItem($subproducts, 'product', $this->expire, $this->tags); |
|
| 310 | + $this->addMetaList(array_keys($subproducts), 'product', $this->expire); |
|
| 311 | 311 | |
| 312 | 312 | |
| 313 | - $attrManager = $controller->createManager( 'attribute' ); |
|
| 313 | + $attrManager = $controller->createManager('attribute'); |
|
| 314 | 314 | |
| 315 | - $search = $attrManager->createSearch( true ); |
|
| 315 | + $search = $attrManager->createSearch(true); |
|
| 316 | 316 | $expr = array( |
| 317 | - $search->compare( '==', 'attribute.id', $attrIds ), |
|
| 317 | + $search->compare('==', 'attribute.id', $attrIds), |
|
| 318 | 318 | $search->getConditions(), |
| 319 | 319 | ); |
| 320 | - $search->setConditions( $search->combine( '&&', $expr ) ); |
|
| 320 | + $search->setConditions($search->combine('&&', $expr)); |
|
| 321 | 321 | |
| 322 | 322 | /** client/html/catalog/detail/basket/selection/domains-attributes |
| 323 | 323 | * A list of domain names whose items should be available for the attributes |
@@ -336,13 +336,13 @@ discard block |
||
| 336 | 336 | * @category Developer |
| 337 | 337 | * @see client/html/catalog/detail/basket/selection/domains |
| 338 | 338 | */ |
| 339 | - $domains = array( 'text', 'media' ); |
|
| 340 | - $domains = $config->get( 'client/html/catalog/detail/basket/selection/domains-attributes', $domains ); |
|
| 339 | + $domains = array('text', 'media'); |
|
| 340 | + $domains = $config->get('client/html/catalog/detail/basket/selection/domains-attributes', $domains); |
|
| 341 | 341 | |
| 342 | - $attributes = $attrManager->searchItems( $search, $domains ); |
|
| 342 | + $attributes = $attrManager->searchItems($search, $domains); |
|
| 343 | 343 | |
| 344 | - $this->addMetaItem( $attributes, 'attribute', $this->expire, $this->tags ); |
|
| 345 | - $this->addMetaList( array_keys( $attributes ), 'attribute', $this->expire ); |
|
| 344 | + $this->addMetaItem($attributes, 'attribute', $this->expire, $this->tags); |
|
| 345 | + $this->addMetaList(array_keys($attributes), 'attribute', $this->expire); |
|
| 346 | 346 | |
| 347 | 347 | |
| 348 | 348 | $view->selectionProducts = $subproducts; |
@@ -355,8 +355,8 @@ discard block |
||
| 355 | 355 | $this->cache = $view; |
| 356 | 356 | } |
| 357 | 357 | |
| 358 | - $expire = $this->expires( $this->expire, $expire ); |
|
| 359 | - $tags = array_merge( $tags, $this->tags ); |
|
| 358 | + $expire = $this->expires($this->expire, $expire); |
|
| 359 | + $tags = array_merge($tags, $this->tags); |
|
| 360 | 360 | |
| 361 | 361 | return $this->cache; |
| 362 | 362 | } |
@@ -110,7 +110,7 @@ |
||
| 110 | 110 | * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
| 111 | 111 | * @param array &$tags Result array for the list of tags that are associated to the output |
| 112 | 112 | * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
| 113 | - * @return string|null String including HTML tags for the header on error |
|
| 113 | + * @return string String including HTML tags for the header on error |
|
| 114 | 114 | */ |
| 115 | 115 | public function getHeader( $uid = '', array &$tags = array(), &$expire = null ) |
| 116 | 116 | { |
@@ -19,231 +19,231 @@ |
||
| 19 | 19 | * @subpackage Html |
| 20 | 20 | */ |
| 21 | 21 | class Standard |
| 22 | - extends \Aimeos\Client\Html\Common\Client\Factory\Base |
|
| 23 | - implements \Aimeos\Client\Html\Common\Client\Factory\Iface |
|
| 22 | + extends \Aimeos\Client\Html\Common\Client\Factory\Base |
|
| 23 | + implements \Aimeos\Client\Html\Common\Client\Factory\Iface |
|
| 24 | 24 | { |
| 25 | - /** client/html/catalog/detail/image/standard/subparts |
|
| 26 | - * List of HTML sub-clients rendered within the catalog detail image section |
|
| 27 | - * |
|
| 28 | - * The output of the frontend is composed of the code generated by the HTML |
|
| 29 | - * clients. Each HTML client can consist of serveral (or none) sub-clients |
|
| 30 | - * that are responsible for rendering certain sub-parts of the output. The |
|
| 31 | - * sub-clients can contain HTML clients themselves and therefore a |
|
| 32 | - * hierarchical tree of HTML clients is composed. Each HTML client creates |
|
| 33 | - * the output that is placed inside the container of its parent. |
|
| 34 | - * |
|
| 35 | - * At first, always the HTML code generated by the parent is printed, then |
|
| 36 | - * the HTML code of its sub-clients. The order of the HTML sub-clients |
|
| 37 | - * determines the order of the output of these sub-clients inside the parent |
|
| 38 | - * container. If the configured list of clients is |
|
| 39 | - * |
|
| 40 | - * array( "subclient1", "subclient2" ) |
|
| 41 | - * |
|
| 42 | - * you can easily change the order of the output by reordering the subparts: |
|
| 43 | - * |
|
| 44 | - * client/html/<clients>/subparts = array( "subclient1", "subclient2" ) |
|
| 45 | - * |
|
| 46 | - * You can also remove one or more parts if they shouldn't be rendered: |
|
| 47 | - * |
|
| 48 | - * client/html/<clients>/subparts = array( "subclient1" ) |
|
| 49 | - * |
|
| 50 | - * As the clients only generates structural HTML, the layout defined via CSS |
|
| 51 | - * should support adding, removing or reordering content by a fluid like |
|
| 52 | - * design. |
|
| 53 | - * |
|
| 54 | - * @param array List of sub-client names |
|
| 55 | - * @since 2014.03 |
|
| 56 | - * @category Developer |
|
| 57 | - */ |
|
| 58 | - private $subPartPath = 'client/html/catalog/detail/image/standard/subparts'; |
|
| 59 | - private $subPartNames = array(); |
|
| 60 | - |
|
| 61 | - |
|
| 62 | - /** |
|
| 63 | - * Returns the HTML code for insertion into the body. |
|
| 64 | - * |
|
| 65 | - * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
|
| 66 | - * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 67 | - * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 68 | - * @return string HTML code |
|
| 69 | - */ |
|
| 70 | - public function getBody( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 71 | - { |
|
| 72 | - $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 73 | - |
|
| 74 | - $html = ''; |
|
| 75 | - foreach( $this->getSubClients() as $subclient ) { |
|
| 76 | - $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire ); |
|
| 77 | - } |
|
| 78 | - $view->imageBody = $html; |
|
| 79 | - |
|
| 80 | - /** client/html/catalog/detail/image/standard/template-body |
|
| 81 | - * Relative path to the HTML body template of the catalog detail image client. |
|
| 82 | - * |
|
| 83 | - * The template file contains the HTML code and processing instructions |
|
| 84 | - * to generate the result shown in the body of the frontend. The |
|
| 85 | - * configuration string is the path to the template file relative |
|
| 86 | - * to the templates directory (usually in client/html/templates). |
|
| 87 | - * |
|
| 88 | - * You can overwrite the template file configuration in extensions and |
|
| 89 | - * provide alternative templates. These alternative templates should be |
|
| 90 | - * named like the default one but with the string "standard" replaced by |
|
| 91 | - * an unique name. You may use the name of your project for this. If |
|
| 92 | - * you've implemented an alternative client class as well, "standard" |
|
| 93 | - * should be replaced by the name of the new class. |
|
| 94 | - * |
|
| 95 | - * @param string Relative path to the template creating code for the HTML page body |
|
| 96 | - * @since 2014.03 |
|
| 97 | - * @category Developer |
|
| 98 | - * @see client/html/catalog/detail/image/standard/template-header |
|
| 99 | - */ |
|
| 100 | - $tplconf = 'client/html/catalog/detail/image/standard/template-body'; |
|
| 101 | - $default = 'catalog/detail/image-body-bottom.php'; |
|
| 102 | - |
|
| 103 | - return $view->render( $view->config( $tplconf, $default ) ); |
|
| 104 | - } |
|
| 105 | - |
|
| 106 | - |
|
| 107 | - /** |
|
| 108 | - * Returns the HTML string for insertion into the header. |
|
| 109 | - * |
|
| 110 | - * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
|
| 111 | - * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 112 | - * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 113 | - * @return string|null String including HTML tags for the header on error |
|
| 114 | - */ |
|
| 115 | - public function getHeader( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 116 | - { |
|
| 117 | - $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 118 | - |
|
| 119 | - $html = ''; |
|
| 120 | - foreach( $this->getSubClients() as $subclient ) { |
|
| 121 | - $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire ); |
|
| 122 | - } |
|
| 123 | - $view->imageHeader = $html; |
|
| 124 | - |
|
| 125 | - /** client/html/catalog/detail/image/standard/template-header |
|
| 126 | - * Relative path to the HTML header template of the catalog detail image client. |
|
| 127 | - * |
|
| 128 | - * The template file contains the HTML code and processing instructions |
|
| 129 | - * to generate the HTML code that is inserted into the HTML page header |
|
| 130 | - * of the rendered page in the frontend. The configuration string is the |
|
| 131 | - * path to the template file relative to the templates directory (usually |
|
| 132 | - * in client/html/templates). |
|
| 133 | - * |
|
| 134 | - * You can overwrite the template file configuration in extensions and |
|
| 135 | - * provide alternative templates. These alternative templates should be |
|
| 136 | - * named like the default one but with the string "standard" replaced by |
|
| 137 | - * an unique name. You may use the name of your project for this. If |
|
| 138 | - * you've implemented an alternative client class as well, "standard" |
|
| 139 | - * should be replaced by the name of the new class. |
|
| 140 | - * |
|
| 141 | - * @param string Relative path to the template creating code for the HTML page head |
|
| 142 | - * @since 2014.03 |
|
| 143 | - * @category Developer |
|
| 144 | - * @see client/html/catalog/detail/image/standard/template-body |
|
| 145 | - */ |
|
| 146 | - $tplconf = 'client/html/catalog/detail/image/standard/template-header'; |
|
| 147 | - $default = 'catalog/detail/image-header-default.php'; |
|
| 148 | - |
|
| 149 | - return $view->render( $view->config( $tplconf, $default ) ); |
|
| 150 | - } |
|
| 151 | - |
|
| 152 | - |
|
| 153 | - /** |
|
| 154 | - * Returns the sub-client given by its name. |
|
| 155 | - * |
|
| 156 | - * @param string $type Name of the client type |
|
| 157 | - * @param string|null $name Name of the sub-client (Default if null) |
|
| 158 | - * @return \Aimeos\Client\Html\Iface Sub-client object |
|
| 159 | - */ |
|
| 160 | - public function getSubClient( $type, $name = null ) |
|
| 161 | - { |
|
| 162 | - /** client/html/catalog/detail/image/decorators/excludes |
|
| 163 | - * Excludes decorators added by the "common" option from the catalog detail image html client |
|
| 164 | - * |
|
| 165 | - * Decorators extend the functionality of a class by adding new aspects |
|
| 166 | - * (e.g. log what is currently done), executing the methods of the underlying |
|
| 167 | - * class only in certain conditions (e.g. only for logged in users) or |
|
| 168 | - * modify what is returned to the caller. |
|
| 169 | - * |
|
| 170 | - * This option allows you to remove a decorator added via |
|
| 171 | - * "client/html/common/decorators/default" before they are wrapped |
|
| 172 | - * around the html client. |
|
| 173 | - * |
|
| 174 | - * client/html/catalog/detail/image/decorators/excludes = array( 'decorator1' ) |
|
| 175 | - * |
|
| 176 | - * This would remove the decorator named "decorator1" from the list of |
|
| 177 | - * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via |
|
| 178 | - * "client/html/common/decorators/default" to the html client. |
|
| 179 | - * |
|
| 180 | - * @param array List of decorator names |
|
| 181 | - * @since 2015.08 |
|
| 182 | - * @category Developer |
|
| 183 | - * @see client/html/common/decorators/default |
|
| 184 | - * @see client/html/catalog/detail/image/decorators/global |
|
| 185 | - * @see client/html/catalog/detail/image/decorators/local |
|
| 186 | - */ |
|
| 187 | - |
|
| 188 | - /** client/html/catalog/detail/image/decorators/global |
|
| 189 | - * Adds a list of globally available decorators only to the catalog detail image html client |
|
| 190 | - * |
|
| 191 | - * Decorators extend the functionality of a class by adding new aspects |
|
| 192 | - * (e.g. log what is currently done), executing the methods of the underlying |
|
| 193 | - * class only in certain conditions (e.g. only for logged in users) or |
|
| 194 | - * modify what is returned to the caller. |
|
| 195 | - * |
|
| 196 | - * This option allows you to wrap global decorators |
|
| 197 | - * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client. |
|
| 198 | - * |
|
| 199 | - * client/html/catalog/detail/image/decorators/global = array( 'decorator1' ) |
|
| 200 | - * |
|
| 201 | - * This would add the decorator named "decorator1" defined by |
|
| 202 | - * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client. |
|
| 203 | - * |
|
| 204 | - * @param array List of decorator names |
|
| 205 | - * @since 2015.08 |
|
| 206 | - * @category Developer |
|
| 207 | - * @see client/html/common/decorators/default |
|
| 208 | - * @see client/html/catalog/detail/image/decorators/excludes |
|
| 209 | - * @see client/html/catalog/detail/image/decorators/local |
|
| 210 | - */ |
|
| 211 | - |
|
| 212 | - /** client/html/catalog/detail/image/decorators/local |
|
| 213 | - * Adds a list of local decorators only to the catalog detail image html client |
|
| 214 | - * |
|
| 215 | - * Decorators extend the functionality of a class by adding new aspects |
|
| 216 | - * (e.g. log what is currently done), executing the methods of the underlying |
|
| 217 | - * class only in certain conditions (e.g. only for logged in users) or |
|
| 218 | - * modify what is returned to the caller. |
|
| 219 | - * |
|
| 220 | - * This option allows you to wrap local decorators |
|
| 221 | - * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client. |
|
| 222 | - * |
|
| 223 | - * client/html/catalog/detail/image/decorators/local = array( 'decorator2' ) |
|
| 224 | - * |
|
| 225 | - * This would add the decorator named "decorator2" defined by |
|
| 226 | - * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client. |
|
| 227 | - * |
|
| 228 | - * @param array List of decorator names |
|
| 229 | - * @since 2015.08 |
|
| 230 | - * @category Developer |
|
| 231 | - * @see client/html/common/decorators/default |
|
| 232 | - * @see client/html/catalog/detail/image/decorators/excludes |
|
| 233 | - * @see client/html/catalog/detail/image/decorators/global |
|
| 234 | - */ |
|
| 235 | - |
|
| 236 | - return $this->createSubClient( 'catalog/detail/image/' . $type, $name ); |
|
| 237 | - } |
|
| 238 | - |
|
| 239 | - |
|
| 240 | - /** |
|
| 241 | - * Returns the list of sub-client names configured for the client. |
|
| 242 | - * |
|
| 243 | - * @return array List of HTML client names |
|
| 244 | - */ |
|
| 245 | - protected function getSubClientNames() |
|
| 246 | - { |
|
| 247 | - return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames ); |
|
| 248 | - } |
|
| 25 | + /** client/html/catalog/detail/image/standard/subparts |
|
| 26 | + * List of HTML sub-clients rendered within the catalog detail image section |
|
| 27 | + * |
|
| 28 | + * The output of the frontend is composed of the code generated by the HTML |
|
| 29 | + * clients. Each HTML client can consist of serveral (or none) sub-clients |
|
| 30 | + * that are responsible for rendering certain sub-parts of the output. The |
|
| 31 | + * sub-clients can contain HTML clients themselves and therefore a |
|
| 32 | + * hierarchical tree of HTML clients is composed. Each HTML client creates |
|
| 33 | + * the output that is placed inside the container of its parent. |
|
| 34 | + * |
|
| 35 | + * At first, always the HTML code generated by the parent is printed, then |
|
| 36 | + * the HTML code of its sub-clients. The order of the HTML sub-clients |
|
| 37 | + * determines the order of the output of these sub-clients inside the parent |
|
| 38 | + * container. If the configured list of clients is |
|
| 39 | + * |
|
| 40 | + * array( "subclient1", "subclient2" ) |
|
| 41 | + * |
|
| 42 | + * you can easily change the order of the output by reordering the subparts: |
|
| 43 | + * |
|
| 44 | + * client/html/<clients>/subparts = array( "subclient1", "subclient2" ) |
|
| 45 | + * |
|
| 46 | + * You can also remove one or more parts if they shouldn't be rendered: |
|
| 47 | + * |
|
| 48 | + * client/html/<clients>/subparts = array( "subclient1" ) |
|
| 49 | + * |
|
| 50 | + * As the clients only generates structural HTML, the layout defined via CSS |
|
| 51 | + * should support adding, removing or reordering content by a fluid like |
|
| 52 | + * design. |
|
| 53 | + * |
|
| 54 | + * @param array List of sub-client names |
|
| 55 | + * @since 2014.03 |
|
| 56 | + * @category Developer |
|
| 57 | + */ |
|
| 58 | + private $subPartPath = 'client/html/catalog/detail/image/standard/subparts'; |
|
| 59 | + private $subPartNames = array(); |
|
| 60 | + |
|
| 61 | + |
|
| 62 | + /** |
|
| 63 | + * Returns the HTML code for insertion into the body. |
|
| 64 | + * |
|
| 65 | + * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
|
| 66 | + * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 67 | + * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 68 | + * @return string HTML code |
|
| 69 | + */ |
|
| 70 | + public function getBody( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 71 | + { |
|
| 72 | + $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 73 | + |
|
| 74 | + $html = ''; |
|
| 75 | + foreach( $this->getSubClients() as $subclient ) { |
|
| 76 | + $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire ); |
|
| 77 | + } |
|
| 78 | + $view->imageBody = $html; |
|
| 79 | + |
|
| 80 | + /** client/html/catalog/detail/image/standard/template-body |
|
| 81 | + * Relative path to the HTML body template of the catalog detail image client. |
|
| 82 | + * |
|
| 83 | + * The template file contains the HTML code and processing instructions |
|
| 84 | + * to generate the result shown in the body of the frontend. The |
|
| 85 | + * configuration string is the path to the template file relative |
|
| 86 | + * to the templates directory (usually in client/html/templates). |
|
| 87 | + * |
|
| 88 | + * You can overwrite the template file configuration in extensions and |
|
| 89 | + * provide alternative templates. These alternative templates should be |
|
| 90 | + * named like the default one but with the string "standard" replaced by |
|
| 91 | + * an unique name. You may use the name of your project for this. If |
|
| 92 | + * you've implemented an alternative client class as well, "standard" |
|
| 93 | + * should be replaced by the name of the new class. |
|
| 94 | + * |
|
| 95 | + * @param string Relative path to the template creating code for the HTML page body |
|
| 96 | + * @since 2014.03 |
|
| 97 | + * @category Developer |
|
| 98 | + * @see client/html/catalog/detail/image/standard/template-header |
|
| 99 | + */ |
|
| 100 | + $tplconf = 'client/html/catalog/detail/image/standard/template-body'; |
|
| 101 | + $default = 'catalog/detail/image-body-bottom.php'; |
|
| 102 | + |
|
| 103 | + return $view->render( $view->config( $tplconf, $default ) ); |
|
| 104 | + } |
|
| 105 | + |
|
| 106 | + |
|
| 107 | + /** |
|
| 108 | + * Returns the HTML string for insertion into the header. |
|
| 109 | + * |
|
| 110 | + * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
|
| 111 | + * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 112 | + * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 113 | + * @return string|null String including HTML tags for the header on error |
|
| 114 | + */ |
|
| 115 | + public function getHeader( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 116 | + { |
|
| 117 | + $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 118 | + |
|
| 119 | + $html = ''; |
|
| 120 | + foreach( $this->getSubClients() as $subclient ) { |
|
| 121 | + $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire ); |
|
| 122 | + } |
|
| 123 | + $view->imageHeader = $html; |
|
| 124 | + |
|
| 125 | + /** client/html/catalog/detail/image/standard/template-header |
|
| 126 | + * Relative path to the HTML header template of the catalog detail image client. |
|
| 127 | + * |
|
| 128 | + * The template file contains the HTML code and processing instructions |
|
| 129 | + * to generate the HTML code that is inserted into the HTML page header |
|
| 130 | + * of the rendered page in the frontend. The configuration string is the |
|
| 131 | + * path to the template file relative to the templates directory (usually |
|
| 132 | + * in client/html/templates). |
|
| 133 | + * |
|
| 134 | + * You can overwrite the template file configuration in extensions and |
|
| 135 | + * provide alternative templates. These alternative templates should be |
|
| 136 | + * named like the default one but with the string "standard" replaced by |
|
| 137 | + * an unique name. You may use the name of your project for this. If |
|
| 138 | + * you've implemented an alternative client class as well, "standard" |
|
| 139 | + * should be replaced by the name of the new class. |
|
| 140 | + * |
|
| 141 | + * @param string Relative path to the template creating code for the HTML page head |
|
| 142 | + * @since 2014.03 |
|
| 143 | + * @category Developer |
|
| 144 | + * @see client/html/catalog/detail/image/standard/template-body |
|
| 145 | + */ |
|
| 146 | + $tplconf = 'client/html/catalog/detail/image/standard/template-header'; |
|
| 147 | + $default = 'catalog/detail/image-header-default.php'; |
|
| 148 | + |
|
| 149 | + return $view->render( $view->config( $tplconf, $default ) ); |
|
| 150 | + } |
|
| 151 | + |
|
| 152 | + |
|
| 153 | + /** |
|
| 154 | + * Returns the sub-client given by its name. |
|
| 155 | + * |
|
| 156 | + * @param string $type Name of the client type |
|
| 157 | + * @param string|null $name Name of the sub-client (Default if null) |
|
| 158 | + * @return \Aimeos\Client\Html\Iface Sub-client object |
|
| 159 | + */ |
|
| 160 | + public function getSubClient( $type, $name = null ) |
|
| 161 | + { |
|
| 162 | + /** client/html/catalog/detail/image/decorators/excludes |
|
| 163 | + * Excludes decorators added by the "common" option from the catalog detail image html client |
|
| 164 | + * |
|
| 165 | + * Decorators extend the functionality of a class by adding new aspects |
|
| 166 | + * (e.g. log what is currently done), executing the methods of the underlying |
|
| 167 | + * class only in certain conditions (e.g. only for logged in users) or |
|
| 168 | + * modify what is returned to the caller. |
|
| 169 | + * |
|
| 170 | + * This option allows you to remove a decorator added via |
|
| 171 | + * "client/html/common/decorators/default" before they are wrapped |
|
| 172 | + * around the html client. |
|
| 173 | + * |
|
| 174 | + * client/html/catalog/detail/image/decorators/excludes = array( 'decorator1' ) |
|
| 175 | + * |
|
| 176 | + * This would remove the decorator named "decorator1" from the list of |
|
| 177 | + * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via |
|
| 178 | + * "client/html/common/decorators/default" to the html client. |
|
| 179 | + * |
|
| 180 | + * @param array List of decorator names |
|
| 181 | + * @since 2015.08 |
|
| 182 | + * @category Developer |
|
| 183 | + * @see client/html/common/decorators/default |
|
| 184 | + * @see client/html/catalog/detail/image/decorators/global |
|
| 185 | + * @see client/html/catalog/detail/image/decorators/local |
|
| 186 | + */ |
|
| 187 | + |
|
| 188 | + /** client/html/catalog/detail/image/decorators/global |
|
| 189 | + * Adds a list of globally available decorators only to the catalog detail image html client |
|
| 190 | + * |
|
| 191 | + * Decorators extend the functionality of a class by adding new aspects |
|
| 192 | + * (e.g. log what is currently done), executing the methods of the underlying |
|
| 193 | + * class only in certain conditions (e.g. only for logged in users) or |
|
| 194 | + * modify what is returned to the caller. |
|
| 195 | + * |
|
| 196 | + * This option allows you to wrap global decorators |
|
| 197 | + * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client. |
|
| 198 | + * |
|
| 199 | + * client/html/catalog/detail/image/decorators/global = array( 'decorator1' ) |
|
| 200 | + * |
|
| 201 | + * This would add the decorator named "decorator1" defined by |
|
| 202 | + * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client. |
|
| 203 | + * |
|
| 204 | + * @param array List of decorator names |
|
| 205 | + * @since 2015.08 |
|
| 206 | + * @category Developer |
|
| 207 | + * @see client/html/common/decorators/default |
|
| 208 | + * @see client/html/catalog/detail/image/decorators/excludes |
|
| 209 | + * @see client/html/catalog/detail/image/decorators/local |
|
| 210 | + */ |
|
| 211 | + |
|
| 212 | + /** client/html/catalog/detail/image/decorators/local |
|
| 213 | + * Adds a list of local decorators only to the catalog detail image html client |
|
| 214 | + * |
|
| 215 | + * Decorators extend the functionality of a class by adding new aspects |
|
| 216 | + * (e.g. log what is currently done), executing the methods of the underlying |
|
| 217 | + * class only in certain conditions (e.g. only for logged in users) or |
|
| 218 | + * modify what is returned to the caller. |
|
| 219 | + * |
|
| 220 | + * This option allows you to wrap local decorators |
|
| 221 | + * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client. |
|
| 222 | + * |
|
| 223 | + * client/html/catalog/detail/image/decorators/local = array( 'decorator2' ) |
|
| 224 | + * |
|
| 225 | + * This would add the decorator named "decorator2" defined by |
|
| 226 | + * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client. |
|
| 227 | + * |
|
| 228 | + * @param array List of decorator names |
|
| 229 | + * @since 2015.08 |
|
| 230 | + * @category Developer |
|
| 231 | + * @see client/html/common/decorators/default |
|
| 232 | + * @see client/html/catalog/detail/image/decorators/excludes |
|
| 233 | + * @see client/html/catalog/detail/image/decorators/global |
|
| 234 | + */ |
|
| 235 | + |
|
| 236 | + return $this->createSubClient( 'catalog/detail/image/' . $type, $name ); |
|
| 237 | + } |
|
| 238 | + |
|
| 239 | + |
|
| 240 | + /** |
|
| 241 | + * Returns the list of sub-client names configured for the client. |
|
| 242 | + * |
|
| 243 | + * @return array List of HTML client names |
|
| 244 | + */ |
|
| 245 | + protected function getSubClientNames() |
|
| 246 | + { |
|
| 247 | + return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames ); |
|
| 248 | + } |
|
| 249 | 249 | } |
| 250 | 250 | \ No newline at end of file |
@@ -67,13 +67,13 @@ discard block |
||
| 67 | 67 | * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
| 68 | 68 | * @return string HTML code |
| 69 | 69 | */ |
| 70 | - public function getBody( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 70 | + public function getBody($uid = '', array &$tags = array(), &$expire = null) |
|
| 71 | 71 | { |
| 72 | - $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 72 | + $view = $this->setViewParams($this->getView(), $tags, $expire); |
|
| 73 | 73 | |
| 74 | 74 | $html = ''; |
| 75 | - foreach( $this->getSubClients() as $subclient ) { |
|
| 76 | - $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire ); |
|
| 75 | + foreach ($this->getSubClients() as $subclient) { |
|
| 76 | + $html .= $subclient->setView($view)->getBody($uid, $tags, $expire); |
|
| 77 | 77 | } |
| 78 | 78 | $view->imageBody = $html; |
| 79 | 79 | |
@@ -100,7 +100,7 @@ discard block |
||
| 100 | 100 | $tplconf = 'client/html/catalog/detail/image/standard/template-body'; |
| 101 | 101 | $default = 'catalog/detail/image-body-bottom.php'; |
| 102 | 102 | |
| 103 | - return $view->render( $view->config( $tplconf, $default ) ); |
|
| 103 | + return $view->render($view->config($tplconf, $default)); |
|
| 104 | 104 | } |
| 105 | 105 | |
| 106 | 106 | |
@@ -112,13 +112,13 @@ discard block |
||
| 112 | 112 | * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
| 113 | 113 | * @return string|null String including HTML tags for the header on error |
| 114 | 114 | */ |
| 115 | - public function getHeader( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 115 | + public function getHeader($uid = '', array &$tags = array(), &$expire = null) |
|
| 116 | 116 | { |
| 117 | - $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 117 | + $view = $this->setViewParams($this->getView(), $tags, $expire); |
|
| 118 | 118 | |
| 119 | 119 | $html = ''; |
| 120 | - foreach( $this->getSubClients() as $subclient ) { |
|
| 121 | - $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire ); |
|
| 120 | + foreach ($this->getSubClients() as $subclient) { |
|
| 121 | + $html .= $subclient->setView($view)->getHeader($uid, $tags, $expire); |
|
| 122 | 122 | } |
| 123 | 123 | $view->imageHeader = $html; |
| 124 | 124 | |
@@ -146,7 +146,7 @@ discard block |
||
| 146 | 146 | $tplconf = 'client/html/catalog/detail/image/standard/template-header'; |
| 147 | 147 | $default = 'catalog/detail/image-header-default.php'; |
| 148 | 148 | |
| 149 | - return $view->render( $view->config( $tplconf, $default ) ); |
|
| 149 | + return $view->render($view->config($tplconf, $default)); |
|
| 150 | 150 | } |
| 151 | 151 | |
| 152 | 152 | |
@@ -157,7 +157,7 @@ discard block |
||
| 157 | 157 | * @param string|null $name Name of the sub-client (Default if null) |
| 158 | 158 | * @return \Aimeos\Client\Html\Iface Sub-client object |
| 159 | 159 | */ |
| 160 | - public function getSubClient( $type, $name = null ) |
|
| 160 | + public function getSubClient($type, $name = null) |
|
| 161 | 161 | { |
| 162 | 162 | /** client/html/catalog/detail/image/decorators/excludes |
| 163 | 163 | * Excludes decorators added by the "common" option from the catalog detail image html client |
@@ -233,7 +233,7 @@ discard block |
||
| 233 | 233 | * @see client/html/catalog/detail/image/decorators/global |
| 234 | 234 | */ |
| 235 | 235 | |
| 236 | - return $this->createSubClient( 'catalog/detail/image/' . $type, $name ); |
|
| 236 | + return $this->createSubClient('catalog/detail/image/'.$type, $name); |
|
| 237 | 237 | } |
| 238 | 238 | |
| 239 | 239 | |
@@ -244,6 +244,6 @@ discard block |
||
| 244 | 244 | */ |
| 245 | 245 | protected function getSubClientNames() |
| 246 | 246 | { |
| 247 | - return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames ); |
|
| 247 | + return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames); |
|
| 248 | 248 | } |
| 249 | 249 | } |
| 250 | 250 | \ No newline at end of file |
@@ -110,7 +110,7 @@ |
||
| 110 | 110 | * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
| 111 | 111 | * @param array &$tags Result array for the list of tags that are associated to the output |
| 112 | 112 | * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
| 113 | - * @return string|null String including HTML tags for the header on error |
|
| 113 | + * @return string String including HTML tags for the header on error |
|
| 114 | 114 | */ |
| 115 | 115 | public function getHeader( $uid = '', array &$tags = array(), &$expire = null ) |
| 116 | 116 | { |
@@ -19,302 +19,302 @@ |
||
| 19 | 19 | * @subpackage Html |
| 20 | 20 | */ |
| 21 | 21 | class Standard |
| 22 | - extends \Aimeos\Client\Html\Common\Client\Factory\Base |
|
| 23 | - implements \Aimeos\Client\Html\Common\Client\Factory\Iface |
|
| 22 | + extends \Aimeos\Client\Html\Common\Client\Factory\Base |
|
| 23 | + implements \Aimeos\Client\Html\Common\Client\Factory\Iface |
|
| 24 | 24 | { |
| 25 | - /** client/html/catalog/detail/suggest/standard/subparts |
|
| 26 | - * List of HTML sub-clients rendered within the catalog detail suggest section |
|
| 27 | - * |
|
| 28 | - * The output of the frontend is composed of the code generated by the HTML |
|
| 29 | - * clients. Each HTML client can consist of serveral (or none) sub-clients |
|
| 30 | - * that are responsible for rendering certain sub-parts of the output. The |
|
| 31 | - * sub-clients can contain HTML clients themselves and therefore a |
|
| 32 | - * hierarchical tree of HTML clients is composed. Each HTML client creates |
|
| 33 | - * the output that is placed inside the container of its parent. |
|
| 34 | - * |
|
| 35 | - * At first, always the HTML code generated by the parent is printed, then |
|
| 36 | - * the HTML code of its sub-clients. The order of the HTML sub-clients |
|
| 37 | - * determines the order of the output of these sub-clients inside the parent |
|
| 38 | - * container. If the configured list of clients is |
|
| 39 | - * |
|
| 40 | - * array( "subclient1", "subclient2" ) |
|
| 41 | - * |
|
| 42 | - * you can easily change the order of the output by reordering the subparts: |
|
| 43 | - * |
|
| 44 | - * client/html/<clients>/subparts = array( "subclient1", "subclient2" ) |
|
| 45 | - * |
|
| 46 | - * You can also remove one or more parts if they shouldn't be rendered: |
|
| 47 | - * |
|
| 48 | - * client/html/<clients>/subparts = array( "subclient1" ) |
|
| 49 | - * |
|
| 50 | - * As the clients only generates structural HTML, the layout defined via CSS |
|
| 51 | - * should support adding, removing or reordering content by a fluid like |
|
| 52 | - * design. |
|
| 53 | - * |
|
| 54 | - * @param array List of sub-client names |
|
| 55 | - * @since 2014.03 |
|
| 56 | - * @category Developer |
|
| 57 | - */ |
|
| 58 | - private $subPartPath = 'client/html/catalog/detail/suggest/standard/subparts'; |
|
| 59 | - private $subPartNames = array(); |
|
| 60 | - private $tags = array(); |
|
| 61 | - private $expire; |
|
| 62 | - private $cache; |
|
| 63 | - |
|
| 64 | - |
|
| 65 | - /** |
|
| 66 | - * Returns the HTML code for insertion into the body. |
|
| 67 | - * |
|
| 68 | - * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
|
| 69 | - * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 70 | - * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 71 | - * @return string HTML code |
|
| 72 | - */ |
|
| 73 | - public function getBody( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 74 | - { |
|
| 75 | - $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 76 | - |
|
| 77 | - $html = ''; |
|
| 78 | - foreach( $this->getSubClients() as $subclient ) { |
|
| 79 | - $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire ); |
|
| 80 | - } |
|
| 81 | - $view->suggestBody = $html; |
|
| 82 | - |
|
| 83 | - /** client/html/catalog/detail/suggest/standard/template-body |
|
| 84 | - * Relative path to the HTML body template of the catalog detail suggest client. |
|
| 85 | - * |
|
| 86 | - * The template file contains the HTML code and processing instructions |
|
| 87 | - * to generate the result shown in the body of the frontend. The |
|
| 88 | - * configuration string is the path to the template file relative |
|
| 89 | - * to the templates directory (usually in client/html/templates). |
|
| 90 | - * |
|
| 91 | - * You can overwrite the template file configuration in extensions and |
|
| 92 | - * provide alternative templates. These alternative templates should be |
|
| 93 | - * named like the default one but with the string "standard" replaced by |
|
| 94 | - * an unique name. You may use the name of your project for this. If |
|
| 95 | - * you've implemented an alternative client class as well, "standard" |
|
| 96 | - * should be replaced by the name of the new class. |
|
| 97 | - * |
|
| 98 | - * @param string Relative path to the template creating code for the HTML page body |
|
| 99 | - * @since 2014.03 |
|
| 100 | - * @category Developer |
|
| 101 | - * @see client/html/catalog/detail/suggest/standard/template-header |
|
| 102 | - */ |
|
| 103 | - $tplconf = 'client/html/catalog/detail/suggest/standard/template-body'; |
|
| 104 | - $default = 'catalog/detail/suggest-body-default.php'; |
|
| 105 | - |
|
| 106 | - return $view->render( $view->config( $tplconf, $default ) ); |
|
| 107 | - } |
|
| 108 | - |
|
| 109 | - |
|
| 110 | - /** |
|
| 111 | - * Returns the HTML string for insertion into the header. |
|
| 112 | - * |
|
| 113 | - * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
|
| 114 | - * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 115 | - * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 116 | - * @return string|null String including HTML tags for the header on error |
|
| 117 | - */ |
|
| 118 | - public function getHeader( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 119 | - { |
|
| 120 | - $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 121 | - |
|
| 122 | - $html = ''; |
|
| 123 | - foreach( $this->getSubClients() as $subclient ) { |
|
| 124 | - $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire ); |
|
| 125 | - } |
|
| 126 | - $view->suggestHeader = $html; |
|
| 127 | - |
|
| 128 | - /** client/html/catalog/detail/suggest/standard/template-header |
|
| 129 | - * Relative path to the HTML header template of the catalog detail suggest client. |
|
| 130 | - * |
|
| 131 | - * The template file contains the HTML code and processing instructions |
|
| 132 | - * to generate the HTML code that is inserted into the HTML page header |
|
| 133 | - * of the rendered page in the frontend. The configuration string is the |
|
| 134 | - * path to the template file relative to the templates directory (usually |
|
| 135 | - * in client/html/templates). |
|
| 136 | - * |
|
| 137 | - * You can overwrite the template file configuration in extensions and |
|
| 138 | - * provide alternative templates. These alternative templates should be |
|
| 139 | - * named like the default one but with the string "standard" replaced by |
|
| 140 | - * an unique name. You may use the name of your project for this. If |
|
| 141 | - * you've implemented an alternative client class as well, "standard" |
|
| 142 | - * should be replaced by the name of the new class. |
|
| 143 | - * |
|
| 144 | - * @param string Relative path to the template creating code for the HTML page head |
|
| 145 | - * @since 2014.03 |
|
| 146 | - * @category Developer |
|
| 147 | - * @see client/html/catalog/detail/suggest/standard/template-body |
|
| 148 | - */ |
|
| 149 | - $tplconf = 'client/html/catalog/detail/suggest/standard/template-header'; |
|
| 150 | - $default = 'catalog/detail/suggest-header-default.php'; |
|
| 151 | - |
|
| 152 | - return $view->render( $view->config( $tplconf, $default ) ); |
|
| 153 | - } |
|
| 154 | - |
|
| 155 | - |
|
| 156 | - /** |
|
| 157 | - * Returns the sub-client given by its name. |
|
| 158 | - * |
|
| 159 | - * @param string $type Name of the client type |
|
| 160 | - * @param string|null $name Name of the sub-client (Default if null) |
|
| 161 | - * @return \Aimeos\Client\Html\Iface Sub-client object |
|
| 162 | - */ |
|
| 163 | - public function getSubClient( $type, $name = null ) |
|
| 164 | - { |
|
| 165 | - /** client/html/catalog/detail/suggest/decorators/excludes |
|
| 166 | - * Excludes decorators added by the "common" option from the catalog detail suggest html client |
|
| 167 | - * |
|
| 168 | - * Decorators extend the functionality of a class by adding new aspects |
|
| 169 | - * (e.g. log what is currently done), executing the methods of the underlying |
|
| 170 | - * class only in certain conditions (e.g. only for logged in users) or |
|
| 171 | - * modify what is returned to the caller. |
|
| 172 | - * |
|
| 173 | - * This option allows you to remove a decorator added via |
|
| 174 | - * "client/html/common/decorators/default" before they are wrapped |
|
| 175 | - * around the html client. |
|
| 176 | - * |
|
| 177 | - * client/html/catalog/detail/suggest/decorators/excludes = array( 'decorator1' ) |
|
| 178 | - * |
|
| 179 | - * This would remove the decorator named "decorator1" from the list of |
|
| 180 | - * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via |
|
| 181 | - * "client/html/common/decorators/default" to the html client. |
|
| 182 | - * |
|
| 183 | - * @param array List of decorator names |
|
| 184 | - * @since 2015.08 |
|
| 185 | - * @category Developer |
|
| 186 | - * @see client/html/common/decorators/default |
|
| 187 | - * @see client/html/catalog/detail/suggest/decorators/global |
|
| 188 | - * @see client/html/catalog/detail/suggest/decorators/local |
|
| 189 | - */ |
|
| 190 | - |
|
| 191 | - /** client/html/catalog/detail/suggest/decorators/global |
|
| 192 | - * Adds a list of globally available decorators only to the catalog detail suggest html client |
|
| 193 | - * |
|
| 194 | - * Decorators extend the functionality of a class by adding new aspects |
|
| 195 | - * (e.g. log what is currently done), executing the methods of the underlying |
|
| 196 | - * class only in certain conditions (e.g. only for logged in users) or |
|
| 197 | - * modify what is returned to the caller. |
|
| 198 | - * |
|
| 199 | - * This option allows you to wrap global decorators |
|
| 200 | - * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client. |
|
| 201 | - * |
|
| 202 | - * client/html/catalog/detail/suggest/decorators/global = array( 'decorator1' ) |
|
| 203 | - * |
|
| 204 | - * This would add the decorator named "decorator1" defined by |
|
| 205 | - * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client. |
|
| 206 | - * |
|
| 207 | - * @param array List of decorator names |
|
| 208 | - * @since 2015.08 |
|
| 209 | - * @category Developer |
|
| 210 | - * @see client/html/common/decorators/default |
|
| 211 | - * @see client/html/catalog/detail/suggest/decorators/excludes |
|
| 212 | - * @see client/html/catalog/detail/suggest/decorators/local |
|
| 213 | - */ |
|
| 214 | - |
|
| 215 | - /** client/html/catalog/detail/suggest/decorators/local |
|
| 216 | - * Adds a list of local decorators only to the catalog detail suggest html client |
|
| 217 | - * |
|
| 218 | - * Decorators extend the functionality of a class by adding new aspects |
|
| 219 | - * (e.g. log what is currently done), executing the methods of the underlying |
|
| 220 | - * class only in certain conditions (e.g. only for logged in users) or |
|
| 221 | - * modify what is returned to the caller. |
|
| 222 | - * |
|
| 223 | - * This option allows you to wrap local decorators |
|
| 224 | - * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client. |
|
| 225 | - * |
|
| 226 | - * client/html/catalog/detail/suggest/decorators/local = array( 'decorator2' ) |
|
| 227 | - * |
|
| 228 | - * This would add the decorator named "decorator2" defined by |
|
| 229 | - * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client. |
|
| 230 | - * |
|
| 231 | - * @param array List of decorator names |
|
| 232 | - * @since 2015.08 |
|
| 233 | - * @category Developer |
|
| 234 | - * @see client/html/common/decorators/default |
|
| 235 | - * @see client/html/catalog/detail/suggest/decorators/excludes |
|
| 236 | - * @see client/html/catalog/detail/suggest/decorators/global |
|
| 237 | - */ |
|
| 238 | - |
|
| 239 | - return $this->createSubClient( 'catalog/detail/suggest/' . $type, $name ); |
|
| 240 | - } |
|
| 241 | - |
|
| 242 | - |
|
| 243 | - /** |
|
| 244 | - * Returns the list of sub-client names configured for the client. |
|
| 245 | - * |
|
| 246 | - * @return array List of HTML client names |
|
| 247 | - */ |
|
| 248 | - protected function getSubClientNames() |
|
| 249 | - { |
|
| 250 | - return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames ); |
|
| 251 | - } |
|
| 252 | - |
|
| 253 | - |
|
| 254 | - /** |
|
| 255 | - * Sets the necessary parameter values in the view. |
|
| 256 | - * |
|
| 257 | - * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output |
|
| 258 | - * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 259 | - * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 260 | - * @return \Aimeos\MW\View\Iface Modified view object |
|
| 261 | - */ |
|
| 262 | - protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null ) |
|
| 263 | - { |
|
| 264 | - if( !isset( $this->cache ) ) |
|
| 265 | - { |
|
| 266 | - if( isset( $view->detailProductItem ) ) |
|
| 267 | - { |
|
| 268 | - $context = $this->getContext(); |
|
| 269 | - $config = $context->getConfig(); |
|
| 270 | - $domains = array( 'text', 'price', 'media' ); |
|
| 271 | - $products = $view->detailProductItem->getRefItems( 'product', null, 'suggestion' ); |
|
| 272 | - |
|
| 273 | - $controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' ); |
|
| 274 | - |
|
| 275 | - /** client/html/catalog/detail/domains |
|
| 276 | - * A list of domain names whose items should be available in the catalog view templates |
|
| 277 | - * |
|
| 278 | - * @see client/html/catalog/detail/domains |
|
| 279 | - */ |
|
| 280 | - $domains = $config->get( 'client/html/catalog/detail/domains', $domains ); |
|
| 281 | - |
|
| 282 | - /** client/html/catalog/detail/suggest/domains |
|
| 283 | - * A list of domain names whose items should be available in the suggestion part of the catalog detail view templates |
|
| 284 | - * |
|
| 285 | - * The templates rendering suggestion related data usually add |
|
| 286 | - * the images and texts associated to each item. If you want to |
|
| 287 | - * display additional content like the attributes, you can configure |
|
| 288 | - * your own list of domains (attribute, media, price, product, text, |
|
| 289 | - * etc. are domains) whose items are fetched from the storage. |
|
| 290 | - * Please keep in mind that the more domains you add to the |
|
| 291 | - * configuration, the more time is required for fetching the content! |
|
| 292 | - * |
|
| 293 | - * This configuration option can be overwritten by the |
|
| 294 | - * "client/html/catalog/detail/domains" configuration option that |
|
| 295 | - * allows to configure the domain names of the items fetched |
|
| 296 | - * specifically for all types of product listings. |
|
| 297 | - * |
|
| 298 | - * @param array List of domain names |
|
| 299 | - * @since 2015.09 |
|
| 300 | - * @category Developer |
|
| 301 | - * @see client/html/catalog/detail/domains |
|
| 302 | - */ |
|
| 303 | - $domains = $config->get( 'client/html/catalog/detail/suggest/domains', $domains ); |
|
| 304 | - |
|
| 305 | - $view->suggestItems = $controller->getProductItems( array_keys( $products ), $domains ); |
|
| 306 | - $view->suggestPosItems = $products; |
|
| 307 | - |
|
| 308 | - $this->addMetaItem( $view->suggestItems, 'product', $this->expire, $this->tags ); |
|
| 309 | - $this->addMetaList( array_keys( $view->suggestItems ), 'product', $this->expire ); |
|
| 310 | - } |
|
| 311 | - |
|
| 312 | - $this->cache = $view; |
|
| 313 | - } |
|
| 314 | - |
|
| 315 | - $expire = $this->expires( $this->expire, $expire ); |
|
| 316 | - $tags = array_merge( $tags, $this->tags ); |
|
| 317 | - |
|
| 318 | - return $this->cache; |
|
| 319 | - } |
|
| 25 | + /** client/html/catalog/detail/suggest/standard/subparts |
|
| 26 | + * List of HTML sub-clients rendered within the catalog detail suggest section |
|
| 27 | + * |
|
| 28 | + * The output of the frontend is composed of the code generated by the HTML |
|
| 29 | + * clients. Each HTML client can consist of serveral (or none) sub-clients |
|
| 30 | + * that are responsible for rendering certain sub-parts of the output. The |
|
| 31 | + * sub-clients can contain HTML clients themselves and therefore a |
|
| 32 | + * hierarchical tree of HTML clients is composed. Each HTML client creates |
|
| 33 | + * the output that is placed inside the container of its parent. |
|
| 34 | + * |
|
| 35 | + * At first, always the HTML code generated by the parent is printed, then |
|
| 36 | + * the HTML code of its sub-clients. The order of the HTML sub-clients |
|
| 37 | + * determines the order of the output of these sub-clients inside the parent |
|
| 38 | + * container. If the configured list of clients is |
|
| 39 | + * |
|
| 40 | + * array( "subclient1", "subclient2" ) |
|
| 41 | + * |
|
| 42 | + * you can easily change the order of the output by reordering the subparts: |
|
| 43 | + * |
|
| 44 | + * client/html/<clients>/subparts = array( "subclient1", "subclient2" ) |
|
| 45 | + * |
|
| 46 | + * You can also remove one or more parts if they shouldn't be rendered: |
|
| 47 | + * |
|
| 48 | + * client/html/<clients>/subparts = array( "subclient1" ) |
|
| 49 | + * |
|
| 50 | + * As the clients only generates structural HTML, the layout defined via CSS |
|
| 51 | + * should support adding, removing or reordering content by a fluid like |
|
| 52 | + * design. |
|
| 53 | + * |
|
| 54 | + * @param array List of sub-client names |
|
| 55 | + * @since 2014.03 |
|
| 56 | + * @category Developer |
|
| 57 | + */ |
|
| 58 | + private $subPartPath = 'client/html/catalog/detail/suggest/standard/subparts'; |
|
| 59 | + private $subPartNames = array(); |
|
| 60 | + private $tags = array(); |
|
| 61 | + private $expire; |
|
| 62 | + private $cache; |
|
| 63 | + |
|
| 64 | + |
|
| 65 | + /** |
|
| 66 | + * Returns the HTML code for insertion into the body. |
|
| 67 | + * |
|
| 68 | + * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
|
| 69 | + * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 70 | + * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 71 | + * @return string HTML code |
|
| 72 | + */ |
|
| 73 | + public function getBody( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 74 | + { |
|
| 75 | + $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 76 | + |
|
| 77 | + $html = ''; |
|
| 78 | + foreach( $this->getSubClients() as $subclient ) { |
|
| 79 | + $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire ); |
|
| 80 | + } |
|
| 81 | + $view->suggestBody = $html; |
|
| 82 | + |
|
| 83 | + /** client/html/catalog/detail/suggest/standard/template-body |
|
| 84 | + * Relative path to the HTML body template of the catalog detail suggest client. |
|
| 85 | + * |
|
| 86 | + * The template file contains the HTML code and processing instructions |
|
| 87 | + * to generate the result shown in the body of the frontend. The |
|
| 88 | + * configuration string is the path to the template file relative |
|
| 89 | + * to the templates directory (usually in client/html/templates). |
|
| 90 | + * |
|
| 91 | + * You can overwrite the template file configuration in extensions and |
|
| 92 | + * provide alternative templates. These alternative templates should be |
|
| 93 | + * named like the default one but with the string "standard" replaced by |
|
| 94 | + * an unique name. You may use the name of your project for this. If |
|
| 95 | + * you've implemented an alternative client class as well, "standard" |
|
| 96 | + * should be replaced by the name of the new class. |
|
| 97 | + * |
|
| 98 | + * @param string Relative path to the template creating code for the HTML page body |
|
| 99 | + * @since 2014.03 |
|
| 100 | + * @category Developer |
|
| 101 | + * @see client/html/catalog/detail/suggest/standard/template-header |
|
| 102 | + */ |
|
| 103 | + $tplconf = 'client/html/catalog/detail/suggest/standard/template-body'; |
|
| 104 | + $default = 'catalog/detail/suggest-body-default.php'; |
|
| 105 | + |
|
| 106 | + return $view->render( $view->config( $tplconf, $default ) ); |
|
| 107 | + } |
|
| 108 | + |
|
| 109 | + |
|
| 110 | + /** |
|
| 111 | + * Returns the HTML string for insertion into the header. |
|
| 112 | + * |
|
| 113 | + * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
|
| 114 | + * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 115 | + * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 116 | + * @return string|null String including HTML tags for the header on error |
|
| 117 | + */ |
|
| 118 | + public function getHeader( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 119 | + { |
|
| 120 | + $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 121 | + |
|
| 122 | + $html = ''; |
|
| 123 | + foreach( $this->getSubClients() as $subclient ) { |
|
| 124 | + $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire ); |
|
| 125 | + } |
|
| 126 | + $view->suggestHeader = $html; |
|
| 127 | + |
|
| 128 | + /** client/html/catalog/detail/suggest/standard/template-header |
|
| 129 | + * Relative path to the HTML header template of the catalog detail suggest client. |
|
| 130 | + * |
|
| 131 | + * The template file contains the HTML code and processing instructions |
|
| 132 | + * to generate the HTML code that is inserted into the HTML page header |
|
| 133 | + * of the rendered page in the frontend. The configuration string is the |
|
| 134 | + * path to the template file relative to the templates directory (usually |
|
| 135 | + * in client/html/templates). |
|
| 136 | + * |
|
| 137 | + * You can overwrite the template file configuration in extensions and |
|
| 138 | + * provide alternative templates. These alternative templates should be |
|
| 139 | + * named like the default one but with the string "standard" replaced by |
|
| 140 | + * an unique name. You may use the name of your project for this. If |
|
| 141 | + * you've implemented an alternative client class as well, "standard" |
|
| 142 | + * should be replaced by the name of the new class. |
|
| 143 | + * |
|
| 144 | + * @param string Relative path to the template creating code for the HTML page head |
|
| 145 | + * @since 2014.03 |
|
| 146 | + * @category Developer |
|
| 147 | + * @see client/html/catalog/detail/suggest/standard/template-body |
|
| 148 | + */ |
|
| 149 | + $tplconf = 'client/html/catalog/detail/suggest/standard/template-header'; |
|
| 150 | + $default = 'catalog/detail/suggest-header-default.php'; |
|
| 151 | + |
|
| 152 | + return $view->render( $view->config( $tplconf, $default ) ); |
|
| 153 | + } |
|
| 154 | + |
|
| 155 | + |
|
| 156 | + /** |
|
| 157 | + * Returns the sub-client given by its name. |
|
| 158 | + * |
|
| 159 | + * @param string $type Name of the client type |
|
| 160 | + * @param string|null $name Name of the sub-client (Default if null) |
|
| 161 | + * @return \Aimeos\Client\Html\Iface Sub-client object |
|
| 162 | + */ |
|
| 163 | + public function getSubClient( $type, $name = null ) |
|
| 164 | + { |
|
| 165 | + /** client/html/catalog/detail/suggest/decorators/excludes |
|
| 166 | + * Excludes decorators added by the "common" option from the catalog detail suggest html client |
|
| 167 | + * |
|
| 168 | + * Decorators extend the functionality of a class by adding new aspects |
|
| 169 | + * (e.g. log what is currently done), executing the methods of the underlying |
|
| 170 | + * class only in certain conditions (e.g. only for logged in users) or |
|
| 171 | + * modify what is returned to the caller. |
|
| 172 | + * |
|
| 173 | + * This option allows you to remove a decorator added via |
|
| 174 | + * "client/html/common/decorators/default" before they are wrapped |
|
| 175 | + * around the html client. |
|
| 176 | + * |
|
| 177 | + * client/html/catalog/detail/suggest/decorators/excludes = array( 'decorator1' ) |
|
| 178 | + * |
|
| 179 | + * This would remove the decorator named "decorator1" from the list of |
|
| 180 | + * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via |
|
| 181 | + * "client/html/common/decorators/default" to the html client. |
|
| 182 | + * |
|
| 183 | + * @param array List of decorator names |
|
| 184 | + * @since 2015.08 |
|
| 185 | + * @category Developer |
|
| 186 | + * @see client/html/common/decorators/default |
|
| 187 | + * @see client/html/catalog/detail/suggest/decorators/global |
|
| 188 | + * @see client/html/catalog/detail/suggest/decorators/local |
|
| 189 | + */ |
|
| 190 | + |
|
| 191 | + /** client/html/catalog/detail/suggest/decorators/global |
|
| 192 | + * Adds a list of globally available decorators only to the catalog detail suggest html client |
|
| 193 | + * |
|
| 194 | + * Decorators extend the functionality of a class by adding new aspects |
|
| 195 | + * (e.g. log what is currently done), executing the methods of the underlying |
|
| 196 | + * class only in certain conditions (e.g. only for logged in users) or |
|
| 197 | + * modify what is returned to the caller. |
|
| 198 | + * |
|
| 199 | + * This option allows you to wrap global decorators |
|
| 200 | + * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client. |
|
| 201 | + * |
|
| 202 | + * client/html/catalog/detail/suggest/decorators/global = array( 'decorator1' ) |
|
| 203 | + * |
|
| 204 | + * This would add the decorator named "decorator1" defined by |
|
| 205 | + * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client. |
|
| 206 | + * |
|
| 207 | + * @param array List of decorator names |
|
| 208 | + * @since 2015.08 |
|
| 209 | + * @category Developer |
|
| 210 | + * @see client/html/common/decorators/default |
|
| 211 | + * @see client/html/catalog/detail/suggest/decorators/excludes |
|
| 212 | + * @see client/html/catalog/detail/suggest/decorators/local |
|
| 213 | + */ |
|
| 214 | + |
|
| 215 | + /** client/html/catalog/detail/suggest/decorators/local |
|
| 216 | + * Adds a list of local decorators only to the catalog detail suggest html client |
|
| 217 | + * |
|
| 218 | + * Decorators extend the functionality of a class by adding new aspects |
|
| 219 | + * (e.g. log what is currently done), executing the methods of the underlying |
|
| 220 | + * class only in certain conditions (e.g. only for logged in users) or |
|
| 221 | + * modify what is returned to the caller. |
|
| 222 | + * |
|
| 223 | + * This option allows you to wrap local decorators |
|
| 224 | + * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client. |
|
| 225 | + * |
|
| 226 | + * client/html/catalog/detail/suggest/decorators/local = array( 'decorator2' ) |
|
| 227 | + * |
|
| 228 | + * This would add the decorator named "decorator2" defined by |
|
| 229 | + * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client. |
|
| 230 | + * |
|
| 231 | + * @param array List of decorator names |
|
| 232 | + * @since 2015.08 |
|
| 233 | + * @category Developer |
|
| 234 | + * @see client/html/common/decorators/default |
|
| 235 | + * @see client/html/catalog/detail/suggest/decorators/excludes |
|
| 236 | + * @see client/html/catalog/detail/suggest/decorators/global |
|
| 237 | + */ |
|
| 238 | + |
|
| 239 | + return $this->createSubClient( 'catalog/detail/suggest/' . $type, $name ); |
|
| 240 | + } |
|
| 241 | + |
|
| 242 | + |
|
| 243 | + /** |
|
| 244 | + * Returns the list of sub-client names configured for the client. |
|
| 245 | + * |
|
| 246 | + * @return array List of HTML client names |
|
| 247 | + */ |
|
| 248 | + protected function getSubClientNames() |
|
| 249 | + { |
|
| 250 | + return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames ); |
|
| 251 | + } |
|
| 252 | + |
|
| 253 | + |
|
| 254 | + /** |
|
| 255 | + * Sets the necessary parameter values in the view. |
|
| 256 | + * |
|
| 257 | + * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output |
|
| 258 | + * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 259 | + * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 260 | + * @return \Aimeos\MW\View\Iface Modified view object |
|
| 261 | + */ |
|
| 262 | + protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null ) |
|
| 263 | + { |
|
| 264 | + if( !isset( $this->cache ) ) |
|
| 265 | + { |
|
| 266 | + if( isset( $view->detailProductItem ) ) |
|
| 267 | + { |
|
| 268 | + $context = $this->getContext(); |
|
| 269 | + $config = $context->getConfig(); |
|
| 270 | + $domains = array( 'text', 'price', 'media' ); |
|
| 271 | + $products = $view->detailProductItem->getRefItems( 'product', null, 'suggestion' ); |
|
| 272 | + |
|
| 273 | + $controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' ); |
|
| 274 | + |
|
| 275 | + /** client/html/catalog/detail/domains |
|
| 276 | + * A list of domain names whose items should be available in the catalog view templates |
|
| 277 | + * |
|
| 278 | + * @see client/html/catalog/detail/domains |
|
| 279 | + */ |
|
| 280 | + $domains = $config->get( 'client/html/catalog/detail/domains', $domains ); |
|
| 281 | + |
|
| 282 | + /** client/html/catalog/detail/suggest/domains |
|
| 283 | + * A list of domain names whose items should be available in the suggestion part of the catalog detail view templates |
|
| 284 | + * |
|
| 285 | + * The templates rendering suggestion related data usually add |
|
| 286 | + * the images and texts associated to each item. If you want to |
|
| 287 | + * display additional content like the attributes, you can configure |
|
| 288 | + * your own list of domains (attribute, media, price, product, text, |
|
| 289 | + * etc. are domains) whose items are fetched from the storage. |
|
| 290 | + * Please keep in mind that the more domains you add to the |
|
| 291 | + * configuration, the more time is required for fetching the content! |
|
| 292 | + * |
|
| 293 | + * This configuration option can be overwritten by the |
|
| 294 | + * "client/html/catalog/detail/domains" configuration option that |
|
| 295 | + * allows to configure the domain names of the items fetched |
|
| 296 | + * specifically for all types of product listings. |
|
| 297 | + * |
|
| 298 | + * @param array List of domain names |
|
| 299 | + * @since 2015.09 |
|
| 300 | + * @category Developer |
|
| 301 | + * @see client/html/catalog/detail/domains |
|
| 302 | + */ |
|
| 303 | + $domains = $config->get( 'client/html/catalog/detail/suggest/domains', $domains ); |
|
| 304 | + |
|
| 305 | + $view->suggestItems = $controller->getProductItems( array_keys( $products ), $domains ); |
|
| 306 | + $view->suggestPosItems = $products; |
|
| 307 | + |
|
| 308 | + $this->addMetaItem( $view->suggestItems, 'product', $this->expire, $this->tags ); |
|
| 309 | + $this->addMetaList( array_keys( $view->suggestItems ), 'product', $this->expire ); |
|
| 310 | + } |
|
| 311 | + |
|
| 312 | + $this->cache = $view; |
|
| 313 | + } |
|
| 314 | + |
|
| 315 | + $expire = $this->expires( $this->expire, $expire ); |
|
| 316 | + $tags = array_merge( $tags, $this->tags ); |
|
| 317 | + |
|
| 318 | + return $this->cache; |
|
| 319 | + } |
|
| 320 | 320 | } |
| 321 | 321 | \ No newline at end of file |
@@ -70,13 +70,13 @@ discard block |
||
| 70 | 70 | * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
| 71 | 71 | * @return string HTML code |
| 72 | 72 | */ |
| 73 | - public function getBody( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 73 | + public function getBody($uid = '', array &$tags = array(), &$expire = null) |
|
| 74 | 74 | { |
| 75 | - $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 75 | + $view = $this->setViewParams($this->getView(), $tags, $expire); |
|
| 76 | 76 | |
| 77 | 77 | $html = ''; |
| 78 | - foreach( $this->getSubClients() as $subclient ) { |
|
| 79 | - $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire ); |
|
| 78 | + foreach ($this->getSubClients() as $subclient) { |
|
| 79 | + $html .= $subclient->setView($view)->getBody($uid, $tags, $expire); |
|
| 80 | 80 | } |
| 81 | 81 | $view->suggestBody = $html; |
| 82 | 82 | |
@@ -103,7 +103,7 @@ discard block |
||
| 103 | 103 | $tplconf = 'client/html/catalog/detail/suggest/standard/template-body'; |
| 104 | 104 | $default = 'catalog/detail/suggest-body-default.php'; |
| 105 | 105 | |
| 106 | - return $view->render( $view->config( $tplconf, $default ) ); |
|
| 106 | + return $view->render($view->config($tplconf, $default)); |
|
| 107 | 107 | } |
| 108 | 108 | |
| 109 | 109 | |
@@ -115,13 +115,13 @@ discard block |
||
| 115 | 115 | * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
| 116 | 116 | * @return string|null String including HTML tags for the header on error |
| 117 | 117 | */ |
| 118 | - public function getHeader( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 118 | + public function getHeader($uid = '', array &$tags = array(), &$expire = null) |
|
| 119 | 119 | { |
| 120 | - $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 120 | + $view = $this->setViewParams($this->getView(), $tags, $expire); |
|
| 121 | 121 | |
| 122 | 122 | $html = ''; |
| 123 | - foreach( $this->getSubClients() as $subclient ) { |
|
| 124 | - $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire ); |
|
| 123 | + foreach ($this->getSubClients() as $subclient) { |
|
| 124 | + $html .= $subclient->setView($view)->getHeader($uid, $tags, $expire); |
|
| 125 | 125 | } |
| 126 | 126 | $view->suggestHeader = $html; |
| 127 | 127 | |
@@ -149,7 +149,7 @@ discard block |
||
| 149 | 149 | $tplconf = 'client/html/catalog/detail/suggest/standard/template-header'; |
| 150 | 150 | $default = 'catalog/detail/suggest-header-default.php'; |
| 151 | 151 | |
| 152 | - return $view->render( $view->config( $tplconf, $default ) ); |
|
| 152 | + return $view->render($view->config($tplconf, $default)); |
|
| 153 | 153 | } |
| 154 | 154 | |
| 155 | 155 | |
@@ -160,7 +160,7 @@ discard block |
||
| 160 | 160 | * @param string|null $name Name of the sub-client (Default if null) |
| 161 | 161 | * @return \Aimeos\Client\Html\Iface Sub-client object |
| 162 | 162 | */ |
| 163 | - public function getSubClient( $type, $name = null ) |
|
| 163 | + public function getSubClient($type, $name = null) |
|
| 164 | 164 | { |
| 165 | 165 | /** client/html/catalog/detail/suggest/decorators/excludes |
| 166 | 166 | * Excludes decorators added by the "common" option from the catalog detail suggest html client |
@@ -236,7 +236,7 @@ discard block |
||
| 236 | 236 | * @see client/html/catalog/detail/suggest/decorators/global |
| 237 | 237 | */ |
| 238 | 238 | |
| 239 | - return $this->createSubClient( 'catalog/detail/suggest/' . $type, $name ); |
|
| 239 | + return $this->createSubClient('catalog/detail/suggest/'.$type, $name); |
|
| 240 | 240 | } |
| 241 | 241 | |
| 242 | 242 | |
@@ -247,7 +247,7 @@ discard block |
||
| 247 | 247 | */ |
| 248 | 248 | protected function getSubClientNames() |
| 249 | 249 | { |
| 250 | - return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames ); |
|
| 250 | + return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames); |
|
| 251 | 251 | } |
| 252 | 252 | |
| 253 | 253 | |
@@ -259,25 +259,25 @@ discard block |
||
| 259 | 259 | * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
| 260 | 260 | * @return \Aimeos\MW\View\Iface Modified view object |
| 261 | 261 | */ |
| 262 | - protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null ) |
|
| 262 | + protected function setViewParams(\Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null) |
|
| 263 | 263 | { |
| 264 | - if( !isset( $this->cache ) ) |
|
| 264 | + if (!isset($this->cache)) |
|
| 265 | 265 | { |
| 266 | - if( isset( $view->detailProductItem ) ) |
|
| 266 | + if (isset($view->detailProductItem)) |
|
| 267 | 267 | { |
| 268 | 268 | $context = $this->getContext(); |
| 269 | 269 | $config = $context->getConfig(); |
| 270 | - $domains = array( 'text', 'price', 'media' ); |
|
| 271 | - $products = $view->detailProductItem->getRefItems( 'product', null, 'suggestion' ); |
|
| 270 | + $domains = array('text', 'price', 'media'); |
|
| 271 | + $products = $view->detailProductItem->getRefItems('product', null, 'suggestion'); |
|
| 272 | 272 | |
| 273 | - $controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' ); |
|
| 273 | + $controller = \Aimeos\Controller\Frontend\Factory::createController($context, 'catalog'); |
|
| 274 | 274 | |
| 275 | 275 | /** client/html/catalog/detail/domains |
| 276 | 276 | * A list of domain names whose items should be available in the catalog view templates |
| 277 | 277 | * |
| 278 | 278 | * @see client/html/catalog/detail/domains |
| 279 | 279 | */ |
| 280 | - $domains = $config->get( 'client/html/catalog/detail/domains', $domains ); |
|
| 280 | + $domains = $config->get('client/html/catalog/detail/domains', $domains); |
|
| 281 | 281 | |
| 282 | 282 | /** client/html/catalog/detail/suggest/domains |
| 283 | 283 | * A list of domain names whose items should be available in the suggestion part of the catalog detail view templates |
@@ -300,20 +300,20 @@ discard block |
||
| 300 | 300 | * @category Developer |
| 301 | 301 | * @see client/html/catalog/detail/domains |
| 302 | 302 | */ |
| 303 | - $domains = $config->get( 'client/html/catalog/detail/suggest/domains', $domains ); |
|
| 303 | + $domains = $config->get('client/html/catalog/detail/suggest/domains', $domains); |
|
| 304 | 304 | |
| 305 | - $view->suggestItems = $controller->getProductItems( array_keys( $products ), $domains ); |
|
| 305 | + $view->suggestItems = $controller->getProductItems(array_keys($products), $domains); |
|
| 306 | 306 | $view->suggestPosItems = $products; |
| 307 | 307 | |
| 308 | - $this->addMetaItem( $view->suggestItems, 'product', $this->expire, $this->tags ); |
|
| 309 | - $this->addMetaList( array_keys( $view->suggestItems ), 'product', $this->expire ); |
|
| 308 | + $this->addMetaItem($view->suggestItems, 'product', $this->expire, $this->tags); |
|
| 309 | + $this->addMetaList(array_keys($view->suggestItems), 'product', $this->expire); |
|
| 310 | 310 | } |
| 311 | 311 | |
| 312 | 312 | $this->cache = $view; |
| 313 | 313 | } |
| 314 | 314 | |
| 315 | - $expire = $this->expires( $this->expire, $expire ); |
|
| 316 | - $tags = array_merge( $tags, $this->tags ); |
|
| 315 | + $expire = $this->expires($this->expire, $expire); |
|
| 316 | + $tags = array_merge($tags, $this->tags); |
|
| 317 | 317 | |
| 318 | 318 | return $this->cache; |
| 319 | 319 | } |
@@ -110,7 +110,7 @@ |
||
| 110 | 110 | * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
| 111 | 111 | * @param array &$tags Result array for the list of tags that are associated to the output |
| 112 | 112 | * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
| 113 | - * @return string|null String including HTML tags for the header on error |
|
| 113 | + * @return string String including HTML tags for the header on error |
|
| 114 | 114 | */ |
| 115 | 115 | public function getHeader( $uid = '', array &$tags = array(), &$expire = null ) |
| 116 | 116 | { |
@@ -19,303 +19,303 @@ |
||
| 19 | 19 | * @subpackage Html |
| 20 | 20 | */ |
| 21 | 21 | class Standard |
| 22 | - extends \Aimeos\Client\Html\Common\Client\Factory\Base |
|
| 23 | - implements \Aimeos\Client\Html\Common\Client\Factory\Iface |
|
| 22 | + extends \Aimeos\Client\Html\Common\Client\Factory\Base |
|
| 23 | + implements \Aimeos\Client\Html\Common\Client\Factory\Iface |
|
| 24 | 24 | { |
| 25 | - /** client/html/catalog/detail/seen/standard/subparts |
|
| 26 | - * List of HTML sub-clients rendered within the catalog detail seen section |
|
| 27 | - * |
|
| 28 | - * The output of the frontend is composed of the code generated by the HTML |
|
| 29 | - * clients. Each HTML client can consist of serveral (or none) sub-clients |
|
| 30 | - * that are responsible for rendering certain sub-parts of the output. The |
|
| 31 | - * sub-clients can contain HTML clients themselves and therefore a |
|
| 32 | - * hierarchical tree of HTML clients is composed. Each HTML client creates |
|
| 33 | - * the output that is placed inside the container of its parent. |
|
| 34 | - * |
|
| 35 | - * At first, always the HTML code generated by the parent is printed, then |
|
| 36 | - * the HTML code of its sub-clients. The order of the HTML sub-clients |
|
| 37 | - * determines the order of the output of these sub-clients inside the parent |
|
| 38 | - * container. If the configured list of clients is |
|
| 39 | - * |
|
| 40 | - * array( "subclient1", "subclient2" ) |
|
| 41 | - * |
|
| 42 | - * you can easily change the order of the output by reordering the subparts: |
|
| 43 | - * |
|
| 44 | - * client/html/<clients>/subparts = array( "subclient1", "subclient2" ) |
|
| 45 | - * |
|
| 46 | - * You can also remove one or more parts if they shouldn't be rendered: |
|
| 47 | - * |
|
| 48 | - * client/html/<clients>/subparts = array( "subclient1" ) |
|
| 49 | - * |
|
| 50 | - * As the clients only generates structural HTML, the layout defined via CSS |
|
| 51 | - * should support adding, removing or reordering content by a fluid like |
|
| 52 | - * design. |
|
| 53 | - * |
|
| 54 | - * @param array List of sub-client names |
|
| 55 | - * @since 2014.03 |
|
| 56 | - * @category Developer |
|
| 57 | - */ |
|
| 58 | - private $subPartPath = 'client/html/catalog/detail/seen/standard/subparts'; |
|
| 59 | - private $subPartNames = array(); |
|
| 60 | - |
|
| 61 | - |
|
| 62 | - /** |
|
| 63 | - * Returns the HTML code for insertion into the body. |
|
| 64 | - * |
|
| 65 | - * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
|
| 66 | - * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 67 | - * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 68 | - * @return string HTML code |
|
| 69 | - */ |
|
| 70 | - public function getBody( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 71 | - { |
|
| 72 | - return ''; |
|
| 73 | - } |
|
| 74 | - |
|
| 75 | - |
|
| 76 | - /** |
|
| 77 | - * Returns the HTML string for insertion into the header. |
|
| 78 | - * |
|
| 79 | - * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
|
| 80 | - * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 81 | - * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 82 | - * @return string|null String including HTML tags for the header on error |
|
| 83 | - */ |
|
| 84 | - public function getHeader( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 85 | - { |
|
| 86 | - return ''; |
|
| 87 | - } |
|
| 88 | - |
|
| 89 | - |
|
| 90 | - /** |
|
| 91 | - * Returns the sub-client given by its name. |
|
| 92 | - * |
|
| 93 | - * @param string $type Name of the client type |
|
| 94 | - * @param string|null $name Name of the sub-client (Default if null) |
|
| 95 | - * @return \Aimeos\Client\Html\Iface Sub-client object |
|
| 96 | - */ |
|
| 97 | - public function getSubClient( $type, $name = null ) |
|
| 98 | - { |
|
| 99 | - /** client/html/catalog/detail/seen/decorators/excludes |
|
| 100 | - * Excludes decorators added by the "common" option from the catalog detail seen html client |
|
| 101 | - * |
|
| 102 | - * Decorators extend the functionality of a class by adding new aspects |
|
| 103 | - * (e.g. log what is currently done), executing the methods of the underlying |
|
| 104 | - * class only in certain conditions (e.g. only for logged in users) or |
|
| 105 | - * modify what is returned to the caller. |
|
| 106 | - * |
|
| 107 | - * This option allows you to remove a decorator added via |
|
| 108 | - * "client/html/common/decorators/default" before they are wrapped |
|
| 109 | - * around the html client. |
|
| 110 | - * |
|
| 111 | - * client/html/catalog/detail/seen/decorators/excludes = array( 'decorator1' ) |
|
| 112 | - * |
|
| 113 | - * This would remove the decorator named "decorator1" from the list of |
|
| 114 | - * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via |
|
| 115 | - * "client/html/common/decorators/default" to the html client. |
|
| 116 | - * |
|
| 117 | - * @param array List of decorator names |
|
| 118 | - * @since 2015.08 |
|
| 119 | - * @category Developer |
|
| 120 | - * @see client/html/common/decorators/default |
|
| 121 | - * @see client/html/catalog/detail/seen/decorators/global |
|
| 122 | - * @see client/html/catalog/detail/seen/decorators/local |
|
| 123 | - */ |
|
| 124 | - |
|
| 125 | - /** client/html/catalog/detail/seen/decorators/global |
|
| 126 | - * Adds a list of globally available decorators only to the catalog detail seen html client |
|
| 127 | - * |
|
| 128 | - * Decorators extend the functionality of a class by adding new aspects |
|
| 129 | - * (e.g. log what is currently done), executing the methods of the underlying |
|
| 130 | - * class only in certain conditions (e.g. only for logged in users) or |
|
| 131 | - * modify what is returned to the caller. |
|
| 132 | - * |
|
| 133 | - * This option allows you to wrap global decorators |
|
| 134 | - * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client. |
|
| 135 | - * |
|
| 136 | - * client/html/catalog/detail/seen/decorators/global = array( 'decorator1' ) |
|
| 137 | - * |
|
| 138 | - * This would add the decorator named "decorator1" defined by |
|
| 139 | - * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client. |
|
| 140 | - * |
|
| 141 | - * @param array List of decorator names |
|
| 142 | - * @since 2015.08 |
|
| 143 | - * @category Developer |
|
| 144 | - * @see client/html/common/decorators/default |
|
| 145 | - * @see client/html/catalog/detail/seen/decorators/excludes |
|
| 146 | - * @see client/html/catalog/detail/seen/decorators/local |
|
| 147 | - */ |
|
| 148 | - |
|
| 149 | - /** client/html/catalog/detail/seen/decorators/local |
|
| 150 | - * Adds a list of local decorators only to the catalog detail seen html client |
|
| 151 | - * |
|
| 152 | - * Decorators extend the functionality of a class by adding new aspects |
|
| 153 | - * (e.g. log what is currently done), executing the methods of the underlying |
|
| 154 | - * class only in certain conditions (e.g. only for logged in users) or |
|
| 155 | - * modify what is returned to the caller. |
|
| 156 | - * |
|
| 157 | - * This option allows you to wrap local decorators |
|
| 158 | - * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client. |
|
| 159 | - * |
|
| 160 | - * client/html/catalog/detail/seen/decorators/local = array( 'decorator2' ) |
|
| 161 | - * |
|
| 162 | - * This would add the decorator named "decorator2" defined by |
|
| 163 | - * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client. |
|
| 164 | - * |
|
| 165 | - * @param array List of decorator names |
|
| 166 | - * @since 2015.08 |
|
| 167 | - * @category Developer |
|
| 168 | - * @see client/html/common/decorators/default |
|
| 169 | - * @see client/html/catalog/detail/seen/decorators/excludes |
|
| 170 | - * @see client/html/catalog/detail/seen/decorators/global |
|
| 171 | - */ |
|
| 172 | - |
|
| 173 | - return $this->createSubClient( 'catalog/detail/seen/' . $type, $name ); |
|
| 174 | - } |
|
| 175 | - |
|
| 176 | - |
|
| 177 | - /** |
|
| 178 | - * Returns the list of sub-client names configured for the client. |
|
| 179 | - * |
|
| 180 | - * @return array List of HTML client names |
|
| 181 | - */ |
|
| 182 | - protected function getSubClientNames() |
|
| 183 | - { |
|
| 184 | - return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames ); |
|
| 185 | - } |
|
| 186 | - |
|
| 187 | - |
|
| 188 | - /** |
|
| 189 | - * Processes the input, e.g. store given values. |
|
| 190 | - * A view must be available and this method doesn't generate any output |
|
| 191 | - * besides setting view variables. |
|
| 192 | - */ |
|
| 193 | - public function process() |
|
| 194 | - { |
|
| 195 | - if( ( $id = $this->getView()->param( 'd_prodid' ) ) !== null ) |
|
| 196 | - { |
|
| 197 | - $context = $this->getContext(); |
|
| 198 | - $session = $context->getSession(); |
|
| 199 | - $lastSeen = $session->get( 'aimeos/catalog/session/seen/list', array() ); |
|
| 200 | - |
|
| 201 | - if( isset( $lastSeen[$id] ) ) |
|
| 202 | - { |
|
| 203 | - $html = $lastSeen[$id]; |
|
| 204 | - unset( $lastSeen[$id] ); |
|
| 205 | - $lastSeen[$id] = $html; |
|
| 206 | - } |
|
| 207 | - else |
|
| 208 | - { |
|
| 209 | - /** client/html/catalog/session/seen/standard/maxitems |
|
| 210 | - * Maximum number of products displayed in the "last seen" section |
|
| 211 | - * |
|
| 212 | - * This option limits the number of products that are shown in the |
|
| 213 | - * "last seen" section after the user visited their detail pages. It |
|
| 214 | - * must be a positive integer value greater than 0. |
|
| 215 | - * |
|
| 216 | - * @param integer Number of products |
|
| 217 | - * @since 2014.03 |
|
| 218 | - * @category User |
|
| 219 | - * @category Developer |
|
| 220 | - */ |
|
| 221 | - $max = $this->getContext()->getConfig()->get( 'client/html/catalog/session/seen/standard/maxitems', 6 ); |
|
| 222 | - |
|
| 223 | - $lastSeen[$id] = $this->getHtml( $id ); |
|
| 224 | - $lastSeen = array_slice( $lastSeen, -$max, $max, true ); |
|
| 225 | - } |
|
| 226 | - |
|
| 227 | - $session->set( 'aimeos/catalog/session/seen/list', $lastSeen ); |
|
| 228 | - |
|
| 229 | - foreach( $session->get( 'aimeos/catalog/session/seen/cache', array() ) as $key => $value ) { |
|
| 230 | - $session->set( $key, null ); |
|
| 231 | - } |
|
| 232 | - } |
|
| 233 | - |
|
| 234 | - parent::process(); |
|
| 235 | - } |
|
| 236 | - |
|
| 237 | - |
|
| 238 | - /** |
|
| 239 | - * Returns the generated HTML for the given product ID. |
|
| 240 | - * |
|
| 241 | - * @param string $id Product ID |
|
| 242 | - * @return string HTML of the last seen item for the given product ID |
|
| 243 | - */ |
|
| 244 | - protected function getHtml( $id ) |
|
| 245 | - { |
|
| 246 | - $context = $this->getContext(); |
|
| 247 | - $cache = $context->getCache(); |
|
| 248 | - $key = md5( $id . 'product:detail-seen' ); |
|
| 249 | - |
|
| 250 | - if( ( $html = $cache->get( $key ) ) === null ) |
|
| 251 | - { |
|
| 252 | - $expire = null; |
|
| 253 | - $tags = array(); |
|
| 254 | - $view = $this->getView(); |
|
| 255 | - $config = $context->getConfig(); |
|
| 256 | - |
|
| 257 | - $default = array( 'media', 'price', 'text' ); |
|
| 258 | - $domains = $config->get( 'client/html/catalog/domains', $default ); |
|
| 259 | - |
|
| 260 | - /** client/html/catalog/detail/seen/domains |
|
| 261 | - * A list of domain names whose items should be available in the last seen view template for the product |
|
| 262 | - * |
|
| 263 | - * The templates rendering product details usually add the images, |
|
| 264 | - * prices and texts, etc. associated to the product |
|
| 265 | - * item. If you want to display additional or less content, you can |
|
| 266 | - * configure your own list of domains (attribute, media, price, product, |
|
| 267 | - * text, etc. are domains) whose items are fetched from the storage. |
|
| 268 | - * Please keep in mind that the more domains you add to the configuration, |
|
| 269 | - * the more time is required for fetching the content! |
|
| 270 | - * |
|
| 271 | - * @param array List of domain names |
|
| 272 | - * @since 2014.07 |
|
| 273 | - * @category Developer |
|
| 274 | - * @see client/html/catalog/domains |
|
| 275 | - * @see client/html/catalog/lists/domains |
|
| 276 | - * @see client/html/catalog/detail/domains |
|
| 277 | - */ |
|
| 278 | - $domains = $config->get( 'client/html/catalog/detail/seen/domains', $domains ); |
|
| 279 | - |
|
| 280 | - $view->seenProductItem = \Aimeos\MShop\Factory::createManager( $context, 'product' )->getItem( $id, $domains ); |
|
| 281 | - |
|
| 282 | - $this->addMetaItem( $view->seenProductItem, 'product', $expire, $tags ); |
|
| 283 | - $this->addMetaList( $view->seenProductItem->getId(), 'product', $expire ); |
|
| 284 | - |
|
| 285 | - $output = ''; |
|
| 286 | - foreach( $this->getSubClients() as $subclient ) { |
|
| 287 | - $output .= $subclient->setView( $view )->getBody( '', $tags, $expire ); |
|
| 288 | - } |
|
| 289 | - $view->seenBody = $output; |
|
| 290 | - |
|
| 291 | - /** client/html/catalog/detail/seen/standard/template-body |
|
| 292 | - * Relative path to the HTML body template of the catalog detail seen client. |
|
| 293 | - * |
|
| 294 | - * The template file contains the HTML code and processing instructions |
|
| 295 | - * to generate the result shown in the body of the frontend. The |
|
| 296 | - * configuration string is the path to the template file relative |
|
| 297 | - * to the templates directory (usually in client/html/templates). |
|
| 298 | - * |
|
| 299 | - * You can overwrite the template file configuration in extensions and |
|
| 300 | - * provide alternative templates. These alternative templates should be |
|
| 301 | - * named like the default one but with the string "standard" replaced by |
|
| 302 | - * an unique name. You may use the name of your project for this. If |
|
| 303 | - * you've implemented an alternative client class as well, "standard" |
|
| 304 | - * should be replaced by the name of the new class. |
|
| 305 | - * |
|
| 306 | - * @param string Relative path to the template creating code for the HTML page body |
|
| 307 | - * @since 2014.03 |
|
| 308 | - * @category Developer |
|
| 309 | - * @see client/html/catalog/detail/seen/standard/template-header |
|
| 310 | - */ |
|
| 311 | - $tplconf = 'client/html/catalog/detail/seen/standard/template-body'; |
|
| 312 | - $default = 'catalog/detail/seen-body-default.php'; |
|
| 313 | - |
|
| 314 | - $html = $view->render( $view->config( $tplconf, $default ) ); |
|
| 315 | - |
|
| 316 | - $cache->set( $key, $html, $tags, $expire ); |
|
| 317 | - } |
|
| 318 | - |
|
| 319 | - return $html; |
|
| 320 | - } |
|
| 25 | + /** client/html/catalog/detail/seen/standard/subparts |
|
| 26 | + * List of HTML sub-clients rendered within the catalog detail seen section |
|
| 27 | + * |
|
| 28 | + * The output of the frontend is composed of the code generated by the HTML |
|
| 29 | + * clients. Each HTML client can consist of serveral (or none) sub-clients |
|
| 30 | + * that are responsible for rendering certain sub-parts of the output. The |
|
| 31 | + * sub-clients can contain HTML clients themselves and therefore a |
|
| 32 | + * hierarchical tree of HTML clients is composed. Each HTML client creates |
|
| 33 | + * the output that is placed inside the container of its parent. |
|
| 34 | + * |
|
| 35 | + * At first, always the HTML code generated by the parent is printed, then |
|
| 36 | + * the HTML code of its sub-clients. The order of the HTML sub-clients |
|
| 37 | + * determines the order of the output of these sub-clients inside the parent |
|
| 38 | + * container. If the configured list of clients is |
|
| 39 | + * |
|
| 40 | + * array( "subclient1", "subclient2" ) |
|
| 41 | + * |
|
| 42 | + * you can easily change the order of the output by reordering the subparts: |
|
| 43 | + * |
|
| 44 | + * client/html/<clients>/subparts = array( "subclient1", "subclient2" ) |
|
| 45 | + * |
|
| 46 | + * You can also remove one or more parts if they shouldn't be rendered: |
|
| 47 | + * |
|
| 48 | + * client/html/<clients>/subparts = array( "subclient1" ) |
|
| 49 | + * |
|
| 50 | + * As the clients only generates structural HTML, the layout defined via CSS |
|
| 51 | + * should support adding, removing or reordering content by a fluid like |
|
| 52 | + * design. |
|
| 53 | + * |
|
| 54 | + * @param array List of sub-client names |
|
| 55 | + * @since 2014.03 |
|
| 56 | + * @category Developer |
|
| 57 | + */ |
|
| 58 | + private $subPartPath = 'client/html/catalog/detail/seen/standard/subparts'; |
|
| 59 | + private $subPartNames = array(); |
|
| 60 | + |
|
| 61 | + |
|
| 62 | + /** |
|
| 63 | + * Returns the HTML code for insertion into the body. |
|
| 64 | + * |
|
| 65 | + * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
|
| 66 | + * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 67 | + * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 68 | + * @return string HTML code |
|
| 69 | + */ |
|
| 70 | + public function getBody( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 71 | + { |
|
| 72 | + return ''; |
|
| 73 | + } |
|
| 74 | + |
|
| 75 | + |
|
| 76 | + /** |
|
| 77 | + * Returns the HTML string for insertion into the header. |
|
| 78 | + * |
|
| 79 | + * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
|
| 80 | + * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 81 | + * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 82 | + * @return string|null String including HTML tags for the header on error |
|
| 83 | + */ |
|
| 84 | + public function getHeader( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 85 | + { |
|
| 86 | + return ''; |
|
| 87 | + } |
|
| 88 | + |
|
| 89 | + |
|
| 90 | + /** |
|
| 91 | + * Returns the sub-client given by its name. |
|
| 92 | + * |
|
| 93 | + * @param string $type Name of the client type |
|
| 94 | + * @param string|null $name Name of the sub-client (Default if null) |
|
| 95 | + * @return \Aimeos\Client\Html\Iface Sub-client object |
|
| 96 | + */ |
|
| 97 | + public function getSubClient( $type, $name = null ) |
|
| 98 | + { |
|
| 99 | + /** client/html/catalog/detail/seen/decorators/excludes |
|
| 100 | + * Excludes decorators added by the "common" option from the catalog detail seen html client |
|
| 101 | + * |
|
| 102 | + * Decorators extend the functionality of a class by adding new aspects |
|
| 103 | + * (e.g. log what is currently done), executing the methods of the underlying |
|
| 104 | + * class only in certain conditions (e.g. only for logged in users) or |
|
| 105 | + * modify what is returned to the caller. |
|
| 106 | + * |
|
| 107 | + * This option allows you to remove a decorator added via |
|
| 108 | + * "client/html/common/decorators/default" before they are wrapped |
|
| 109 | + * around the html client. |
|
| 110 | + * |
|
| 111 | + * client/html/catalog/detail/seen/decorators/excludes = array( 'decorator1' ) |
|
| 112 | + * |
|
| 113 | + * This would remove the decorator named "decorator1" from the list of |
|
| 114 | + * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via |
|
| 115 | + * "client/html/common/decorators/default" to the html client. |
|
| 116 | + * |
|
| 117 | + * @param array List of decorator names |
|
| 118 | + * @since 2015.08 |
|
| 119 | + * @category Developer |
|
| 120 | + * @see client/html/common/decorators/default |
|
| 121 | + * @see client/html/catalog/detail/seen/decorators/global |
|
| 122 | + * @see client/html/catalog/detail/seen/decorators/local |
|
| 123 | + */ |
|
| 124 | + |
|
| 125 | + /** client/html/catalog/detail/seen/decorators/global |
|
| 126 | + * Adds a list of globally available decorators only to the catalog detail seen html client |
|
| 127 | + * |
|
| 128 | + * Decorators extend the functionality of a class by adding new aspects |
|
| 129 | + * (e.g. log what is currently done), executing the methods of the underlying |
|
| 130 | + * class only in certain conditions (e.g. only for logged in users) or |
|
| 131 | + * modify what is returned to the caller. |
|
| 132 | + * |
|
| 133 | + * This option allows you to wrap global decorators |
|
| 134 | + * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client. |
|
| 135 | + * |
|
| 136 | + * client/html/catalog/detail/seen/decorators/global = array( 'decorator1' ) |
|
| 137 | + * |
|
| 138 | + * This would add the decorator named "decorator1" defined by |
|
| 139 | + * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client. |
|
| 140 | + * |
|
| 141 | + * @param array List of decorator names |
|
| 142 | + * @since 2015.08 |
|
| 143 | + * @category Developer |
|
| 144 | + * @see client/html/common/decorators/default |
|
| 145 | + * @see client/html/catalog/detail/seen/decorators/excludes |
|
| 146 | + * @see client/html/catalog/detail/seen/decorators/local |
|
| 147 | + */ |
|
| 148 | + |
|
| 149 | + /** client/html/catalog/detail/seen/decorators/local |
|
| 150 | + * Adds a list of local decorators only to the catalog detail seen html client |
|
| 151 | + * |
|
| 152 | + * Decorators extend the functionality of a class by adding new aspects |
|
| 153 | + * (e.g. log what is currently done), executing the methods of the underlying |
|
| 154 | + * class only in certain conditions (e.g. only for logged in users) or |
|
| 155 | + * modify what is returned to the caller. |
|
| 156 | + * |
|
| 157 | + * This option allows you to wrap local decorators |
|
| 158 | + * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client. |
|
| 159 | + * |
|
| 160 | + * client/html/catalog/detail/seen/decorators/local = array( 'decorator2' ) |
|
| 161 | + * |
|
| 162 | + * This would add the decorator named "decorator2" defined by |
|
| 163 | + * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client. |
|
| 164 | + * |
|
| 165 | + * @param array List of decorator names |
|
| 166 | + * @since 2015.08 |
|
| 167 | + * @category Developer |
|
| 168 | + * @see client/html/common/decorators/default |
|
| 169 | + * @see client/html/catalog/detail/seen/decorators/excludes |
|
| 170 | + * @see client/html/catalog/detail/seen/decorators/global |
|
| 171 | + */ |
|
| 172 | + |
|
| 173 | + return $this->createSubClient( 'catalog/detail/seen/' . $type, $name ); |
|
| 174 | + } |
|
| 175 | + |
|
| 176 | + |
|
| 177 | + /** |
|
| 178 | + * Returns the list of sub-client names configured for the client. |
|
| 179 | + * |
|
| 180 | + * @return array List of HTML client names |
|
| 181 | + */ |
|
| 182 | + protected function getSubClientNames() |
|
| 183 | + { |
|
| 184 | + return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames ); |
|
| 185 | + } |
|
| 186 | + |
|
| 187 | + |
|
| 188 | + /** |
|
| 189 | + * Processes the input, e.g. store given values. |
|
| 190 | + * A view must be available and this method doesn't generate any output |
|
| 191 | + * besides setting view variables. |
|
| 192 | + */ |
|
| 193 | + public function process() |
|
| 194 | + { |
|
| 195 | + if( ( $id = $this->getView()->param( 'd_prodid' ) ) !== null ) |
|
| 196 | + { |
|
| 197 | + $context = $this->getContext(); |
|
| 198 | + $session = $context->getSession(); |
|
| 199 | + $lastSeen = $session->get( 'aimeos/catalog/session/seen/list', array() ); |
|
| 200 | + |
|
| 201 | + if( isset( $lastSeen[$id] ) ) |
|
| 202 | + { |
|
| 203 | + $html = $lastSeen[$id]; |
|
| 204 | + unset( $lastSeen[$id] ); |
|
| 205 | + $lastSeen[$id] = $html; |
|
| 206 | + } |
|
| 207 | + else |
|
| 208 | + { |
|
| 209 | + /** client/html/catalog/session/seen/standard/maxitems |
|
| 210 | + * Maximum number of products displayed in the "last seen" section |
|
| 211 | + * |
|
| 212 | + * This option limits the number of products that are shown in the |
|
| 213 | + * "last seen" section after the user visited their detail pages. It |
|
| 214 | + * must be a positive integer value greater than 0. |
|
| 215 | + * |
|
| 216 | + * @param integer Number of products |
|
| 217 | + * @since 2014.03 |
|
| 218 | + * @category User |
|
| 219 | + * @category Developer |
|
| 220 | + */ |
|
| 221 | + $max = $this->getContext()->getConfig()->get( 'client/html/catalog/session/seen/standard/maxitems', 6 ); |
|
| 222 | + |
|
| 223 | + $lastSeen[$id] = $this->getHtml( $id ); |
|
| 224 | + $lastSeen = array_slice( $lastSeen, -$max, $max, true ); |
|
| 225 | + } |
|
| 226 | + |
|
| 227 | + $session->set( 'aimeos/catalog/session/seen/list', $lastSeen ); |
|
| 228 | + |
|
| 229 | + foreach( $session->get( 'aimeos/catalog/session/seen/cache', array() ) as $key => $value ) { |
|
| 230 | + $session->set( $key, null ); |
|
| 231 | + } |
|
| 232 | + } |
|
| 233 | + |
|
| 234 | + parent::process(); |
|
| 235 | + } |
|
| 236 | + |
|
| 237 | + |
|
| 238 | + /** |
|
| 239 | + * Returns the generated HTML for the given product ID. |
|
| 240 | + * |
|
| 241 | + * @param string $id Product ID |
|
| 242 | + * @return string HTML of the last seen item for the given product ID |
|
| 243 | + */ |
|
| 244 | + protected function getHtml( $id ) |
|
| 245 | + { |
|
| 246 | + $context = $this->getContext(); |
|
| 247 | + $cache = $context->getCache(); |
|
| 248 | + $key = md5( $id . 'product:detail-seen' ); |
|
| 249 | + |
|
| 250 | + if( ( $html = $cache->get( $key ) ) === null ) |
|
| 251 | + { |
|
| 252 | + $expire = null; |
|
| 253 | + $tags = array(); |
|
| 254 | + $view = $this->getView(); |
|
| 255 | + $config = $context->getConfig(); |
|
| 256 | + |
|
| 257 | + $default = array( 'media', 'price', 'text' ); |
|
| 258 | + $domains = $config->get( 'client/html/catalog/domains', $default ); |
|
| 259 | + |
|
| 260 | + /** client/html/catalog/detail/seen/domains |
|
| 261 | + * A list of domain names whose items should be available in the last seen view template for the product |
|
| 262 | + * |
|
| 263 | + * The templates rendering product details usually add the images, |
|
| 264 | + * prices and texts, etc. associated to the product |
|
| 265 | + * item. If you want to display additional or less content, you can |
|
| 266 | + * configure your own list of domains (attribute, media, price, product, |
|
| 267 | + * text, etc. are domains) whose items are fetched from the storage. |
|
| 268 | + * Please keep in mind that the more domains you add to the configuration, |
|
| 269 | + * the more time is required for fetching the content! |
|
| 270 | + * |
|
| 271 | + * @param array List of domain names |
|
| 272 | + * @since 2014.07 |
|
| 273 | + * @category Developer |
|
| 274 | + * @see client/html/catalog/domains |
|
| 275 | + * @see client/html/catalog/lists/domains |
|
| 276 | + * @see client/html/catalog/detail/domains |
|
| 277 | + */ |
|
| 278 | + $domains = $config->get( 'client/html/catalog/detail/seen/domains', $domains ); |
|
| 279 | + |
|
| 280 | + $view->seenProductItem = \Aimeos\MShop\Factory::createManager( $context, 'product' )->getItem( $id, $domains ); |
|
| 281 | + |
|
| 282 | + $this->addMetaItem( $view->seenProductItem, 'product', $expire, $tags ); |
|
| 283 | + $this->addMetaList( $view->seenProductItem->getId(), 'product', $expire ); |
|
| 284 | + |
|
| 285 | + $output = ''; |
|
| 286 | + foreach( $this->getSubClients() as $subclient ) { |
|
| 287 | + $output .= $subclient->setView( $view )->getBody( '', $tags, $expire ); |
|
| 288 | + } |
|
| 289 | + $view->seenBody = $output; |
|
| 290 | + |
|
| 291 | + /** client/html/catalog/detail/seen/standard/template-body |
|
| 292 | + * Relative path to the HTML body template of the catalog detail seen client. |
|
| 293 | + * |
|
| 294 | + * The template file contains the HTML code and processing instructions |
|
| 295 | + * to generate the result shown in the body of the frontend. The |
|
| 296 | + * configuration string is the path to the template file relative |
|
| 297 | + * to the templates directory (usually in client/html/templates). |
|
| 298 | + * |
|
| 299 | + * You can overwrite the template file configuration in extensions and |
|
| 300 | + * provide alternative templates. These alternative templates should be |
|
| 301 | + * named like the default one but with the string "standard" replaced by |
|
| 302 | + * an unique name. You may use the name of your project for this. If |
|
| 303 | + * you've implemented an alternative client class as well, "standard" |
|
| 304 | + * should be replaced by the name of the new class. |
|
| 305 | + * |
|
| 306 | + * @param string Relative path to the template creating code for the HTML page body |
|
| 307 | + * @since 2014.03 |
|
| 308 | + * @category Developer |
|
| 309 | + * @see client/html/catalog/detail/seen/standard/template-header |
|
| 310 | + */ |
|
| 311 | + $tplconf = 'client/html/catalog/detail/seen/standard/template-body'; |
|
| 312 | + $default = 'catalog/detail/seen-body-default.php'; |
|
| 313 | + |
|
| 314 | + $html = $view->render( $view->config( $tplconf, $default ) ); |
|
| 315 | + |
|
| 316 | + $cache->set( $key, $html, $tags, $expire ); |
|
| 317 | + } |
|
| 318 | + |
|
| 319 | + return $html; |
|
| 320 | + } |
|
| 321 | 321 | } |
| 322 | 322 | \ No newline at end of file |
@@ -67,7 +67,7 @@ discard block |
||
| 67 | 67 | * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
| 68 | 68 | * @return string HTML code |
| 69 | 69 | */ |
| 70 | - public function getBody( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 70 | + public function getBody($uid = '', array &$tags = array(), &$expire = null) |
|
| 71 | 71 | { |
| 72 | 72 | return ''; |
| 73 | 73 | } |
@@ -81,7 +81,7 @@ discard block |
||
| 81 | 81 | * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
| 82 | 82 | * @return string|null String including HTML tags for the header on error |
| 83 | 83 | */ |
| 84 | - public function getHeader( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 84 | + public function getHeader($uid = '', array &$tags = array(), &$expire = null) |
|
| 85 | 85 | { |
| 86 | 86 | return ''; |
| 87 | 87 | } |
@@ -94,7 +94,7 @@ discard block |
||
| 94 | 94 | * @param string|null $name Name of the sub-client (Default if null) |
| 95 | 95 | * @return \Aimeos\Client\Html\Iface Sub-client object |
| 96 | 96 | */ |
| 97 | - public function getSubClient( $type, $name = null ) |
|
| 97 | + public function getSubClient($type, $name = null) |
|
| 98 | 98 | { |
| 99 | 99 | /** client/html/catalog/detail/seen/decorators/excludes |
| 100 | 100 | * Excludes decorators added by the "common" option from the catalog detail seen html client |
@@ -170,7 +170,7 @@ discard block |
||
| 170 | 170 | * @see client/html/catalog/detail/seen/decorators/global |
| 171 | 171 | */ |
| 172 | 172 | |
| 173 | - return $this->createSubClient( 'catalog/detail/seen/' . $type, $name ); |
|
| 173 | + return $this->createSubClient('catalog/detail/seen/'.$type, $name); |
|
| 174 | 174 | } |
| 175 | 175 | |
| 176 | 176 | |
@@ -181,7 +181,7 @@ discard block |
||
| 181 | 181 | */ |
| 182 | 182 | protected function getSubClientNames() |
| 183 | 183 | { |
| 184 | - return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames ); |
|
| 184 | + return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames); |
|
| 185 | 185 | } |
| 186 | 186 | |
| 187 | 187 | |
@@ -192,16 +192,16 @@ discard block |
||
| 192 | 192 | */ |
| 193 | 193 | public function process() |
| 194 | 194 | { |
| 195 | - if( ( $id = $this->getView()->param( 'd_prodid' ) ) !== null ) |
|
| 195 | + if (($id = $this->getView()->param('d_prodid')) !== null) |
|
| 196 | 196 | { |
| 197 | 197 | $context = $this->getContext(); |
| 198 | 198 | $session = $context->getSession(); |
| 199 | - $lastSeen = $session->get( 'aimeos/catalog/session/seen/list', array() ); |
|
| 199 | + $lastSeen = $session->get('aimeos/catalog/session/seen/list', array()); |
|
| 200 | 200 | |
| 201 | - if( isset( $lastSeen[$id] ) ) |
|
| 201 | + if (isset($lastSeen[$id])) |
|
| 202 | 202 | { |
| 203 | 203 | $html = $lastSeen[$id]; |
| 204 | - unset( $lastSeen[$id] ); |
|
| 204 | + unset($lastSeen[$id]); |
|
| 205 | 205 | $lastSeen[$id] = $html; |
| 206 | 206 | } |
| 207 | 207 | else |
@@ -218,16 +218,16 @@ discard block |
||
| 218 | 218 | * @category User |
| 219 | 219 | * @category Developer |
| 220 | 220 | */ |
| 221 | - $max = $this->getContext()->getConfig()->get( 'client/html/catalog/session/seen/standard/maxitems', 6 ); |
|
| 221 | + $max = $this->getContext()->getConfig()->get('client/html/catalog/session/seen/standard/maxitems', 6); |
|
| 222 | 222 | |
| 223 | - $lastSeen[$id] = $this->getHtml( $id ); |
|
| 224 | - $lastSeen = array_slice( $lastSeen, -$max, $max, true ); |
|
| 223 | + $lastSeen[$id] = $this->getHtml($id); |
|
| 224 | + $lastSeen = array_slice($lastSeen, -$max, $max, true); |
|
| 225 | 225 | } |
| 226 | 226 | |
| 227 | - $session->set( 'aimeos/catalog/session/seen/list', $lastSeen ); |
|
| 227 | + $session->set('aimeos/catalog/session/seen/list', $lastSeen); |
|
| 228 | 228 | |
| 229 | - foreach( $session->get( 'aimeos/catalog/session/seen/cache', array() ) as $key => $value ) { |
|
| 230 | - $session->set( $key, null ); |
|
| 229 | + foreach ($session->get('aimeos/catalog/session/seen/cache', array()) as $key => $value) { |
|
| 230 | + $session->set($key, null); |
|
| 231 | 231 | } |
| 232 | 232 | } |
| 233 | 233 | |
@@ -241,21 +241,21 @@ discard block |
||
| 241 | 241 | * @param string $id Product ID |
| 242 | 242 | * @return string HTML of the last seen item for the given product ID |
| 243 | 243 | */ |
| 244 | - protected function getHtml( $id ) |
|
| 244 | + protected function getHtml($id) |
|
| 245 | 245 | { |
| 246 | 246 | $context = $this->getContext(); |
| 247 | 247 | $cache = $context->getCache(); |
| 248 | - $key = md5( $id . 'product:detail-seen' ); |
|
| 248 | + $key = md5($id.'product:detail-seen'); |
|
| 249 | 249 | |
| 250 | - if( ( $html = $cache->get( $key ) ) === null ) |
|
| 250 | + if (($html = $cache->get($key)) === null) |
|
| 251 | 251 | { |
| 252 | 252 | $expire = null; |
| 253 | 253 | $tags = array(); |
| 254 | 254 | $view = $this->getView(); |
| 255 | 255 | $config = $context->getConfig(); |
| 256 | 256 | |
| 257 | - $default = array( 'media', 'price', 'text' ); |
|
| 258 | - $domains = $config->get( 'client/html/catalog/domains', $default ); |
|
| 257 | + $default = array('media', 'price', 'text'); |
|
| 258 | + $domains = $config->get('client/html/catalog/domains', $default); |
|
| 259 | 259 | |
| 260 | 260 | /** client/html/catalog/detail/seen/domains |
| 261 | 261 | * A list of domain names whose items should be available in the last seen view template for the product |
@@ -275,16 +275,16 @@ discard block |
||
| 275 | 275 | * @see client/html/catalog/lists/domains |
| 276 | 276 | * @see client/html/catalog/detail/domains |
| 277 | 277 | */ |
| 278 | - $domains = $config->get( 'client/html/catalog/detail/seen/domains', $domains ); |
|
| 278 | + $domains = $config->get('client/html/catalog/detail/seen/domains', $domains); |
|
| 279 | 279 | |
| 280 | - $view->seenProductItem = \Aimeos\MShop\Factory::createManager( $context, 'product' )->getItem( $id, $domains ); |
|
| 280 | + $view->seenProductItem = \Aimeos\MShop\Factory::createManager($context, 'product')->getItem($id, $domains); |
|
| 281 | 281 | |
| 282 | - $this->addMetaItem( $view->seenProductItem, 'product', $expire, $tags ); |
|
| 283 | - $this->addMetaList( $view->seenProductItem->getId(), 'product', $expire ); |
|
| 282 | + $this->addMetaItem($view->seenProductItem, 'product', $expire, $tags); |
|
| 283 | + $this->addMetaList($view->seenProductItem->getId(), 'product', $expire); |
|
| 284 | 284 | |
| 285 | 285 | $output = ''; |
| 286 | - foreach( $this->getSubClients() as $subclient ) { |
|
| 287 | - $output .= $subclient->setView( $view )->getBody( '', $tags, $expire ); |
|
| 286 | + foreach ($this->getSubClients() as $subclient) { |
|
| 287 | + $output .= $subclient->setView($view)->getBody('', $tags, $expire); |
|
| 288 | 288 | } |
| 289 | 289 | $view->seenBody = $output; |
| 290 | 290 | |
@@ -311,9 +311,9 @@ discard block |
||
| 311 | 311 | $tplconf = 'client/html/catalog/detail/seen/standard/template-body'; |
| 312 | 312 | $default = 'catalog/detail/seen-body-default.php'; |
| 313 | 313 | |
| 314 | - $html = $view->render( $view->config( $tplconf, $default ) ); |
|
| 314 | + $html = $view->render($view->config($tplconf, $default)); |
|
| 315 | 315 | |
| 316 | - $cache->set( $key, $html, $tags, $expire ); |
|
| 316 | + $cache->set($key, $html, $tags, $expire); |
|
| 317 | 317 | } |
| 318 | 318 | |
| 319 | 319 | return $html; |
@@ -110,7 +110,7 @@ |
||
| 110 | 110 | * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
| 111 | 111 | * @param array &$tags Result array for the list of tags that are associated to the output |
| 112 | 112 | * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
| 113 | - * @return string|null String including HTML tags for the header on error |
|
| 113 | + * @return string String including HTML tags for the header on error |
|
| 114 | 114 | */ |
| 115 | 115 | public function getHeader( $uid = '', array &$tags = array(), &$expire = null ) |
| 116 | 116 | { |
@@ -341,8 +341,7 @@ |
||
| 341 | 341 | } |
| 342 | 342 | |
| 343 | 343 | $attrMap = $sortedMap; |
| 344 | - } |
|
| 345 | - else |
|
| 344 | + } else |
|
| 346 | 345 | { |
| 347 | 346 | ksort( $attrMap ); |
| 348 | 347 | } |
@@ -19,448 +19,448 @@ |
||
| 19 | 19 | * @subpackage Html |
| 20 | 20 | */ |
| 21 | 21 | abstract class Base |
| 22 | - extends \Aimeos\Client\Html\Common\Client\Factory\Base |
|
| 22 | + extends \Aimeos\Client\Html\Common\Client\Factory\Base |
|
| 23 | 23 | { |
| 24 | - private $controller; |
|
| 25 | - private $productList; |
|
| 26 | - private $productTotal = 0; |
|
| 27 | - |
|
| 28 | - |
|
| 29 | - /** |
|
| 30 | - * Adds the conditions for the selected attributes to the given search filter. |
|
| 31 | - * |
|
| 32 | - * @param array $params Associative list of parameters that should be used for filtering |
|
| 33 | - * @param \Aimeos\MW\Criteria\Iface $filter Criteria object for searching |
|
| 34 | - */ |
|
| 35 | - protected function addAttributeFilterByParam( array $params, \Aimeos\MW\Criteria\Iface $filter ) |
|
| 36 | - { |
|
| 37 | - $attrids = ( isset( $params['f_attrid'] ) ? (array) $params['f_attrid'] : array() ); |
|
| 38 | - |
|
| 39 | - if( !empty( $attrids ) ) |
|
| 40 | - { |
|
| 41 | - $func = $filter->createFunction( 'index.attributeaggregate', array( array_keys( $attrids ) ) ); |
|
| 42 | - $expr = array( |
|
| 43 | - $filter->getConditions(), |
|
| 44 | - $filter->compare( '==', $func, count( $attrids ) ), |
|
| 45 | - ); |
|
| 46 | - $filter->setConditions( $filter->combine( '&&', $expr ) ); |
|
| 47 | - } |
|
| 48 | - } |
|
| 49 | - |
|
| 50 | - |
|
| 51 | - /** |
|
| 52 | - * Adds the conditions for the selected attributes to the given search filter. |
|
| 53 | - * |
|
| 54 | - * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters |
|
| 55 | - * @param \Aimeos\MW\Criteria\Iface $filter Criteria object for searching |
|
| 56 | - */ |
|
| 57 | - protected function addAttributeFilter( \Aimeos\MW\View\Iface $view, \Aimeos\MW\Criteria\Iface $filter ) |
|
| 58 | - { |
|
| 59 | - $this->addAttributeFilterByParam( $view->param(), $filter ); |
|
| 60 | - } |
|
| 61 | - |
|
| 62 | - |
|
| 63 | - /** |
|
| 64 | - * Creates the filter from the given parameters for the product list. |
|
| 65 | - * |
|
| 66 | - * @param string $text Text to search for |
|
| 67 | - * @param string $catid Category ID to search for |
|
| 68 | - * @param string $sort Sortation string (relevance, name, price) |
|
| 69 | - * @param string $sortdir Sortation direction (+ or -) |
|
| 70 | - * @param integer $page Page number starting from 1 |
|
| 71 | - * @param integer $size Page size |
|
| 72 | - * @param boolean $catfilter True to include catalog criteria in product filter, false if not |
|
| 73 | - * @param boolean $textfilter True to include text criteria in product filter, false if not |
|
| 74 | - * @return \Aimeos\MW\Criteria\Iface Search criteria object |
|
| 75 | - */ |
|
| 76 | - protected function createProductListFilter( $text, $catid, $sort, $sortdir, $page, $size, $catfilter, $textfilter ) |
|
| 77 | - { |
|
| 78 | - $controller = $this->getCatalogController(); |
|
| 79 | - |
|
| 80 | - if( $text !== '' && $textfilter === true ) |
|
| 81 | - { |
|
| 82 | - $filter = $controller->createIndexFilterText( $text, $sort, $sortdir, ( $page - 1 ) * $size, $size ); |
|
| 83 | - |
|
| 84 | - if( $catid !== '' && $catfilter === true ) { |
|
| 85 | - $filter = $controller->addIndexFilterCategory( $filter, $this->getCatalogIds( $catid ) ); |
|
| 86 | - } |
|
| 87 | - |
|
| 88 | - return $filter; |
|
| 89 | - } |
|
| 90 | - elseif( $catid !== '' && $catfilter === true ) |
|
| 91 | - { |
|
| 92 | - $catIds = $this->getCatalogIds( $catid ); |
|
| 93 | - return $controller->createIndexFilterCategory( $catIds, $sort, $sortdir, ( $page - 1 ) * $size, $size ); |
|
| 94 | - } |
|
| 95 | - else |
|
| 96 | - { |
|
| 97 | - return $controller->createIndexFilter( $sort, $sortdir, ( $page - 1 ) * $size, $size ); |
|
| 98 | - } |
|
| 99 | - } |
|
| 100 | - |
|
| 101 | - |
|
| 102 | - /** |
|
| 103 | - * Returns the catalog controller object |
|
| 104 | - * |
|
| 105 | - * @return \Aimeos\Controller\Frontend\Catalog\Interface Catalog controller |
|
| 106 | - */ |
|
| 107 | - protected function getCatalogController() |
|
| 108 | - { |
|
| 109 | - if( !isset( $this->controller ) ) |
|
| 110 | - { |
|
| 111 | - $context = $this->getContext(); |
|
| 112 | - $this->controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' ); |
|
| 113 | - } |
|
| 114 | - |
|
| 115 | - return $this->controller; |
|
| 116 | - } |
|
| 117 | - |
|
| 118 | - |
|
| 119 | - /** |
|
| 120 | - * Returns the list of catetory IDs if subcategories should be included |
|
| 121 | - * |
|
| 122 | - * @param string $catId Category ID |
|
| 123 | - * @return string|array Cateogory ID or list of catetory IDs |
|
| 124 | - */ |
|
| 125 | - protected function getCatalogIds( $catId ) |
|
| 126 | - { |
|
| 127 | - $config = $this->getContext()->getConfig(); |
|
| 128 | - $default = \Aimeos\MW\Tree\Manager\Base::LEVEL_ONE; |
|
| 129 | - |
|
| 130 | - /** client/html/catalog/lists/levels |
|
| 131 | - * Include products of sub-categories in the product list of the current category |
|
| 132 | - * |
|
| 133 | - * Sometimes it may be useful to show products of sub-categories in the |
|
| 134 | - * current category product list, e.g. if the current category contains |
|
| 135 | - * no products at all or if there are only a few products in all categories. |
|
| 136 | - * |
|
| 137 | - * Possible constant values for this setting are: |
|
| 138 | - * * 1 : Only products from the current category |
|
| 139 | - * * 2 : Products from the current category and the direct child categories |
|
| 140 | - * * 3 : Products from the current category and the whole category sub-tree |
|
| 141 | - * |
|
| 142 | - * Caution: Please keep in mind that displaying products of sub-categories |
|
| 143 | - * can slow down your shop, especially if it contains more than a few |
|
| 144 | - * products! You have no real control over the positions of the products |
|
| 145 | - * in the result list too because all products from different categories |
|
| 146 | - * with the same position value are placed randomly. |
|
| 147 | - * |
|
| 148 | - * Usually, a better way is to associate products to all categories they |
|
| 149 | - * should be listed in. This can be done manually if there are only a few |
|
| 150 | - * ones or during the product import automatically. |
|
| 151 | - * |
|
| 152 | - * @param integer Tree level constant |
|
| 153 | - * @since 2015.11 |
|
| 154 | - * @category Developer |
|
| 155 | - * @see client/html/catalog/lists/catid-default |
|
| 156 | - * @see client/html/catalog/lists/domains |
|
| 157 | - * @see client/html/catalog/lists/size |
|
| 158 | - */ |
|
| 159 | - $level = $config->get( 'client/html/catalog/lists/levels', $default ); |
|
| 160 | - |
|
| 161 | - if( $level != $default ) |
|
| 162 | - { |
|
| 163 | - $tree = $this->getCatalogController()->getCatalogTree( $catId, array(), $level ); |
|
| 164 | - $catId = $this->getCatalogIdsFromTree( $tree ); |
|
| 165 | - } |
|
| 166 | - |
|
| 167 | - return $catId; |
|
| 168 | - } |
|
| 169 | - |
|
| 170 | - |
|
| 171 | - /** |
|
| 172 | - * Returns the list of catalog IDs for the given catalog tree |
|
| 173 | - * |
|
| 174 | - * @param \Aimeos\MShop\Catalog\Item\Iface $item Catalog item with children |
|
| 175 | - * @return array List of catalog IDs |
|
| 176 | - */ |
|
| 177 | - protected function getCatalogIdsFromTree( \Aimeos\MShop\Catalog\Item\Iface $item ) |
|
| 178 | - { |
|
| 179 | - $list = array( $item->getId() ); |
|
| 180 | - |
|
| 181 | - foreach( $item->getChildren() as $child ) { |
|
| 182 | - $list = array_merge( $list, $this->getCatalogIdsFromTree( $child ) ); |
|
| 183 | - } |
|
| 184 | - |
|
| 185 | - return $list; |
|
| 186 | - } |
|
| 187 | - |
|
| 188 | - |
|
| 189 | - /** |
|
| 190 | - * Returns the products found for the current parameters. |
|
| 191 | - * |
|
| 192 | - * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters |
|
| 193 | - * @return array List of products implementing \Aimeos\MShop\Product\Item\Iface |
|
| 194 | - */ |
|
| 195 | - protected function getProductList( \Aimeos\MW\View\Iface $view ) |
|
| 196 | - { |
|
| 197 | - if( $this->productList === null ) { |
|
| 198 | - $this->searchProducts( $view ); |
|
| 199 | - } |
|
| 200 | - |
|
| 201 | - return $this->productList; |
|
| 202 | - } |
|
| 203 | - |
|
| 204 | - |
|
| 205 | - /** |
|
| 206 | - * Returns the filter from the given parameters for the product list. |
|
| 207 | - * |
|
| 208 | - * @param array $params Associative list of parameters that should be used for filtering |
|
| 209 | - * @param boolean $catfilter True to include catalog criteria in product filter, false if not |
|
| 210 | - * @param boolean $textfilter True to include text criteria in product filter, false if not |
|
| 211 | - * @param boolean $attrfilter True to include attribute criteria in product filter, false if not |
|
| 212 | - * @return \Aimeos\MW\Criteria\Iface Search criteria object |
|
| 213 | - */ |
|
| 214 | - protected function getProductListFilterByParam( array $params, $catfilter = true, $textfilter = true, $attrfilter = true ) |
|
| 215 | - { |
|
| 216 | - $sortdir = '+'; |
|
| 217 | - $context = $this->getContext(); |
|
| 218 | - $config = $context->getConfig(); |
|
| 219 | - |
|
| 220 | - $text = ( isset( $params['f_search'] ) ? (string) $params['f_search'] : '' ); |
|
| 221 | - $catid = ( isset( $params['f_catid'] ) ? (string) $params['f_catid'] : '' ); |
|
| 222 | - |
|
| 223 | - if( $catid == '' && $catfilter === true ) |
|
| 224 | - { |
|
| 225 | - /** client/html/catalog/lists/catid-default |
|
| 226 | - * The default category ID used if none is given as parameter |
|
| 227 | - * |
|
| 228 | - * If users view a product list page without a category ID in the |
|
| 229 | - * parameter list, the first found products are displayed with a |
|
| 230 | - * random order. You can circumvent this by configuring a default |
|
| 231 | - * category ID that should be used in this case (the ID of the root |
|
| 232 | - * category is best for this). In most cases you can set this value |
|
| 233 | - * via the administration interface of the shop application. |
|
| 234 | - * |
|
| 235 | - * @param string Category ID |
|
| 236 | - * @since 2014.03 |
|
| 237 | - * @category User |
|
| 238 | - * @category Developer |
|
| 239 | - * @see client/html/catalog/lists/size |
|
| 240 | - * @see client/html/catalog/lists/domains |
|
| 241 | - * @see client/html/catalog/lists/levels |
|
| 242 | - * @see client/html/catalog/detail/prodid-default |
|
| 243 | - */ |
|
| 244 | - $catid = $config->get( 'client/html/catalog/lists/catid-default', '' ); |
|
| 245 | - } |
|
| 246 | - |
|
| 247 | - $page = $this->getProductListPageByParam( $params ); |
|
| 248 | - $size = $this->getProductListSizeByParam( $params ); |
|
| 249 | - $sort = $this->getProductListSortByParam( $params, $sortdir ); |
|
| 250 | - |
|
| 251 | - $filter = $this->createProductListFilter( $text, $catid, $sort, $sortdir, $page, $size, $catfilter, $textfilter ); |
|
| 252 | - |
|
| 253 | - if( $attrfilter === true ) { |
|
| 254 | - $this->addAttributeFilterByParam( $params, $filter ); |
|
| 255 | - } |
|
| 256 | - |
|
| 257 | - |
|
| 258 | - return $filter; |
|
| 259 | - } |
|
| 260 | - |
|
| 261 | - |
|
| 262 | - /** |
|
| 263 | - * Returns the filter created from the view parameters for the product list. |
|
| 264 | - * |
|
| 265 | - * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters |
|
| 266 | - * @param boolean $catfilter True to include catalog criteria in product filter, false if not |
|
| 267 | - * @param boolean $textfilter True to include text criteria in product filter, false if not |
|
| 268 | - * @param boolean $attrfilter True to include attribute criteria in product filter, false if not |
|
| 269 | - * @return \Aimeos\MW\Criteria\Iface Search criteria object |
|
| 270 | - */ |
|
| 271 | - protected function getProductListFilter( \Aimeos\MW\View\Iface $view, $catfilter = true, $textfilter = true, $attrfilter = true ) |
|
| 272 | - { |
|
| 273 | - return $this->getProductListFilterByParam( $view->param(), $catfilter, $textfilter, $attrfilter ); |
|
| 274 | - } |
|
| 275 | - |
|
| 276 | - |
|
| 277 | - /** |
|
| 278 | - * Returns the total number of products available for the current parameters. |
|
| 279 | - * |
|
| 280 | - * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters |
|
| 281 | - * @return integer Total number of products |
|
| 282 | - */ |
|
| 283 | - protected function getProductListTotal( \Aimeos\MW\View\Iface $view ) |
|
| 284 | - { |
|
| 285 | - if( $this->productList === null ) { |
|
| 286 | - $this->searchProducts( $view ); |
|
| 287 | - } |
|
| 288 | - |
|
| 289 | - return $this->productTotal; |
|
| 290 | - } |
|
| 291 | - |
|
| 292 | - |
|
| 293 | - /** |
|
| 294 | - * Returns the sanitized page from the parameters for the product list. |
|
| 295 | - * |
|
| 296 | - * @param array $params Associative list of parameters that should be used for filtering |
|
| 297 | - * @return integer Page number starting from 1 |
|
| 298 | - */ |
|
| 299 | - protected function getProductListPageByParam( array $params ) |
|
| 300 | - { |
|
| 301 | - return ( isset( $params['l_page'] ) && $params['l_page'] > 0 ? (int) $params['l_page'] : 1 ); |
|
| 302 | - } |
|
| 303 | - |
|
| 304 | - |
|
| 305 | - /** |
|
| 306 | - * Returns the sanitized page from the parameters for the product list. |
|
| 307 | - * |
|
| 308 | - * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters |
|
| 309 | - * @return integer Page number starting from 1 |
|
| 310 | - */ |
|
| 311 | - protected function getProductListPage( \Aimeos\MW\View\Iface $view ) |
|
| 312 | - { |
|
| 313 | - return $this->getProductListPageByParam( $view->param() ); |
|
| 314 | - } |
|
| 315 | - |
|
| 316 | - |
|
| 317 | - /** |
|
| 318 | - * Returns the sanitized page size from the parameters for the product list. |
|
| 319 | - * |
|
| 320 | - * @param array $params Associative list of parameters that should be used for filtering |
|
| 321 | - * @return integer Page size |
|
| 322 | - */ |
|
| 323 | - protected function getProductListSizeByParam( array $params ) |
|
| 324 | - { |
|
| 325 | - /** client/html/catalog/lists/size |
|
| 326 | - * The number of products shown in a list page |
|
| 327 | - * |
|
| 328 | - * Limits the number of products that is shown in the list pages to the |
|
| 329 | - * given value. If more products are available, the products are split |
|
| 330 | - * into bunches which will be shown on their own list page. The user is |
|
| 331 | - * able to move to the next page (or previous one if it's not the first) |
|
| 332 | - * to display the next (or previous) products. |
|
| 333 | - * |
|
| 334 | - * The value must be an integer number from 1 to 100. Negative values as |
|
| 335 | - * well as values above 100 are not allowed. The value can be overwritten |
|
| 336 | - * per request if the "l_size" parameter is part of the URL. |
|
| 337 | - * |
|
| 338 | - * @param integer Number of products |
|
| 339 | - * @since 2014.03 |
|
| 340 | - * @category User |
|
| 341 | - * @category Developer |
|
| 342 | - * @see client/html/catalog/lists/catid-default |
|
| 343 | - * @see client/html/catalog/lists/domains |
|
| 344 | - * @see client/html/catalog/lists/levels |
|
| 345 | - */ |
|
| 346 | - $defaultSize = $this->getContext()->getConfig()->get( 'client/html/catalog/lists/size', 48 ); |
|
| 347 | - |
|
| 348 | - $size = ( isset( $params['l_size'] ) ? (int) $params['l_size'] : $defaultSize ); |
|
| 349 | - return ( $size < 1 || $size > 100 ? $defaultSize : $size ); |
|
| 350 | - } |
|
| 351 | - |
|
| 352 | - |
|
| 353 | - /** |
|
| 354 | - * Returns the sanitized page size from the parameters for the product list. |
|
| 355 | - * |
|
| 356 | - * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters |
|
| 357 | - * @return integer Page size |
|
| 358 | - */ |
|
| 359 | - protected function getProductListSize( \Aimeos\MW\View\Iface $view ) |
|
| 360 | - { |
|
| 361 | - return $this->getProductListSizeByParam( $view->param() ); |
|
| 362 | - } |
|
| 363 | - |
|
| 364 | - |
|
| 365 | - /** |
|
| 366 | - * Returns the sanitized sortation from the parameters for the product list. |
|
| 367 | - * |
|
| 368 | - * @param array $params Associative list of parameters that should be used for filtering |
|
| 369 | - * @param string &$sortdir Value-result parameter where the sort direction will be stored |
|
| 370 | - * @return string Sortation string (relevance, name, price) |
|
| 371 | - */ |
|
| 372 | - protected function getProductListSortByParam( array $params, &$sortdir ) |
|
| 373 | - { |
|
| 374 | - $sortation = ( isset( $params['f_sort'] ) ? (string) $params['f_sort'] : 'relevance' ); |
|
| 375 | - |
|
| 376 | - $sortdir = ( $sortation[0] === '-' ? '-' : '+' ); |
|
| 377 | - $sort = ltrim( $sortation, '-' ); |
|
| 378 | - |
|
| 379 | - return ( strlen( $sort ) > 0 ? $sort : 'relevance' ); |
|
| 380 | - } |
|
| 381 | - |
|
| 382 | - |
|
| 383 | - /** |
|
| 384 | - * Returns the sanitized sortation from the parameters for the product list. |
|
| 385 | - * |
|
| 386 | - * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters |
|
| 387 | - * @param string &$sortdir Value-result parameter where the sort direction will be stored |
|
| 388 | - * @return string Sortation string (relevance, name, price) |
|
| 389 | - */ |
|
| 390 | - protected function getProductListSort( \Aimeos\MW\View\Iface $view, &$sortdir ) |
|
| 391 | - { |
|
| 392 | - return $this->getProductListSortByParam( $view->param(), $sortdir ); |
|
| 393 | - } |
|
| 394 | - |
|
| 395 | - |
|
| 396 | - /** |
|
| 397 | - * Searches for the products based on the current paramters. |
|
| 398 | - * |
|
| 399 | - * The found products and the total number of available products can be |
|
| 400 | - * retrieved using the getProductList() and getProductTotal() methods. |
|
| 401 | - * |
|
| 402 | - * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters |
|
| 403 | - */ |
|
| 404 | - protected function searchProducts( \Aimeos\MW\View\Iface $view ) |
|
| 405 | - { |
|
| 406 | - $context = $this->getContext(); |
|
| 407 | - $config = $context->getConfig(); |
|
| 408 | - |
|
| 409 | - /** client/html/catalog/domains |
|
| 410 | - * A list of domain names whose items should be available in the catalog view templates |
|
| 411 | - * |
|
| 412 | - * The templates rendering catalog related data usually add the images and |
|
| 413 | - * texts associated to each item. If you want to display additional |
|
| 414 | - * content like the attributes, you can configure your own list of |
|
| 415 | - * domains (attribute, media, price, product, text, etc. are domains) |
|
| 416 | - * whose items are fetched from the storage. Please keep in mind that |
|
| 417 | - * the more domains you add to the configuration, the more time is required |
|
| 418 | - * for fetching the content! |
|
| 419 | - * |
|
| 420 | - * This configuration option can be overwritten by the "client/html/catalog/lists/domains" |
|
| 421 | - * configuration option that allows to configure the domain names of the |
|
| 422 | - * items fetched specifically for all types of product listings. |
|
| 423 | - * |
|
| 424 | - * @param array List of domain names |
|
| 425 | - * @since 2014.03 |
|
| 426 | - * @category Developer |
|
| 427 | - * @see client/html/catalog/lists/domains |
|
| 428 | - * @see client/html/catalog/lists/catid-default |
|
| 429 | - * @see client/html/catalog/lists/size |
|
| 430 | - * @see client/html/catalog/lists/levels |
|
| 431 | - */ |
|
| 432 | - $domains = $config->get( 'client/html/catalog/domains', array( 'media', 'price', 'text' ) ); |
|
| 433 | - |
|
| 434 | - /** client/html/catalog/lists/domains |
|
| 435 | - * A list of domain names whose items should be available in the product list view template |
|
| 436 | - * |
|
| 437 | - * The templates rendering product lists usually add the images, prices |
|
| 438 | - * and texts associated to each product item. If you want to display additional |
|
| 439 | - * content like the product attributes, you can configure your own list of |
|
| 440 | - * domains (attribute, media, price, product, text, etc. are domains) |
|
| 441 | - * whose items are fetched from the storage. Please keep in mind that |
|
| 442 | - * the more domains you add to the configuration, the more time is required |
|
| 443 | - * for fetching the content! |
|
| 444 | - * |
|
| 445 | - * This configuration option overwrites the "client/html/catalog/domains" |
|
| 446 | - * option that allows to configure the domain names of the items fetched |
|
| 447 | - * for all catalog related data. |
|
| 448 | - * |
|
| 449 | - * @param array List of domain names |
|
| 450 | - * @since 2014.03 |
|
| 451 | - * @category Developer |
|
| 452 | - * @see client/html/catalog/domains |
|
| 453 | - * @see client/html/catalog/detail/domains |
|
| 454 | - * @see client/html/catalog/stage/domains |
|
| 455 | - * @see client/html/catalog/lists/catid-default |
|
| 456 | - * @see client/html/catalog/lists/size |
|
| 457 | - * @see client/html/catalog/lists/levels |
|
| 458 | - */ |
|
| 459 | - $domains = $config->get( 'client/html/catalog/lists/domains', $domains ); |
|
| 460 | - |
|
| 461 | - $controller = $this->getCatalogController(); |
|
| 462 | - $productFilter = $this->getProductListFilter( $view ); |
|
| 463 | - |
|
| 464 | - $this->productList = $controller->getIndexItems( $productFilter, $domains, $this->productTotal ); |
|
| 465 | - } |
|
| 24 | + private $controller; |
|
| 25 | + private $productList; |
|
| 26 | + private $productTotal = 0; |
|
| 27 | + |
|
| 28 | + |
|
| 29 | + /** |
|
| 30 | + * Adds the conditions for the selected attributes to the given search filter. |
|
| 31 | + * |
|
| 32 | + * @param array $params Associative list of parameters that should be used for filtering |
|
| 33 | + * @param \Aimeos\MW\Criteria\Iface $filter Criteria object for searching |
|
| 34 | + */ |
|
| 35 | + protected function addAttributeFilterByParam( array $params, \Aimeos\MW\Criteria\Iface $filter ) |
|
| 36 | + { |
|
| 37 | + $attrids = ( isset( $params['f_attrid'] ) ? (array) $params['f_attrid'] : array() ); |
|
| 38 | + |
|
| 39 | + if( !empty( $attrids ) ) |
|
| 40 | + { |
|
| 41 | + $func = $filter->createFunction( 'index.attributeaggregate', array( array_keys( $attrids ) ) ); |
|
| 42 | + $expr = array( |
|
| 43 | + $filter->getConditions(), |
|
| 44 | + $filter->compare( '==', $func, count( $attrids ) ), |
|
| 45 | + ); |
|
| 46 | + $filter->setConditions( $filter->combine( '&&', $expr ) ); |
|
| 47 | + } |
|
| 48 | + } |
|
| 49 | + |
|
| 50 | + |
|
| 51 | + /** |
|
| 52 | + * Adds the conditions for the selected attributes to the given search filter. |
|
| 53 | + * |
|
| 54 | + * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters |
|
| 55 | + * @param \Aimeos\MW\Criteria\Iface $filter Criteria object for searching |
|
| 56 | + */ |
|
| 57 | + protected function addAttributeFilter( \Aimeos\MW\View\Iface $view, \Aimeos\MW\Criteria\Iface $filter ) |
|
| 58 | + { |
|
| 59 | + $this->addAttributeFilterByParam( $view->param(), $filter ); |
|
| 60 | + } |
|
| 61 | + |
|
| 62 | + |
|
| 63 | + /** |
|
| 64 | + * Creates the filter from the given parameters for the product list. |
|
| 65 | + * |
|
| 66 | + * @param string $text Text to search for |
|
| 67 | + * @param string $catid Category ID to search for |
|
| 68 | + * @param string $sort Sortation string (relevance, name, price) |
|
| 69 | + * @param string $sortdir Sortation direction (+ or -) |
|
| 70 | + * @param integer $page Page number starting from 1 |
|
| 71 | + * @param integer $size Page size |
|
| 72 | + * @param boolean $catfilter True to include catalog criteria in product filter, false if not |
|
| 73 | + * @param boolean $textfilter True to include text criteria in product filter, false if not |
|
| 74 | + * @return \Aimeos\MW\Criteria\Iface Search criteria object |
|
| 75 | + */ |
|
| 76 | + protected function createProductListFilter( $text, $catid, $sort, $sortdir, $page, $size, $catfilter, $textfilter ) |
|
| 77 | + { |
|
| 78 | + $controller = $this->getCatalogController(); |
|
| 79 | + |
|
| 80 | + if( $text !== '' && $textfilter === true ) |
|
| 81 | + { |
|
| 82 | + $filter = $controller->createIndexFilterText( $text, $sort, $sortdir, ( $page - 1 ) * $size, $size ); |
|
| 83 | + |
|
| 84 | + if( $catid !== '' && $catfilter === true ) { |
|
| 85 | + $filter = $controller->addIndexFilterCategory( $filter, $this->getCatalogIds( $catid ) ); |
|
| 86 | + } |
|
| 87 | + |
|
| 88 | + return $filter; |
|
| 89 | + } |
|
| 90 | + elseif( $catid !== '' && $catfilter === true ) |
|
| 91 | + { |
|
| 92 | + $catIds = $this->getCatalogIds( $catid ); |
|
| 93 | + return $controller->createIndexFilterCategory( $catIds, $sort, $sortdir, ( $page - 1 ) * $size, $size ); |
|
| 94 | + } |
|
| 95 | + else |
|
| 96 | + { |
|
| 97 | + return $controller->createIndexFilter( $sort, $sortdir, ( $page - 1 ) * $size, $size ); |
|
| 98 | + } |
|
| 99 | + } |
|
| 100 | + |
|
| 101 | + |
|
| 102 | + /** |
|
| 103 | + * Returns the catalog controller object |
|
| 104 | + * |
|
| 105 | + * @return \Aimeos\Controller\Frontend\Catalog\Interface Catalog controller |
|
| 106 | + */ |
|
| 107 | + protected function getCatalogController() |
|
| 108 | + { |
|
| 109 | + if( !isset( $this->controller ) ) |
|
| 110 | + { |
|
| 111 | + $context = $this->getContext(); |
|
| 112 | + $this->controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' ); |
|
| 113 | + } |
|
| 114 | + |
|
| 115 | + return $this->controller; |
|
| 116 | + } |
|
| 117 | + |
|
| 118 | + |
|
| 119 | + /** |
|
| 120 | + * Returns the list of catetory IDs if subcategories should be included |
|
| 121 | + * |
|
| 122 | + * @param string $catId Category ID |
|
| 123 | + * @return string|array Cateogory ID or list of catetory IDs |
|
| 124 | + */ |
|
| 125 | + protected function getCatalogIds( $catId ) |
|
| 126 | + { |
|
| 127 | + $config = $this->getContext()->getConfig(); |
|
| 128 | + $default = \Aimeos\MW\Tree\Manager\Base::LEVEL_ONE; |
|
| 129 | + |
|
| 130 | + /** client/html/catalog/lists/levels |
|
| 131 | + * Include products of sub-categories in the product list of the current category |
|
| 132 | + * |
|
| 133 | + * Sometimes it may be useful to show products of sub-categories in the |
|
| 134 | + * current category product list, e.g. if the current category contains |
|
| 135 | + * no products at all or if there are only a few products in all categories. |
|
| 136 | + * |
|
| 137 | + * Possible constant values for this setting are: |
|
| 138 | + * * 1 : Only products from the current category |
|
| 139 | + * * 2 : Products from the current category and the direct child categories |
|
| 140 | + * * 3 : Products from the current category and the whole category sub-tree |
|
| 141 | + * |
|
| 142 | + * Caution: Please keep in mind that displaying products of sub-categories |
|
| 143 | + * can slow down your shop, especially if it contains more than a few |
|
| 144 | + * products! You have no real control over the positions of the products |
|
| 145 | + * in the result list too because all products from different categories |
|
| 146 | + * with the same position value are placed randomly. |
|
| 147 | + * |
|
| 148 | + * Usually, a better way is to associate products to all categories they |
|
| 149 | + * should be listed in. This can be done manually if there are only a few |
|
| 150 | + * ones or during the product import automatically. |
|
| 151 | + * |
|
| 152 | + * @param integer Tree level constant |
|
| 153 | + * @since 2015.11 |
|
| 154 | + * @category Developer |
|
| 155 | + * @see client/html/catalog/lists/catid-default |
|
| 156 | + * @see client/html/catalog/lists/domains |
|
| 157 | + * @see client/html/catalog/lists/size |
|
| 158 | + */ |
|
| 159 | + $level = $config->get( 'client/html/catalog/lists/levels', $default ); |
|
| 160 | + |
|
| 161 | + if( $level != $default ) |
|
| 162 | + { |
|
| 163 | + $tree = $this->getCatalogController()->getCatalogTree( $catId, array(), $level ); |
|
| 164 | + $catId = $this->getCatalogIdsFromTree( $tree ); |
|
| 165 | + } |
|
| 166 | + |
|
| 167 | + return $catId; |
|
| 168 | + } |
|
| 169 | + |
|
| 170 | + |
|
| 171 | + /** |
|
| 172 | + * Returns the list of catalog IDs for the given catalog tree |
|
| 173 | + * |
|
| 174 | + * @param \Aimeos\MShop\Catalog\Item\Iface $item Catalog item with children |
|
| 175 | + * @return array List of catalog IDs |
|
| 176 | + */ |
|
| 177 | + protected function getCatalogIdsFromTree( \Aimeos\MShop\Catalog\Item\Iface $item ) |
|
| 178 | + { |
|
| 179 | + $list = array( $item->getId() ); |
|
| 180 | + |
|
| 181 | + foreach( $item->getChildren() as $child ) { |
|
| 182 | + $list = array_merge( $list, $this->getCatalogIdsFromTree( $child ) ); |
|
| 183 | + } |
|
| 184 | + |
|
| 185 | + return $list; |
|
| 186 | + } |
|
| 187 | + |
|
| 188 | + |
|
| 189 | + /** |
|
| 190 | + * Returns the products found for the current parameters. |
|
| 191 | + * |
|
| 192 | + * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters |
|
| 193 | + * @return array List of products implementing \Aimeos\MShop\Product\Item\Iface |
|
| 194 | + */ |
|
| 195 | + protected function getProductList( \Aimeos\MW\View\Iface $view ) |
|
| 196 | + { |
|
| 197 | + if( $this->productList === null ) { |
|
| 198 | + $this->searchProducts( $view ); |
|
| 199 | + } |
|
| 200 | + |
|
| 201 | + return $this->productList; |
|
| 202 | + } |
|
| 203 | + |
|
| 204 | + |
|
| 205 | + /** |
|
| 206 | + * Returns the filter from the given parameters for the product list. |
|
| 207 | + * |
|
| 208 | + * @param array $params Associative list of parameters that should be used for filtering |
|
| 209 | + * @param boolean $catfilter True to include catalog criteria in product filter, false if not |
|
| 210 | + * @param boolean $textfilter True to include text criteria in product filter, false if not |
|
| 211 | + * @param boolean $attrfilter True to include attribute criteria in product filter, false if not |
|
| 212 | + * @return \Aimeos\MW\Criteria\Iface Search criteria object |
|
| 213 | + */ |
|
| 214 | + protected function getProductListFilterByParam( array $params, $catfilter = true, $textfilter = true, $attrfilter = true ) |
|
| 215 | + { |
|
| 216 | + $sortdir = '+'; |
|
| 217 | + $context = $this->getContext(); |
|
| 218 | + $config = $context->getConfig(); |
|
| 219 | + |
|
| 220 | + $text = ( isset( $params['f_search'] ) ? (string) $params['f_search'] : '' ); |
|
| 221 | + $catid = ( isset( $params['f_catid'] ) ? (string) $params['f_catid'] : '' ); |
|
| 222 | + |
|
| 223 | + if( $catid == '' && $catfilter === true ) |
|
| 224 | + { |
|
| 225 | + /** client/html/catalog/lists/catid-default |
|
| 226 | + * The default category ID used if none is given as parameter |
|
| 227 | + * |
|
| 228 | + * If users view a product list page without a category ID in the |
|
| 229 | + * parameter list, the first found products are displayed with a |
|
| 230 | + * random order. You can circumvent this by configuring a default |
|
| 231 | + * category ID that should be used in this case (the ID of the root |
|
| 232 | + * category is best for this). In most cases you can set this value |
|
| 233 | + * via the administration interface of the shop application. |
|
| 234 | + * |
|
| 235 | + * @param string Category ID |
|
| 236 | + * @since 2014.03 |
|
| 237 | + * @category User |
|
| 238 | + * @category Developer |
|
| 239 | + * @see client/html/catalog/lists/size |
|
| 240 | + * @see client/html/catalog/lists/domains |
|
| 241 | + * @see client/html/catalog/lists/levels |
|
| 242 | + * @see client/html/catalog/detail/prodid-default |
|
| 243 | + */ |
|
| 244 | + $catid = $config->get( 'client/html/catalog/lists/catid-default', '' ); |
|
| 245 | + } |
|
| 246 | + |
|
| 247 | + $page = $this->getProductListPageByParam( $params ); |
|
| 248 | + $size = $this->getProductListSizeByParam( $params ); |
|
| 249 | + $sort = $this->getProductListSortByParam( $params, $sortdir ); |
|
| 250 | + |
|
| 251 | + $filter = $this->createProductListFilter( $text, $catid, $sort, $sortdir, $page, $size, $catfilter, $textfilter ); |
|
| 252 | + |
|
| 253 | + if( $attrfilter === true ) { |
|
| 254 | + $this->addAttributeFilterByParam( $params, $filter ); |
|
| 255 | + } |
|
| 256 | + |
|
| 257 | + |
|
| 258 | + return $filter; |
|
| 259 | + } |
|
| 260 | + |
|
| 261 | + |
|
| 262 | + /** |
|
| 263 | + * Returns the filter created from the view parameters for the product list. |
|
| 264 | + * |
|
| 265 | + * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters |
|
| 266 | + * @param boolean $catfilter True to include catalog criteria in product filter, false if not |
|
| 267 | + * @param boolean $textfilter True to include text criteria in product filter, false if not |
|
| 268 | + * @param boolean $attrfilter True to include attribute criteria in product filter, false if not |
|
| 269 | + * @return \Aimeos\MW\Criteria\Iface Search criteria object |
|
| 270 | + */ |
|
| 271 | + protected function getProductListFilter( \Aimeos\MW\View\Iface $view, $catfilter = true, $textfilter = true, $attrfilter = true ) |
|
| 272 | + { |
|
| 273 | + return $this->getProductListFilterByParam( $view->param(), $catfilter, $textfilter, $attrfilter ); |
|
| 274 | + } |
|
| 275 | + |
|
| 276 | + |
|
| 277 | + /** |
|
| 278 | + * Returns the total number of products available for the current parameters. |
|
| 279 | + * |
|
| 280 | + * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters |
|
| 281 | + * @return integer Total number of products |
|
| 282 | + */ |
|
| 283 | + protected function getProductListTotal( \Aimeos\MW\View\Iface $view ) |
|
| 284 | + { |
|
| 285 | + if( $this->productList === null ) { |
|
| 286 | + $this->searchProducts( $view ); |
|
| 287 | + } |
|
| 288 | + |
|
| 289 | + return $this->productTotal; |
|
| 290 | + } |
|
| 291 | + |
|
| 292 | + |
|
| 293 | + /** |
|
| 294 | + * Returns the sanitized page from the parameters for the product list. |
|
| 295 | + * |
|
| 296 | + * @param array $params Associative list of parameters that should be used for filtering |
|
| 297 | + * @return integer Page number starting from 1 |
|
| 298 | + */ |
|
| 299 | + protected function getProductListPageByParam( array $params ) |
|
| 300 | + { |
|
| 301 | + return ( isset( $params['l_page'] ) && $params['l_page'] > 0 ? (int) $params['l_page'] : 1 ); |
|
| 302 | + } |
|
| 303 | + |
|
| 304 | + |
|
| 305 | + /** |
|
| 306 | + * Returns the sanitized page from the parameters for the product list. |
|
| 307 | + * |
|
| 308 | + * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters |
|
| 309 | + * @return integer Page number starting from 1 |
|
| 310 | + */ |
|
| 311 | + protected function getProductListPage( \Aimeos\MW\View\Iface $view ) |
|
| 312 | + { |
|
| 313 | + return $this->getProductListPageByParam( $view->param() ); |
|
| 314 | + } |
|
| 315 | + |
|
| 316 | + |
|
| 317 | + /** |
|
| 318 | + * Returns the sanitized page size from the parameters for the product list. |
|
| 319 | + * |
|
| 320 | + * @param array $params Associative list of parameters that should be used for filtering |
|
| 321 | + * @return integer Page size |
|
| 322 | + */ |
|
| 323 | + protected function getProductListSizeByParam( array $params ) |
|
| 324 | + { |
|
| 325 | + /** client/html/catalog/lists/size |
|
| 326 | + * The number of products shown in a list page |
|
| 327 | + * |
|
| 328 | + * Limits the number of products that is shown in the list pages to the |
|
| 329 | + * given value. If more products are available, the products are split |
|
| 330 | + * into bunches which will be shown on their own list page. The user is |
|
| 331 | + * able to move to the next page (or previous one if it's not the first) |
|
| 332 | + * to display the next (or previous) products. |
|
| 333 | + * |
|
| 334 | + * The value must be an integer number from 1 to 100. Negative values as |
|
| 335 | + * well as values above 100 are not allowed. The value can be overwritten |
|
| 336 | + * per request if the "l_size" parameter is part of the URL. |
|
| 337 | + * |
|
| 338 | + * @param integer Number of products |
|
| 339 | + * @since 2014.03 |
|
| 340 | + * @category User |
|
| 341 | + * @category Developer |
|
| 342 | + * @see client/html/catalog/lists/catid-default |
|
| 343 | + * @see client/html/catalog/lists/domains |
|
| 344 | + * @see client/html/catalog/lists/levels |
|
| 345 | + */ |
|
| 346 | + $defaultSize = $this->getContext()->getConfig()->get( 'client/html/catalog/lists/size', 48 ); |
|
| 347 | + |
|
| 348 | + $size = ( isset( $params['l_size'] ) ? (int) $params['l_size'] : $defaultSize ); |
|
| 349 | + return ( $size < 1 || $size > 100 ? $defaultSize : $size ); |
|
| 350 | + } |
|
| 351 | + |
|
| 352 | + |
|
| 353 | + /** |
|
| 354 | + * Returns the sanitized page size from the parameters for the product list. |
|
| 355 | + * |
|
| 356 | + * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters |
|
| 357 | + * @return integer Page size |
|
| 358 | + */ |
|
| 359 | + protected function getProductListSize( \Aimeos\MW\View\Iface $view ) |
|
| 360 | + { |
|
| 361 | + return $this->getProductListSizeByParam( $view->param() ); |
|
| 362 | + } |
|
| 363 | + |
|
| 364 | + |
|
| 365 | + /** |
|
| 366 | + * Returns the sanitized sortation from the parameters for the product list. |
|
| 367 | + * |
|
| 368 | + * @param array $params Associative list of parameters that should be used for filtering |
|
| 369 | + * @param string &$sortdir Value-result parameter where the sort direction will be stored |
|
| 370 | + * @return string Sortation string (relevance, name, price) |
|
| 371 | + */ |
|
| 372 | + protected function getProductListSortByParam( array $params, &$sortdir ) |
|
| 373 | + { |
|
| 374 | + $sortation = ( isset( $params['f_sort'] ) ? (string) $params['f_sort'] : 'relevance' ); |
|
| 375 | + |
|
| 376 | + $sortdir = ( $sortation[0] === '-' ? '-' : '+' ); |
|
| 377 | + $sort = ltrim( $sortation, '-' ); |
|
| 378 | + |
|
| 379 | + return ( strlen( $sort ) > 0 ? $sort : 'relevance' ); |
|
| 380 | + } |
|
| 381 | + |
|
| 382 | + |
|
| 383 | + /** |
|
| 384 | + * Returns the sanitized sortation from the parameters for the product list. |
|
| 385 | + * |
|
| 386 | + * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters |
|
| 387 | + * @param string &$sortdir Value-result parameter where the sort direction will be stored |
|
| 388 | + * @return string Sortation string (relevance, name, price) |
|
| 389 | + */ |
|
| 390 | + protected function getProductListSort( \Aimeos\MW\View\Iface $view, &$sortdir ) |
|
| 391 | + { |
|
| 392 | + return $this->getProductListSortByParam( $view->param(), $sortdir ); |
|
| 393 | + } |
|
| 394 | + |
|
| 395 | + |
|
| 396 | + /** |
|
| 397 | + * Searches for the products based on the current paramters. |
|
| 398 | + * |
|
| 399 | + * The found products and the total number of available products can be |
|
| 400 | + * retrieved using the getProductList() and getProductTotal() methods. |
|
| 401 | + * |
|
| 402 | + * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters |
|
| 403 | + */ |
|
| 404 | + protected function searchProducts( \Aimeos\MW\View\Iface $view ) |
|
| 405 | + { |
|
| 406 | + $context = $this->getContext(); |
|
| 407 | + $config = $context->getConfig(); |
|
| 408 | + |
|
| 409 | + /** client/html/catalog/domains |
|
| 410 | + * A list of domain names whose items should be available in the catalog view templates |
|
| 411 | + * |
|
| 412 | + * The templates rendering catalog related data usually add the images and |
|
| 413 | + * texts associated to each item. If you want to display additional |
|
| 414 | + * content like the attributes, you can configure your own list of |
|
| 415 | + * domains (attribute, media, price, product, text, etc. are domains) |
|
| 416 | + * whose items are fetched from the storage. Please keep in mind that |
|
| 417 | + * the more domains you add to the configuration, the more time is required |
|
| 418 | + * for fetching the content! |
|
| 419 | + * |
|
| 420 | + * This configuration option can be overwritten by the "client/html/catalog/lists/domains" |
|
| 421 | + * configuration option that allows to configure the domain names of the |
|
| 422 | + * items fetched specifically for all types of product listings. |
|
| 423 | + * |
|
| 424 | + * @param array List of domain names |
|
| 425 | + * @since 2014.03 |
|
| 426 | + * @category Developer |
|
| 427 | + * @see client/html/catalog/lists/domains |
|
| 428 | + * @see client/html/catalog/lists/catid-default |
|
| 429 | + * @see client/html/catalog/lists/size |
|
| 430 | + * @see client/html/catalog/lists/levels |
|
| 431 | + */ |
|
| 432 | + $domains = $config->get( 'client/html/catalog/domains', array( 'media', 'price', 'text' ) ); |
|
| 433 | + |
|
| 434 | + /** client/html/catalog/lists/domains |
|
| 435 | + * A list of domain names whose items should be available in the product list view template |
|
| 436 | + * |
|
| 437 | + * The templates rendering product lists usually add the images, prices |
|
| 438 | + * and texts associated to each product item. If you want to display additional |
|
| 439 | + * content like the product attributes, you can configure your own list of |
|
| 440 | + * domains (attribute, media, price, product, text, etc. are domains) |
|
| 441 | + * whose items are fetched from the storage. Please keep in mind that |
|
| 442 | + * the more domains you add to the configuration, the more time is required |
|
| 443 | + * for fetching the content! |
|
| 444 | + * |
|
| 445 | + * This configuration option overwrites the "client/html/catalog/domains" |
|
| 446 | + * option that allows to configure the domain names of the items fetched |
|
| 447 | + * for all catalog related data. |
|
| 448 | + * |
|
| 449 | + * @param array List of domain names |
|
| 450 | + * @since 2014.03 |
|
| 451 | + * @category Developer |
|
| 452 | + * @see client/html/catalog/domains |
|
| 453 | + * @see client/html/catalog/detail/domains |
|
| 454 | + * @see client/html/catalog/stage/domains |
|
| 455 | + * @see client/html/catalog/lists/catid-default |
|
| 456 | + * @see client/html/catalog/lists/size |
|
| 457 | + * @see client/html/catalog/lists/levels |
|
| 458 | + */ |
|
| 459 | + $domains = $config->get( 'client/html/catalog/lists/domains', $domains ); |
|
| 460 | + |
|
| 461 | + $controller = $this->getCatalogController(); |
|
| 462 | + $productFilter = $this->getProductListFilter( $view ); |
|
| 463 | + |
|
| 464 | + $this->productList = $controller->getIndexItems( $productFilter, $domains, $this->productTotal ); |
|
| 465 | + } |
|
| 466 | 466 | } |
@@ -32,18 +32,18 @@ discard block |
||
| 32 | 32 | * @param array $params Associative list of parameters that should be used for filtering |
| 33 | 33 | * @param \Aimeos\MW\Criteria\Iface $filter Criteria object for searching |
| 34 | 34 | */ |
| 35 | - protected function addAttributeFilterByParam( array $params, \Aimeos\MW\Criteria\Iface $filter ) |
|
| 35 | + protected function addAttributeFilterByParam(array $params, \Aimeos\MW\Criteria\Iface $filter) |
|
| 36 | 36 | { |
| 37 | - $attrids = ( isset( $params['f_attrid'] ) ? (array) $params['f_attrid'] : array() ); |
|
| 37 | + $attrids = (isset($params['f_attrid']) ? (array) $params['f_attrid'] : array()); |
|
| 38 | 38 | |
| 39 | - if( !empty( $attrids ) ) |
|
| 39 | + if (!empty($attrids)) |
|
| 40 | 40 | { |
| 41 | - $func = $filter->createFunction( 'index.attributeaggregate', array( array_keys( $attrids ) ) ); |
|
| 41 | + $func = $filter->createFunction('index.attributeaggregate', array(array_keys($attrids))); |
|
| 42 | 42 | $expr = array( |
| 43 | 43 | $filter->getConditions(), |
| 44 | - $filter->compare( '==', $func, count( $attrids ) ), |
|
| 44 | + $filter->compare('==', $func, count($attrids)), |
|
| 45 | 45 | ); |
| 46 | - $filter->setConditions( $filter->combine( '&&', $expr ) ); |
|
| 46 | + $filter->setConditions($filter->combine('&&', $expr)); |
|
| 47 | 47 | } |
| 48 | 48 | } |
| 49 | 49 | |
@@ -54,9 +54,9 @@ discard block |
||
| 54 | 54 | * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters |
| 55 | 55 | * @param \Aimeos\MW\Criteria\Iface $filter Criteria object for searching |
| 56 | 56 | */ |
| 57 | - protected function addAttributeFilter( \Aimeos\MW\View\Iface $view, \Aimeos\MW\Criteria\Iface $filter ) |
|
| 57 | + protected function addAttributeFilter(\Aimeos\MW\View\Iface $view, \Aimeos\MW\Criteria\Iface $filter) |
|
| 58 | 58 | { |
| 59 | - $this->addAttributeFilterByParam( $view->param(), $filter ); |
|
| 59 | + $this->addAttributeFilterByParam($view->param(), $filter); |
|
| 60 | 60 | } |
| 61 | 61 | |
| 62 | 62 | |
@@ -73,28 +73,28 @@ discard block |
||
| 73 | 73 | * @param boolean $textfilter True to include text criteria in product filter, false if not |
| 74 | 74 | * @return \Aimeos\MW\Criteria\Iface Search criteria object |
| 75 | 75 | */ |
| 76 | - protected function createProductListFilter( $text, $catid, $sort, $sortdir, $page, $size, $catfilter, $textfilter ) |
|
| 76 | + protected function createProductListFilter($text, $catid, $sort, $sortdir, $page, $size, $catfilter, $textfilter) |
|
| 77 | 77 | { |
| 78 | 78 | $controller = $this->getCatalogController(); |
| 79 | 79 | |
| 80 | - if( $text !== '' && $textfilter === true ) |
|
| 80 | + if ($text !== '' && $textfilter === true) |
|
| 81 | 81 | { |
| 82 | - $filter = $controller->createIndexFilterText( $text, $sort, $sortdir, ( $page - 1 ) * $size, $size ); |
|
| 82 | + $filter = $controller->createIndexFilterText($text, $sort, $sortdir, ($page - 1) * $size, $size); |
|
| 83 | 83 | |
| 84 | - if( $catid !== '' && $catfilter === true ) { |
|
| 85 | - $filter = $controller->addIndexFilterCategory( $filter, $this->getCatalogIds( $catid ) ); |
|
| 84 | + if ($catid !== '' && $catfilter === true) { |
|
| 85 | + $filter = $controller->addIndexFilterCategory($filter, $this->getCatalogIds($catid)); |
|
| 86 | 86 | } |
| 87 | 87 | |
| 88 | 88 | return $filter; |
| 89 | 89 | } |
| 90 | - elseif( $catid !== '' && $catfilter === true ) |
|
| 90 | + elseif ($catid !== '' && $catfilter === true) |
|
| 91 | 91 | { |
| 92 | - $catIds = $this->getCatalogIds( $catid ); |
|
| 93 | - return $controller->createIndexFilterCategory( $catIds, $sort, $sortdir, ( $page - 1 ) * $size, $size ); |
|
| 92 | + $catIds = $this->getCatalogIds($catid); |
|
| 93 | + return $controller->createIndexFilterCategory($catIds, $sort, $sortdir, ($page - 1) * $size, $size); |
|
| 94 | 94 | } |
| 95 | 95 | else |
| 96 | 96 | { |
| 97 | - return $controller->createIndexFilter( $sort, $sortdir, ( $page - 1 ) * $size, $size ); |
|
| 97 | + return $controller->createIndexFilter($sort, $sortdir, ($page - 1) * $size, $size); |
|
| 98 | 98 | } |
| 99 | 99 | } |
| 100 | 100 | |
@@ -106,10 +106,10 @@ discard block |
||
| 106 | 106 | */ |
| 107 | 107 | protected function getCatalogController() |
| 108 | 108 | { |
| 109 | - if( !isset( $this->controller ) ) |
|
| 109 | + if (!isset($this->controller)) |
|
| 110 | 110 | { |
| 111 | 111 | $context = $this->getContext(); |
| 112 | - $this->controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' ); |
|
| 112 | + $this->controller = \Aimeos\Controller\Frontend\Factory::createController($context, 'catalog'); |
|
| 113 | 113 | } |
| 114 | 114 | |
| 115 | 115 | return $this->controller; |
@@ -122,7 +122,7 @@ discard block |
||
| 122 | 122 | * @param string $catId Category ID |
| 123 | 123 | * @return string|array Cateogory ID or list of catetory IDs |
| 124 | 124 | */ |
| 125 | - protected function getCatalogIds( $catId ) |
|
| 125 | + protected function getCatalogIds($catId) |
|
| 126 | 126 | { |
| 127 | 127 | $config = $this->getContext()->getConfig(); |
| 128 | 128 | $default = \Aimeos\MW\Tree\Manager\Base::LEVEL_ONE; |
@@ -156,12 +156,12 @@ discard block |
||
| 156 | 156 | * @see client/html/catalog/lists/domains |
| 157 | 157 | * @see client/html/catalog/lists/size |
| 158 | 158 | */ |
| 159 | - $level = $config->get( 'client/html/catalog/lists/levels', $default ); |
|
| 159 | + $level = $config->get('client/html/catalog/lists/levels', $default); |
|
| 160 | 160 | |
| 161 | - if( $level != $default ) |
|
| 161 | + if ($level != $default) |
|
| 162 | 162 | { |
| 163 | - $tree = $this->getCatalogController()->getCatalogTree( $catId, array(), $level ); |
|
| 164 | - $catId = $this->getCatalogIdsFromTree( $tree ); |
|
| 163 | + $tree = $this->getCatalogController()->getCatalogTree($catId, array(), $level); |
|
| 164 | + $catId = $this->getCatalogIdsFromTree($tree); |
|
| 165 | 165 | } |
| 166 | 166 | |
| 167 | 167 | return $catId; |
@@ -174,12 +174,12 @@ discard block |
||
| 174 | 174 | * @param \Aimeos\MShop\Catalog\Item\Iface $item Catalog item with children |
| 175 | 175 | * @return array List of catalog IDs |
| 176 | 176 | */ |
| 177 | - protected function getCatalogIdsFromTree( \Aimeos\MShop\Catalog\Item\Iface $item ) |
|
| 177 | + protected function getCatalogIdsFromTree(\Aimeos\MShop\Catalog\Item\Iface $item) |
|
| 178 | 178 | { |
| 179 | - $list = array( $item->getId() ); |
|
| 179 | + $list = array($item->getId()); |
|
| 180 | 180 | |
| 181 | - foreach( $item->getChildren() as $child ) { |
|
| 182 | - $list = array_merge( $list, $this->getCatalogIdsFromTree( $child ) ); |
|
| 181 | + foreach ($item->getChildren() as $child) { |
|
| 182 | + $list = array_merge($list, $this->getCatalogIdsFromTree($child)); |
|
| 183 | 183 | } |
| 184 | 184 | |
| 185 | 185 | return $list; |
@@ -192,10 +192,10 @@ discard block |
||
| 192 | 192 | * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters |
| 193 | 193 | * @return array List of products implementing \Aimeos\MShop\Product\Item\Iface |
| 194 | 194 | */ |
| 195 | - protected function getProductList( \Aimeos\MW\View\Iface $view ) |
|
| 195 | + protected function getProductList(\Aimeos\MW\View\Iface $view) |
|
| 196 | 196 | { |
| 197 | - if( $this->productList === null ) { |
|
| 198 | - $this->searchProducts( $view ); |
|
| 197 | + if ($this->productList === null) { |
|
| 198 | + $this->searchProducts($view); |
|
| 199 | 199 | } |
| 200 | 200 | |
| 201 | 201 | return $this->productList; |
@@ -211,16 +211,16 @@ discard block |
||
| 211 | 211 | * @param boolean $attrfilter True to include attribute criteria in product filter, false if not |
| 212 | 212 | * @return \Aimeos\MW\Criteria\Iface Search criteria object |
| 213 | 213 | */ |
| 214 | - protected function getProductListFilterByParam( array $params, $catfilter = true, $textfilter = true, $attrfilter = true ) |
|
| 214 | + protected function getProductListFilterByParam(array $params, $catfilter = true, $textfilter = true, $attrfilter = true) |
|
| 215 | 215 | { |
| 216 | 216 | $sortdir = '+'; |
| 217 | 217 | $context = $this->getContext(); |
| 218 | 218 | $config = $context->getConfig(); |
| 219 | 219 | |
| 220 | - $text = ( isset( $params['f_search'] ) ? (string) $params['f_search'] : '' ); |
|
| 221 | - $catid = ( isset( $params['f_catid'] ) ? (string) $params['f_catid'] : '' ); |
|
| 220 | + $text = (isset($params['f_search']) ? (string) $params['f_search'] : ''); |
|
| 221 | + $catid = (isset($params['f_catid']) ? (string) $params['f_catid'] : ''); |
|
| 222 | 222 | |
| 223 | - if( $catid == '' && $catfilter === true ) |
|
| 223 | + if ($catid == '' && $catfilter === true) |
|
| 224 | 224 | { |
| 225 | 225 | /** client/html/catalog/lists/catid-default |
| 226 | 226 | * The default category ID used if none is given as parameter |
@@ -241,17 +241,17 @@ discard block |
||
| 241 | 241 | * @see client/html/catalog/lists/levels |
| 242 | 242 | * @see client/html/catalog/detail/prodid-default |
| 243 | 243 | */ |
| 244 | - $catid = $config->get( 'client/html/catalog/lists/catid-default', '' ); |
|
| 244 | + $catid = $config->get('client/html/catalog/lists/catid-default', ''); |
|
| 245 | 245 | } |
| 246 | 246 | |
| 247 | - $page = $this->getProductListPageByParam( $params ); |
|
| 248 | - $size = $this->getProductListSizeByParam( $params ); |
|
| 249 | - $sort = $this->getProductListSortByParam( $params, $sortdir ); |
|
| 247 | + $page = $this->getProductListPageByParam($params); |
|
| 248 | + $size = $this->getProductListSizeByParam($params); |
|
| 249 | + $sort = $this->getProductListSortByParam($params, $sortdir); |
|
| 250 | 250 | |
| 251 | - $filter = $this->createProductListFilter( $text, $catid, $sort, $sortdir, $page, $size, $catfilter, $textfilter ); |
|
| 251 | + $filter = $this->createProductListFilter($text, $catid, $sort, $sortdir, $page, $size, $catfilter, $textfilter); |
|
| 252 | 252 | |
| 253 | - if( $attrfilter === true ) { |
|
| 254 | - $this->addAttributeFilterByParam( $params, $filter ); |
|
| 253 | + if ($attrfilter === true) { |
|
| 254 | + $this->addAttributeFilterByParam($params, $filter); |
|
| 255 | 255 | } |
| 256 | 256 | |
| 257 | 257 | |
@@ -268,9 +268,9 @@ discard block |
||
| 268 | 268 | * @param boolean $attrfilter True to include attribute criteria in product filter, false if not |
| 269 | 269 | * @return \Aimeos\MW\Criteria\Iface Search criteria object |
| 270 | 270 | */ |
| 271 | - protected function getProductListFilter( \Aimeos\MW\View\Iface $view, $catfilter = true, $textfilter = true, $attrfilter = true ) |
|
| 271 | + protected function getProductListFilter(\Aimeos\MW\View\Iface $view, $catfilter = true, $textfilter = true, $attrfilter = true) |
|
| 272 | 272 | { |
| 273 | - return $this->getProductListFilterByParam( $view->param(), $catfilter, $textfilter, $attrfilter ); |
|
| 273 | + return $this->getProductListFilterByParam($view->param(), $catfilter, $textfilter, $attrfilter); |
|
| 274 | 274 | } |
| 275 | 275 | |
| 276 | 276 | |
@@ -280,10 +280,10 @@ discard block |
||
| 280 | 280 | * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters |
| 281 | 281 | * @return integer Total number of products |
| 282 | 282 | */ |
| 283 | - protected function getProductListTotal( \Aimeos\MW\View\Iface $view ) |
|
| 283 | + protected function getProductListTotal(\Aimeos\MW\View\Iface $view) |
|
| 284 | 284 | { |
| 285 | - if( $this->productList === null ) { |
|
| 286 | - $this->searchProducts( $view ); |
|
| 285 | + if ($this->productList === null) { |
|
| 286 | + $this->searchProducts($view); |
|
| 287 | 287 | } |
| 288 | 288 | |
| 289 | 289 | return $this->productTotal; |
@@ -296,9 +296,9 @@ discard block |
||
| 296 | 296 | * @param array $params Associative list of parameters that should be used for filtering |
| 297 | 297 | * @return integer Page number starting from 1 |
| 298 | 298 | */ |
| 299 | - protected function getProductListPageByParam( array $params ) |
|
| 299 | + protected function getProductListPageByParam(array $params) |
|
| 300 | 300 | { |
| 301 | - return ( isset( $params['l_page'] ) && $params['l_page'] > 0 ? (int) $params['l_page'] : 1 ); |
|
| 301 | + return (isset($params['l_page']) && $params['l_page'] > 0 ? (int) $params['l_page'] : 1); |
|
| 302 | 302 | } |
| 303 | 303 | |
| 304 | 304 | |
@@ -308,9 +308,9 @@ discard block |
||
| 308 | 308 | * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters |
| 309 | 309 | * @return integer Page number starting from 1 |
| 310 | 310 | */ |
| 311 | - protected function getProductListPage( \Aimeos\MW\View\Iface $view ) |
|
| 311 | + protected function getProductListPage(\Aimeos\MW\View\Iface $view) |
|
| 312 | 312 | { |
| 313 | - return $this->getProductListPageByParam( $view->param() ); |
|
| 313 | + return $this->getProductListPageByParam($view->param()); |
|
| 314 | 314 | } |
| 315 | 315 | |
| 316 | 316 | |
@@ -320,7 +320,7 @@ discard block |
||
| 320 | 320 | * @param array $params Associative list of parameters that should be used for filtering |
| 321 | 321 | * @return integer Page size |
| 322 | 322 | */ |
| 323 | - protected function getProductListSizeByParam( array $params ) |
|
| 323 | + protected function getProductListSizeByParam(array $params) |
|
| 324 | 324 | { |
| 325 | 325 | /** client/html/catalog/lists/size |
| 326 | 326 | * The number of products shown in a list page |
@@ -343,10 +343,10 @@ discard block |
||
| 343 | 343 | * @see client/html/catalog/lists/domains |
| 344 | 344 | * @see client/html/catalog/lists/levels |
| 345 | 345 | */ |
| 346 | - $defaultSize = $this->getContext()->getConfig()->get( 'client/html/catalog/lists/size', 48 ); |
|
| 346 | + $defaultSize = $this->getContext()->getConfig()->get('client/html/catalog/lists/size', 48); |
|
| 347 | 347 | |
| 348 | - $size = ( isset( $params['l_size'] ) ? (int) $params['l_size'] : $defaultSize ); |
|
| 349 | - return ( $size < 1 || $size > 100 ? $defaultSize : $size ); |
|
| 348 | + $size = (isset($params['l_size']) ? (int) $params['l_size'] : $defaultSize); |
|
| 349 | + return ($size < 1 || $size > 100 ? $defaultSize : $size); |
|
| 350 | 350 | } |
| 351 | 351 | |
| 352 | 352 | |
@@ -356,9 +356,9 @@ discard block |
||
| 356 | 356 | * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters |
| 357 | 357 | * @return integer Page size |
| 358 | 358 | */ |
| 359 | - protected function getProductListSize( \Aimeos\MW\View\Iface $view ) |
|
| 359 | + protected function getProductListSize(\Aimeos\MW\View\Iface $view) |
|
| 360 | 360 | { |
| 361 | - return $this->getProductListSizeByParam( $view->param() ); |
|
| 361 | + return $this->getProductListSizeByParam($view->param()); |
|
| 362 | 362 | } |
| 363 | 363 | |
| 364 | 364 | |
@@ -369,14 +369,14 @@ discard block |
||
| 369 | 369 | * @param string &$sortdir Value-result parameter where the sort direction will be stored |
| 370 | 370 | * @return string Sortation string (relevance, name, price) |
| 371 | 371 | */ |
| 372 | - protected function getProductListSortByParam( array $params, &$sortdir ) |
|
| 372 | + protected function getProductListSortByParam(array $params, &$sortdir) |
|
| 373 | 373 | { |
| 374 | - $sortation = ( isset( $params['f_sort'] ) ? (string) $params['f_sort'] : 'relevance' ); |
|
| 374 | + $sortation = (isset($params['f_sort']) ? (string) $params['f_sort'] : 'relevance'); |
|
| 375 | 375 | |
| 376 | - $sortdir = ( $sortation[0] === '-' ? '-' : '+' ); |
|
| 377 | - $sort = ltrim( $sortation, '-' ); |
|
| 376 | + $sortdir = ($sortation[0] === '-' ? '-' : '+'); |
|
| 377 | + $sort = ltrim($sortation, '-'); |
|
| 378 | 378 | |
| 379 | - return ( strlen( $sort ) > 0 ? $sort : 'relevance' ); |
|
| 379 | + return (strlen($sort) > 0 ? $sort : 'relevance'); |
|
| 380 | 380 | } |
| 381 | 381 | |
| 382 | 382 | |
@@ -387,9 +387,9 @@ discard block |
||
| 387 | 387 | * @param string &$sortdir Value-result parameter where the sort direction will be stored |
| 388 | 388 | * @return string Sortation string (relevance, name, price) |
| 389 | 389 | */ |
| 390 | - protected function getProductListSort( \Aimeos\MW\View\Iface $view, &$sortdir ) |
|
| 390 | + protected function getProductListSort(\Aimeos\MW\View\Iface $view, &$sortdir) |
|
| 391 | 391 | { |
| 392 | - return $this->getProductListSortByParam( $view->param(), $sortdir ); |
|
| 392 | + return $this->getProductListSortByParam($view->param(), $sortdir); |
|
| 393 | 393 | } |
| 394 | 394 | |
| 395 | 395 | |
@@ -401,7 +401,7 @@ discard block |
||
| 401 | 401 | * |
| 402 | 402 | * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters |
| 403 | 403 | */ |
| 404 | - protected function searchProducts( \Aimeos\MW\View\Iface $view ) |
|
| 404 | + protected function searchProducts(\Aimeos\MW\View\Iface $view) |
|
| 405 | 405 | { |
| 406 | 406 | $context = $this->getContext(); |
| 407 | 407 | $config = $context->getConfig(); |
@@ -429,7 +429,7 @@ discard block |
||
| 429 | 429 | * @see client/html/catalog/lists/size |
| 430 | 430 | * @see client/html/catalog/lists/levels |
| 431 | 431 | */ |
| 432 | - $domains = $config->get( 'client/html/catalog/domains', array( 'media', 'price', 'text' ) ); |
|
| 432 | + $domains = $config->get('client/html/catalog/domains', array('media', 'price', 'text')); |
|
| 433 | 433 | |
| 434 | 434 | /** client/html/catalog/lists/domains |
| 435 | 435 | * A list of domain names whose items should be available in the product list view template |
@@ -456,11 +456,11 @@ discard block |
||
| 456 | 456 | * @see client/html/catalog/lists/size |
| 457 | 457 | * @see client/html/catalog/lists/levels |
| 458 | 458 | */ |
| 459 | - $domains = $config->get( 'client/html/catalog/lists/domains', $domains ); |
|
| 459 | + $domains = $config->get('client/html/catalog/lists/domains', $domains); |
|
| 460 | 460 | |
| 461 | 461 | $controller = $this->getCatalogController(); |
| 462 | - $productFilter = $this->getProductListFilter( $view ); |
|
| 462 | + $productFilter = $this->getProductListFilter($view); |
|
| 463 | 463 | |
| 464 | - $this->productList = $controller->getIndexItems( $productFilter, $domains, $this->productTotal ); |
|
| 464 | + $this->productList = $controller->getIndexItems($productFilter, $domains, $this->productTotal); |
|
| 465 | 465 | } |
| 466 | 466 | } |
@@ -86,13 +86,11 @@ |
||
| 86 | 86 | } |
| 87 | 87 | |
| 88 | 88 | return $filter; |
| 89 | - } |
|
| 90 | - elseif( $catid !== '' && $catfilter === true ) |
|
| 89 | + } elseif( $catid !== '' && $catfilter === true ) |
|
| 91 | 90 | { |
| 92 | 91 | $catIds = $this->getCatalogIds( $catid ); |
| 93 | 92 | return $controller->createIndexFilterCategory( $catIds, $sort, $sortdir, ( $page - 1 ) * $size, $size ); |
| 94 | - } |
|
| 95 | - else |
|
| 93 | + } else |
|
| 96 | 94 | { |
| 97 | 95 | return $controller->createIndexFilter( $sort, $sortdir, ( $page - 1 ) * $size, $size ); |
| 98 | 96 | } |
@@ -19,406 +19,406 @@ |
||
| 19 | 19 | * @subpackage Html |
| 20 | 20 | */ |
| 21 | 21 | class Standard |
| 22 | - extends \Aimeos\Client\Html\Common\Client\Factory\Base |
|
| 23 | - implements \Aimeos\Client\Html\Common\Client\Factory\Iface |
|
| 22 | + extends \Aimeos\Client\Html\Common\Client\Factory\Base |
|
| 23 | + implements \Aimeos\Client\Html\Common\Client\Factory\Iface |
|
| 24 | 24 | { |
| 25 | - /** client/html/catalog/session/pinned/standard/subparts |
|
| 26 | - * List of HTML sub-clients rendered within the catalog session pinned section |
|
| 27 | - * |
|
| 28 | - * The output of the frontend is composed of the code generated by the HTML |
|
| 29 | - * clients. Each HTML client can consist of serveral (or none) sub-clients |
|
| 30 | - * that are responsible for rendering certain sub-parts of the output. The |
|
| 31 | - * sub-clients can contain HTML clients themselves and therefore a |
|
| 32 | - * hierarchical tree of HTML clients is composed. Each HTML client creates |
|
| 33 | - * the output that is placed inside the container of its parent. |
|
| 34 | - * |
|
| 35 | - * At first, always the HTML code generated by the parent is printed, then |
|
| 36 | - * the HTML code of its sub-clients. The order of the HTML sub-clients |
|
| 37 | - * determines the order of the output of these sub-clients inside the parent |
|
| 38 | - * container. If the configured list of clients is |
|
| 39 | - * |
|
| 40 | - * array( "subclient1", "subclient2" ) |
|
| 41 | - * |
|
| 42 | - * you can easily change the order of the output by reordering the subparts: |
|
| 43 | - * |
|
| 44 | - * client/html/<clients>/subparts = array( "subclient1", "subclient2" ) |
|
| 45 | - * |
|
| 46 | - * You can also remove one or more parts if they shouldn't be rendered: |
|
| 47 | - * |
|
| 48 | - * client/html/<clients>/subparts = array( "subclient1" ) |
|
| 49 | - * |
|
| 50 | - * As the clients only generates structural HTML, the layout defined via CSS |
|
| 51 | - * should support adding, removing or reordering content by a fluid like |
|
| 52 | - * design. |
|
| 53 | - * |
|
| 54 | - * @param array List of sub-client names |
|
| 55 | - * @since 2014.03 |
|
| 56 | - * @category Developer |
|
| 57 | - */ |
|
| 58 | - private $subPartPath = 'client/html/catalog/session/pinned/standard/subparts'; |
|
| 59 | - private $subPartNames = array(); |
|
| 60 | - private $cache; |
|
| 61 | - |
|
| 62 | - |
|
| 63 | - /** |
|
| 64 | - * Returns the HTML code for insertion into the body. |
|
| 65 | - * |
|
| 66 | - * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
|
| 67 | - * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 68 | - * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 69 | - * @return string HTML code |
|
| 70 | - */ |
|
| 71 | - public function getBody( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 72 | - { |
|
| 73 | - $context = $this->getContext(); |
|
| 74 | - $session = $context->getSession(); |
|
| 75 | - |
|
| 76 | - /** client/html/catalog/session/pinned |
|
| 77 | - * All parameters defined for the catalog session pinned subpart |
|
| 78 | - * |
|
| 79 | - * This returns all settings related to the catalog session pinned subpart. |
|
| 80 | - * Please refer to the single settings for details. |
|
| 81 | - * |
|
| 82 | - * @param array Associative list of name/value settings |
|
| 83 | - * @category Developer |
|
| 84 | - * @see client/html/catalog/session#pinned |
|
| 85 | - */ |
|
| 86 | - $config = $context->getConfig()->get( 'client/html/catalog/session/pinned', array() ); |
|
| 87 | - $key = $this->getParamHash( array(), $uid . ':catalog:session-pinned-body', $config ); |
|
| 88 | - |
|
| 89 | - if( ( $html = $session->get( $key ) ) === null ) |
|
| 90 | - { |
|
| 91 | - $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 92 | - |
|
| 93 | - $output = ''; |
|
| 94 | - foreach( $this->getSubClients() as $subclient ) { |
|
| 95 | - $output .= $subclient->setView( $view )->getBody( $uid, $tags, $expire ); |
|
| 96 | - } |
|
| 97 | - $view->pinnedBody = $output; |
|
| 98 | - |
|
| 99 | - /** client/html/catalog/session/pinned/standard/template-body |
|
| 100 | - * Relative path to the HTML body template of the catalog session pinned client. |
|
| 101 | - * |
|
| 102 | - * The template file contains the HTML code and processing instructions |
|
| 103 | - * to generate the result shown in the body of the frontend. The |
|
| 104 | - * configuration string is the path to the template file relative |
|
| 105 | - * to the templates directory (usually in client/html/templates). |
|
| 106 | - * |
|
| 107 | - * You can overwrite the template file configuration in extensions and |
|
| 108 | - * provide alternative templates. These alternative templates should be |
|
| 109 | - * named like the default one but with the string "standard" replaced by |
|
| 110 | - * an unique name. You may use the name of your project for this. If |
|
| 111 | - * you've implemented an alternative client class as well, "standard" |
|
| 112 | - * should be replaced by the name of the new class. |
|
| 113 | - * |
|
| 114 | - * @param string Relative path to the template creating code for the HTML page body |
|
| 115 | - * @since 2014.03 |
|
| 116 | - * @category Developer |
|
| 117 | - * @see client/html/catalog/session/pinned/standard/template-header |
|
| 118 | - */ |
|
| 119 | - $tplconf = 'client/html/catalog/session/pinned/standard/template-body'; |
|
| 120 | - $default = 'catalog/session/pinned-body-default.php'; |
|
| 121 | - |
|
| 122 | - $html = $view->render( $view->config( $tplconf, $default ) ); |
|
| 123 | - |
|
| 124 | - $cached = $session->get( 'aimeos/catalog/session/pinned/cache', array() ) + array( $key => true ); |
|
| 125 | - $session->set( 'aimeos/catalog/session/pinned/cache', $cached ); |
|
| 126 | - $session->set( $key, $html ); |
|
| 127 | - } |
|
| 128 | - |
|
| 129 | - return $html; |
|
| 130 | - } |
|
| 131 | - |
|
| 132 | - |
|
| 133 | - /** |
|
| 134 | - * Returns the HTML string for insertion into the header. |
|
| 135 | - * |
|
| 136 | - * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
|
| 137 | - * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 138 | - * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 139 | - * @return string|null String including HTML tags for the header on error |
|
| 140 | - */ |
|
| 141 | - public function getHeader( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 142 | - { |
|
| 143 | - $context = $this->getContext(); |
|
| 144 | - $session = $context->getSession(); |
|
| 145 | - |
|
| 146 | - $config = $context->getConfig()->get( 'client/html/catalog/session/pinned', array() ); |
|
| 147 | - $key = $this->getParamHash( array(), $uid . ':catalog:session-pinned-header', $config ); |
|
| 148 | - |
|
| 149 | - if( ( $html = $session->get( $key ) ) === null ) |
|
| 150 | - { |
|
| 151 | - $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 152 | - |
|
| 153 | - $output = ''; |
|
| 154 | - foreach( $this->getSubClients() as $subclient ) { |
|
| 155 | - $output .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire ); |
|
| 156 | - } |
|
| 157 | - $view->pinnedHeader = $output; |
|
| 158 | - |
|
| 159 | - /** client/html/catalog/session/pinned/standard/template-header |
|
| 160 | - * Relative path to the HTML header template of the catalog session pinned client. |
|
| 161 | - * |
|
| 162 | - * The template file contains the HTML code and processing instructions |
|
| 163 | - * to generate the HTML code that is inserted into the HTML page header |
|
| 164 | - * of the rendered page in the frontend. The configuration string is the |
|
| 165 | - * path to the template file relative to the templates directory (usually |
|
| 166 | - * in client/html/templates). |
|
| 167 | - * |
|
| 168 | - * You can overwrite the template file configuration in extensions and |
|
| 169 | - * provide alternative templates. These alternative templates should be |
|
| 170 | - * named like the default one but with the string "standard" replaced by |
|
| 171 | - * an unique name. You may use the name of your project for this. If |
|
| 172 | - * you've implemented an alternative client class as well, "standard" |
|
| 173 | - * should be replaced by the name of the new class. |
|
| 174 | - * |
|
| 175 | - * @param string Relative path to the template creating code for the HTML page head |
|
| 176 | - * @since 2014.03 |
|
| 177 | - * @category Developer |
|
| 178 | - * @see client/html/catalog/session/pinned/standard/template-body |
|
| 179 | - */ |
|
| 180 | - $tplconf = 'client/html/catalog/session/pinned/standard/template-header'; |
|
| 181 | - $default = 'catalog/session/pinned-header-default.php'; |
|
| 182 | - |
|
| 183 | - $html = $view->render( $view->config( $tplconf, $default ) ); |
|
| 184 | - |
|
| 185 | - $cached = $session->get( 'aimeos/catalog/session/pinned/cache', array() ) + array( $key => true ); |
|
| 186 | - $session->set( 'aimeos/catalog/session/pinned/cache', $cached ); |
|
| 187 | - $session->set( $key, $html ); |
|
| 188 | - } |
|
| 189 | - |
|
| 190 | - return $html; |
|
| 191 | - } |
|
| 192 | - |
|
| 193 | - |
|
| 194 | - /** |
|
| 195 | - * Returns the sub-client given by its name. |
|
| 196 | - * |
|
| 197 | - * @param string $type Name of the client type |
|
| 198 | - * @param string|null $name Name of the sub-client (Default if null) |
|
| 199 | - * @return \Aimeos\Client\Html\Iface Sub-client object |
|
| 200 | - */ |
|
| 201 | - public function getSubClient( $type, $name = null ) |
|
| 202 | - { |
|
| 203 | - /** client/html/catalog/session/pinned/decorators/excludes |
|
| 204 | - * Excludes decorators added by the "common" option from the catalog session pinned html client |
|
| 205 | - * |
|
| 206 | - * Decorators extend the functionality of a class by adding new aspects |
|
| 207 | - * (e.g. log what is currently done), executing the methods of the underlying |
|
| 208 | - * class only in certain conditions (e.g. only for logged in users) or |
|
| 209 | - * modify what is returned to the caller. |
|
| 210 | - * |
|
| 211 | - * This option allows you to remove a decorator added via |
|
| 212 | - * "client/html/common/decorators/default" before they are wrapped |
|
| 213 | - * around the html client. |
|
| 214 | - * |
|
| 215 | - * client/html/catalog/session/pinned/decorators/excludes = array( 'decorator1' ) |
|
| 216 | - * |
|
| 217 | - * This would remove the decorator named "decorator1" from the list of |
|
| 218 | - * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via |
|
| 219 | - * "client/html/common/decorators/default" to the html client. |
|
| 220 | - * |
|
| 221 | - * @param array List of decorator names |
|
| 222 | - * @since 2015.08 |
|
| 223 | - * @category Developer |
|
| 224 | - * @see client/html/common/decorators/default |
|
| 225 | - * @see client/html/catalog/session/pinned/decorators/global |
|
| 226 | - * @see client/html/catalog/session/pinned/decorators/local |
|
| 227 | - */ |
|
| 228 | - |
|
| 229 | - /** client/html/catalog/session/pinned/decorators/global |
|
| 230 | - * Adds a list of globally available decorators only to the catalog session pinned html client |
|
| 231 | - * |
|
| 232 | - * Decorators extend the functionality of a class by adding new aspects |
|
| 233 | - * (e.g. log what is currently done), executing the methods of the underlying |
|
| 234 | - * class only in certain conditions (e.g. only for logged in users) or |
|
| 235 | - * modify what is returned to the caller. |
|
| 236 | - * |
|
| 237 | - * This option allows you to wrap global decorators |
|
| 238 | - * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client. |
|
| 239 | - * |
|
| 240 | - * client/html/catalog/session/pinned/decorators/global = array( 'decorator1' ) |
|
| 241 | - * |
|
| 242 | - * This would add the decorator named "decorator1" defined by |
|
| 243 | - * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client. |
|
| 244 | - * |
|
| 245 | - * @param array List of decorator names |
|
| 246 | - * @since 2015.08 |
|
| 247 | - * @category Developer |
|
| 248 | - * @see client/html/common/decorators/default |
|
| 249 | - * @see client/html/catalog/session/pinned/decorators/excludes |
|
| 250 | - * @see client/html/catalog/session/pinned/decorators/local |
|
| 251 | - */ |
|
| 252 | - |
|
| 253 | - /** client/html/catalog/session/pinned/decorators/local |
|
| 254 | - * Adds a list of local decorators only to the catalog session pinned html client |
|
| 255 | - * |
|
| 256 | - * Decorators extend the functionality of a class by adding new aspects |
|
| 257 | - * (e.g. log what is currently done), executing the methods of the underlying |
|
| 258 | - * class only in certain conditions (e.g. only for logged in users) or |
|
| 259 | - * modify what is returned to the caller. |
|
| 260 | - * |
|
| 261 | - * This option allows you to wrap local decorators |
|
| 262 | - * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client. |
|
| 263 | - * |
|
| 264 | - * client/html/catalog/session/pinned/decorators/local = array( 'decorator2' ) |
|
| 265 | - * |
|
| 266 | - * This would add the decorator named "decorator2" defined by |
|
| 267 | - * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client. |
|
| 268 | - * |
|
| 269 | - * @param array List of decorator names |
|
| 270 | - * @since 2015.08 |
|
| 271 | - * @category Developer |
|
| 272 | - * @see client/html/common/decorators/default |
|
| 273 | - * @see client/html/catalog/session/pinned/decorators/excludes |
|
| 274 | - * @see client/html/catalog/session/pinned/decorators/global |
|
| 275 | - */ |
|
| 276 | - |
|
| 277 | - return $this->createSubClient( 'catalog/session/pinned/' . $type, $name ); |
|
| 278 | - } |
|
| 279 | - |
|
| 280 | - |
|
| 281 | - /** |
|
| 282 | - * Processes the input, e.g. store given values. |
|
| 283 | - * A view must be available and this method doesn't generate any output |
|
| 284 | - * besides setting view variables. |
|
| 285 | - */ |
|
| 286 | - public function process() |
|
| 287 | - { |
|
| 288 | - $refresh = false; |
|
| 289 | - $view = $this->getView(); |
|
| 290 | - $context = $this->getContext(); |
|
| 291 | - $session = $context->getSession(); |
|
| 292 | - $pinned = $session->get( 'aimeos/catalog/session/pinned/list', array() ); |
|
| 293 | - |
|
| 294 | - switch( $view->param( 'pin_action' ) ) |
|
| 295 | - { |
|
| 296 | - case 'add': |
|
| 297 | - |
|
| 298 | - foreach( (array) $view->param( 'pin_id', array() ) as $id ) { |
|
| 299 | - $pinned[$id] = $id; |
|
| 300 | - } |
|
| 301 | - |
|
| 302 | - /** client/html/catalog/session/pinned/standard/maxitems |
|
| 303 | - * Maximum number of products displayed in the "pinned" section |
|
| 304 | - * |
|
| 305 | - * This option limits the number of products that are shown in the |
|
| 306 | - * "pinned" section after the users added the product to their list |
|
| 307 | - * of pinned products. It must be a positive integer value greater |
|
| 308 | - * than 0. |
|
| 309 | - * |
|
| 310 | - * Note: The higher the value is the more data has to be transfered |
|
| 311 | - * to the client each time the user loads a page with the list of |
|
| 312 | - * pinned products. |
|
| 313 | - * |
|
| 314 | - * @param integer Number of products |
|
| 315 | - * @since 2014.09 |
|
| 316 | - * @category User |
|
| 317 | - * @category Developer |
|
| 318 | - */ |
|
| 319 | - $max = $context->getConfig()->get( 'client/html/catalog/session/pinned/standard/maxitems', 50 ); |
|
| 320 | - |
|
| 321 | - $pinned = array_slice( $pinned, -$max, $max, true ); |
|
| 322 | - $refresh = true; |
|
| 323 | - break; |
|
| 324 | - |
|
| 325 | - case 'delete': |
|
| 326 | - |
|
| 327 | - foreach( (array) $view->param( 'pin_id', array() ) as $id ) { |
|
| 328 | - unset( $pinned[$id] ); |
|
| 329 | - } |
|
| 330 | - |
|
| 331 | - $refresh = true; |
|
| 332 | - break; |
|
| 333 | - } |
|
| 334 | - |
|
| 335 | - |
|
| 336 | - if( $refresh ) |
|
| 337 | - { |
|
| 338 | - $session->set( 'aimeos/catalog/session/pinned/list', $pinned ); |
|
| 339 | - |
|
| 340 | - foreach( $session->get( 'aimeos/catalog/session/pinned/cache', array() ) as $key => $value ) { |
|
| 341 | - $session->set( $key, null ); |
|
| 342 | - } |
|
| 343 | - } |
|
| 344 | - |
|
| 345 | - parent::process(); |
|
| 346 | - } |
|
| 347 | - |
|
| 348 | - |
|
| 349 | - /** |
|
| 350 | - * Returns the list of sub-client names configured for the client. |
|
| 351 | - * |
|
| 352 | - * @return array List of HTML client names |
|
| 353 | - */ |
|
| 354 | - protected function getSubClientNames() |
|
| 355 | - { |
|
| 356 | - return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames ); |
|
| 357 | - } |
|
| 358 | - |
|
| 359 | - |
|
| 360 | - /** |
|
| 361 | - * Sets the necessary parameter values in the view. |
|
| 362 | - * |
|
| 363 | - * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output |
|
| 364 | - * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 365 | - * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 366 | - * @return \Aimeos\MW\View\Iface Modified view object |
|
| 367 | - */ |
|
| 368 | - protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null ) |
|
| 369 | - { |
|
| 370 | - if( !isset( $this->cache ) ) |
|
| 371 | - { |
|
| 372 | - $expire = null; |
|
| 373 | - $tags = $items = array(); |
|
| 374 | - $context = $this->getContext(); |
|
| 375 | - $config = $context->getConfig(); |
|
| 376 | - $session = $context->getSession(); |
|
| 377 | - |
|
| 378 | - $default = array( 'media', 'price', 'text' ); |
|
| 379 | - $domains = $config->get( 'client/html/catalog/domains', $default ); |
|
| 380 | - |
|
| 381 | - /** client/html/catalog/session/pinned/domains |
|
| 382 | - * A list of domain names whose items should be available in the pinned view template for the product |
|
| 383 | - * |
|
| 384 | - * The templates rendering product details usually add the images, |
|
| 385 | - * prices and texts, etc. associated to the product |
|
| 386 | - * item. If you want to display additional or less content, you can |
|
| 387 | - * configure your own list of domains (attribute, media, price, product, |
|
| 388 | - * text, etc. are domains) whose items are fetched from the storage. |
|
| 389 | - * Please keep in mind that the more domains you add to the configuration, |
|
| 390 | - * the more time is required for fetching the content! |
|
| 391 | - * |
|
| 392 | - * From 2014.09 to 2015.03, this setting was available as |
|
| 393 | - * client/html/catalog/detail/pinned/domains |
|
| 394 | - * |
|
| 395 | - * @param array List of domain names |
|
| 396 | - * @since 2015.04 |
|
| 397 | - * @category Developer |
|
| 398 | - * @see client/html/catalog/domains |
|
| 399 | - * @see client/html/catalog/lists/domains |
|
| 400 | - * @see client/html/catalog/detail/domains |
|
| 401 | - */ |
|
| 402 | - $domains = $config->get( 'client/html/catalog/session/pinned/domains', $domains ); |
|
| 403 | - |
|
| 404 | - $pinned = $session->get( 'aimeos/catalog/session/pinned/list', array() ); |
|
| 405 | - |
|
| 406 | - $controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' ); |
|
| 407 | - $result = $controller->getProductItems( $pinned, $domains ); |
|
| 408 | - |
|
| 409 | - foreach( array_reverse( $pinned ) as $id ) |
|
| 410 | - { |
|
| 411 | - if( isset( $result[$id] ) ) { |
|
| 412 | - $items[$id] = $result[$id]; |
|
| 413 | - } |
|
| 414 | - } |
|
| 415 | - |
|
| 416 | - $view->pinnedProductItems = $items; |
|
| 417 | - $view->pinnedParams = $this->getClientParams( $view->param() ); |
|
| 418 | - |
|
| 419 | - $this->cache = $view; |
|
| 420 | - } |
|
| 421 | - |
|
| 422 | - return $this->cache; |
|
| 423 | - } |
|
| 25 | + /** client/html/catalog/session/pinned/standard/subparts |
|
| 26 | + * List of HTML sub-clients rendered within the catalog session pinned section |
|
| 27 | + * |
|
| 28 | + * The output of the frontend is composed of the code generated by the HTML |
|
| 29 | + * clients. Each HTML client can consist of serveral (or none) sub-clients |
|
| 30 | + * that are responsible for rendering certain sub-parts of the output. The |
|
| 31 | + * sub-clients can contain HTML clients themselves and therefore a |
|
| 32 | + * hierarchical tree of HTML clients is composed. Each HTML client creates |
|
| 33 | + * the output that is placed inside the container of its parent. |
|
| 34 | + * |
|
| 35 | + * At first, always the HTML code generated by the parent is printed, then |
|
| 36 | + * the HTML code of its sub-clients. The order of the HTML sub-clients |
|
| 37 | + * determines the order of the output of these sub-clients inside the parent |
|
| 38 | + * container. If the configured list of clients is |
|
| 39 | + * |
|
| 40 | + * array( "subclient1", "subclient2" ) |
|
| 41 | + * |
|
| 42 | + * you can easily change the order of the output by reordering the subparts: |
|
| 43 | + * |
|
| 44 | + * client/html/<clients>/subparts = array( "subclient1", "subclient2" ) |
|
| 45 | + * |
|
| 46 | + * You can also remove one or more parts if they shouldn't be rendered: |
|
| 47 | + * |
|
| 48 | + * client/html/<clients>/subparts = array( "subclient1" ) |
|
| 49 | + * |
|
| 50 | + * As the clients only generates structural HTML, the layout defined via CSS |
|
| 51 | + * should support adding, removing or reordering content by a fluid like |
|
| 52 | + * design. |
|
| 53 | + * |
|
| 54 | + * @param array List of sub-client names |
|
| 55 | + * @since 2014.03 |
|
| 56 | + * @category Developer |
|
| 57 | + */ |
|
| 58 | + private $subPartPath = 'client/html/catalog/session/pinned/standard/subparts'; |
|
| 59 | + private $subPartNames = array(); |
|
| 60 | + private $cache; |
|
| 61 | + |
|
| 62 | + |
|
| 63 | + /** |
|
| 64 | + * Returns the HTML code for insertion into the body. |
|
| 65 | + * |
|
| 66 | + * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
|
| 67 | + * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 68 | + * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 69 | + * @return string HTML code |
|
| 70 | + */ |
|
| 71 | + public function getBody( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 72 | + { |
|
| 73 | + $context = $this->getContext(); |
|
| 74 | + $session = $context->getSession(); |
|
| 75 | + |
|
| 76 | + /** client/html/catalog/session/pinned |
|
| 77 | + * All parameters defined for the catalog session pinned subpart |
|
| 78 | + * |
|
| 79 | + * This returns all settings related to the catalog session pinned subpart. |
|
| 80 | + * Please refer to the single settings for details. |
|
| 81 | + * |
|
| 82 | + * @param array Associative list of name/value settings |
|
| 83 | + * @category Developer |
|
| 84 | + * @see client/html/catalog/session#pinned |
|
| 85 | + */ |
|
| 86 | + $config = $context->getConfig()->get( 'client/html/catalog/session/pinned', array() ); |
|
| 87 | + $key = $this->getParamHash( array(), $uid . ':catalog:session-pinned-body', $config ); |
|
| 88 | + |
|
| 89 | + if( ( $html = $session->get( $key ) ) === null ) |
|
| 90 | + { |
|
| 91 | + $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 92 | + |
|
| 93 | + $output = ''; |
|
| 94 | + foreach( $this->getSubClients() as $subclient ) { |
|
| 95 | + $output .= $subclient->setView( $view )->getBody( $uid, $tags, $expire ); |
|
| 96 | + } |
|
| 97 | + $view->pinnedBody = $output; |
|
| 98 | + |
|
| 99 | + /** client/html/catalog/session/pinned/standard/template-body |
|
| 100 | + * Relative path to the HTML body template of the catalog session pinned client. |
|
| 101 | + * |
|
| 102 | + * The template file contains the HTML code and processing instructions |
|
| 103 | + * to generate the result shown in the body of the frontend. The |
|
| 104 | + * configuration string is the path to the template file relative |
|
| 105 | + * to the templates directory (usually in client/html/templates). |
|
| 106 | + * |
|
| 107 | + * You can overwrite the template file configuration in extensions and |
|
| 108 | + * provide alternative templates. These alternative templates should be |
|
| 109 | + * named like the default one but with the string "standard" replaced by |
|
| 110 | + * an unique name. You may use the name of your project for this. If |
|
| 111 | + * you've implemented an alternative client class as well, "standard" |
|
| 112 | + * should be replaced by the name of the new class. |
|
| 113 | + * |
|
| 114 | + * @param string Relative path to the template creating code for the HTML page body |
|
| 115 | + * @since 2014.03 |
|
| 116 | + * @category Developer |
|
| 117 | + * @see client/html/catalog/session/pinned/standard/template-header |
|
| 118 | + */ |
|
| 119 | + $tplconf = 'client/html/catalog/session/pinned/standard/template-body'; |
|
| 120 | + $default = 'catalog/session/pinned-body-default.php'; |
|
| 121 | + |
|
| 122 | + $html = $view->render( $view->config( $tplconf, $default ) ); |
|
| 123 | + |
|
| 124 | + $cached = $session->get( 'aimeos/catalog/session/pinned/cache', array() ) + array( $key => true ); |
|
| 125 | + $session->set( 'aimeos/catalog/session/pinned/cache', $cached ); |
|
| 126 | + $session->set( $key, $html ); |
|
| 127 | + } |
|
| 128 | + |
|
| 129 | + return $html; |
|
| 130 | + } |
|
| 131 | + |
|
| 132 | + |
|
| 133 | + /** |
|
| 134 | + * Returns the HTML string for insertion into the header. |
|
| 135 | + * |
|
| 136 | + * @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
|
| 137 | + * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 138 | + * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 139 | + * @return string|null String including HTML tags for the header on error |
|
| 140 | + */ |
|
| 141 | + public function getHeader( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 142 | + { |
|
| 143 | + $context = $this->getContext(); |
|
| 144 | + $session = $context->getSession(); |
|
| 145 | + |
|
| 146 | + $config = $context->getConfig()->get( 'client/html/catalog/session/pinned', array() ); |
|
| 147 | + $key = $this->getParamHash( array(), $uid . ':catalog:session-pinned-header', $config ); |
|
| 148 | + |
|
| 149 | + if( ( $html = $session->get( $key ) ) === null ) |
|
| 150 | + { |
|
| 151 | + $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 152 | + |
|
| 153 | + $output = ''; |
|
| 154 | + foreach( $this->getSubClients() as $subclient ) { |
|
| 155 | + $output .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire ); |
|
| 156 | + } |
|
| 157 | + $view->pinnedHeader = $output; |
|
| 158 | + |
|
| 159 | + /** client/html/catalog/session/pinned/standard/template-header |
|
| 160 | + * Relative path to the HTML header template of the catalog session pinned client. |
|
| 161 | + * |
|
| 162 | + * The template file contains the HTML code and processing instructions |
|
| 163 | + * to generate the HTML code that is inserted into the HTML page header |
|
| 164 | + * of the rendered page in the frontend. The configuration string is the |
|
| 165 | + * path to the template file relative to the templates directory (usually |
|
| 166 | + * in client/html/templates). |
|
| 167 | + * |
|
| 168 | + * You can overwrite the template file configuration in extensions and |
|
| 169 | + * provide alternative templates. These alternative templates should be |
|
| 170 | + * named like the default one but with the string "standard" replaced by |
|
| 171 | + * an unique name. You may use the name of your project for this. If |
|
| 172 | + * you've implemented an alternative client class as well, "standard" |
|
| 173 | + * should be replaced by the name of the new class. |
|
| 174 | + * |
|
| 175 | + * @param string Relative path to the template creating code for the HTML page head |
|
| 176 | + * @since 2014.03 |
|
| 177 | + * @category Developer |
|
| 178 | + * @see client/html/catalog/session/pinned/standard/template-body |
|
| 179 | + */ |
|
| 180 | + $tplconf = 'client/html/catalog/session/pinned/standard/template-header'; |
|
| 181 | + $default = 'catalog/session/pinned-header-default.php'; |
|
| 182 | + |
|
| 183 | + $html = $view->render( $view->config( $tplconf, $default ) ); |
|
| 184 | + |
|
| 185 | + $cached = $session->get( 'aimeos/catalog/session/pinned/cache', array() ) + array( $key => true ); |
|
| 186 | + $session->set( 'aimeos/catalog/session/pinned/cache', $cached ); |
|
| 187 | + $session->set( $key, $html ); |
|
| 188 | + } |
|
| 189 | + |
|
| 190 | + return $html; |
|
| 191 | + } |
|
| 192 | + |
|
| 193 | + |
|
| 194 | + /** |
|
| 195 | + * Returns the sub-client given by its name. |
|
| 196 | + * |
|
| 197 | + * @param string $type Name of the client type |
|
| 198 | + * @param string|null $name Name of the sub-client (Default if null) |
|
| 199 | + * @return \Aimeos\Client\Html\Iface Sub-client object |
|
| 200 | + */ |
|
| 201 | + public function getSubClient( $type, $name = null ) |
|
| 202 | + { |
|
| 203 | + /** client/html/catalog/session/pinned/decorators/excludes |
|
| 204 | + * Excludes decorators added by the "common" option from the catalog session pinned html client |
|
| 205 | + * |
|
| 206 | + * Decorators extend the functionality of a class by adding new aspects |
|
| 207 | + * (e.g. log what is currently done), executing the methods of the underlying |
|
| 208 | + * class only in certain conditions (e.g. only for logged in users) or |
|
| 209 | + * modify what is returned to the caller. |
|
| 210 | + * |
|
| 211 | + * This option allows you to remove a decorator added via |
|
| 212 | + * "client/html/common/decorators/default" before they are wrapped |
|
| 213 | + * around the html client. |
|
| 214 | + * |
|
| 215 | + * client/html/catalog/session/pinned/decorators/excludes = array( 'decorator1' ) |
|
| 216 | + * |
|
| 217 | + * This would remove the decorator named "decorator1" from the list of |
|
| 218 | + * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via |
|
| 219 | + * "client/html/common/decorators/default" to the html client. |
|
| 220 | + * |
|
| 221 | + * @param array List of decorator names |
|
| 222 | + * @since 2015.08 |
|
| 223 | + * @category Developer |
|
| 224 | + * @see client/html/common/decorators/default |
|
| 225 | + * @see client/html/catalog/session/pinned/decorators/global |
|
| 226 | + * @see client/html/catalog/session/pinned/decorators/local |
|
| 227 | + */ |
|
| 228 | + |
|
| 229 | + /** client/html/catalog/session/pinned/decorators/global |
|
| 230 | + * Adds a list of globally available decorators only to the catalog session pinned html client |
|
| 231 | + * |
|
| 232 | + * Decorators extend the functionality of a class by adding new aspects |
|
| 233 | + * (e.g. log what is currently done), executing the methods of the underlying |
|
| 234 | + * class only in certain conditions (e.g. only for logged in users) or |
|
| 235 | + * modify what is returned to the caller. |
|
| 236 | + * |
|
| 237 | + * This option allows you to wrap global decorators |
|
| 238 | + * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client. |
|
| 239 | + * |
|
| 240 | + * client/html/catalog/session/pinned/decorators/global = array( 'decorator1' ) |
|
| 241 | + * |
|
| 242 | + * This would add the decorator named "decorator1" defined by |
|
| 243 | + * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client. |
|
| 244 | + * |
|
| 245 | + * @param array List of decorator names |
|
| 246 | + * @since 2015.08 |
|
| 247 | + * @category Developer |
|
| 248 | + * @see client/html/common/decorators/default |
|
| 249 | + * @see client/html/catalog/session/pinned/decorators/excludes |
|
| 250 | + * @see client/html/catalog/session/pinned/decorators/local |
|
| 251 | + */ |
|
| 252 | + |
|
| 253 | + /** client/html/catalog/session/pinned/decorators/local |
|
| 254 | + * Adds a list of local decorators only to the catalog session pinned html client |
|
| 255 | + * |
|
| 256 | + * Decorators extend the functionality of a class by adding new aspects |
|
| 257 | + * (e.g. log what is currently done), executing the methods of the underlying |
|
| 258 | + * class only in certain conditions (e.g. only for logged in users) or |
|
| 259 | + * modify what is returned to the caller. |
|
| 260 | + * |
|
| 261 | + * This option allows you to wrap local decorators |
|
| 262 | + * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client. |
|
| 263 | + * |
|
| 264 | + * client/html/catalog/session/pinned/decorators/local = array( 'decorator2' ) |
|
| 265 | + * |
|
| 266 | + * This would add the decorator named "decorator2" defined by |
|
| 267 | + * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client. |
|
| 268 | + * |
|
| 269 | + * @param array List of decorator names |
|
| 270 | + * @since 2015.08 |
|
| 271 | + * @category Developer |
|
| 272 | + * @see client/html/common/decorators/default |
|
| 273 | + * @see client/html/catalog/session/pinned/decorators/excludes |
|
| 274 | + * @see client/html/catalog/session/pinned/decorators/global |
|
| 275 | + */ |
|
| 276 | + |
|
| 277 | + return $this->createSubClient( 'catalog/session/pinned/' . $type, $name ); |
|
| 278 | + } |
|
| 279 | + |
|
| 280 | + |
|
| 281 | + /** |
|
| 282 | + * Processes the input, e.g. store given values. |
|
| 283 | + * A view must be available and this method doesn't generate any output |
|
| 284 | + * besides setting view variables. |
|
| 285 | + */ |
|
| 286 | + public function process() |
|
| 287 | + { |
|
| 288 | + $refresh = false; |
|
| 289 | + $view = $this->getView(); |
|
| 290 | + $context = $this->getContext(); |
|
| 291 | + $session = $context->getSession(); |
|
| 292 | + $pinned = $session->get( 'aimeos/catalog/session/pinned/list', array() ); |
|
| 293 | + |
|
| 294 | + switch( $view->param( 'pin_action' ) ) |
|
| 295 | + { |
|
| 296 | + case 'add': |
|
| 297 | + |
|
| 298 | + foreach( (array) $view->param( 'pin_id', array() ) as $id ) { |
|
| 299 | + $pinned[$id] = $id; |
|
| 300 | + } |
|
| 301 | + |
|
| 302 | + /** client/html/catalog/session/pinned/standard/maxitems |
|
| 303 | + * Maximum number of products displayed in the "pinned" section |
|
| 304 | + * |
|
| 305 | + * This option limits the number of products that are shown in the |
|
| 306 | + * "pinned" section after the users added the product to their list |
|
| 307 | + * of pinned products. It must be a positive integer value greater |
|
| 308 | + * than 0. |
|
| 309 | + * |
|
| 310 | + * Note: The higher the value is the more data has to be transfered |
|
| 311 | + * to the client each time the user loads a page with the list of |
|
| 312 | + * pinned products. |
|
| 313 | + * |
|
| 314 | + * @param integer Number of products |
|
| 315 | + * @since 2014.09 |
|
| 316 | + * @category User |
|
| 317 | + * @category Developer |
|
| 318 | + */ |
|
| 319 | + $max = $context->getConfig()->get( 'client/html/catalog/session/pinned/standard/maxitems', 50 ); |
|
| 320 | + |
|
| 321 | + $pinned = array_slice( $pinned, -$max, $max, true ); |
|
| 322 | + $refresh = true; |
|
| 323 | + break; |
|
| 324 | + |
|
| 325 | + case 'delete': |
|
| 326 | + |
|
| 327 | + foreach( (array) $view->param( 'pin_id', array() ) as $id ) { |
|
| 328 | + unset( $pinned[$id] ); |
|
| 329 | + } |
|
| 330 | + |
|
| 331 | + $refresh = true; |
|
| 332 | + break; |
|
| 333 | + } |
|
| 334 | + |
|
| 335 | + |
|
| 336 | + if( $refresh ) |
|
| 337 | + { |
|
| 338 | + $session->set( 'aimeos/catalog/session/pinned/list', $pinned ); |
|
| 339 | + |
|
| 340 | + foreach( $session->get( 'aimeos/catalog/session/pinned/cache', array() ) as $key => $value ) { |
|
| 341 | + $session->set( $key, null ); |
|
| 342 | + } |
|
| 343 | + } |
|
| 344 | + |
|
| 345 | + parent::process(); |
|
| 346 | + } |
|
| 347 | + |
|
| 348 | + |
|
| 349 | + /** |
|
| 350 | + * Returns the list of sub-client names configured for the client. |
|
| 351 | + * |
|
| 352 | + * @return array List of HTML client names |
|
| 353 | + */ |
|
| 354 | + protected function getSubClientNames() |
|
| 355 | + { |
|
| 356 | + return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames ); |
|
| 357 | + } |
|
| 358 | + |
|
| 359 | + |
|
| 360 | + /** |
|
| 361 | + * Sets the necessary parameter values in the view. |
|
| 362 | + * |
|
| 363 | + * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output |
|
| 364 | + * @param array &$tags Result array for the list of tags that are associated to the output |
|
| 365 | + * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
| 366 | + * @return \Aimeos\MW\View\Iface Modified view object |
|
| 367 | + */ |
|
| 368 | + protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null ) |
|
| 369 | + { |
|
| 370 | + if( !isset( $this->cache ) ) |
|
| 371 | + { |
|
| 372 | + $expire = null; |
|
| 373 | + $tags = $items = array(); |
|
| 374 | + $context = $this->getContext(); |
|
| 375 | + $config = $context->getConfig(); |
|
| 376 | + $session = $context->getSession(); |
|
| 377 | + |
|
| 378 | + $default = array( 'media', 'price', 'text' ); |
|
| 379 | + $domains = $config->get( 'client/html/catalog/domains', $default ); |
|
| 380 | + |
|
| 381 | + /** client/html/catalog/session/pinned/domains |
|
| 382 | + * A list of domain names whose items should be available in the pinned view template for the product |
|
| 383 | + * |
|
| 384 | + * The templates rendering product details usually add the images, |
|
| 385 | + * prices and texts, etc. associated to the product |
|
| 386 | + * item. If you want to display additional or less content, you can |
|
| 387 | + * configure your own list of domains (attribute, media, price, product, |
|
| 388 | + * text, etc. are domains) whose items are fetched from the storage. |
|
| 389 | + * Please keep in mind that the more domains you add to the configuration, |
|
| 390 | + * the more time is required for fetching the content! |
|
| 391 | + * |
|
| 392 | + * From 2014.09 to 2015.03, this setting was available as |
|
| 393 | + * client/html/catalog/detail/pinned/domains |
|
| 394 | + * |
|
| 395 | + * @param array List of domain names |
|
| 396 | + * @since 2015.04 |
|
| 397 | + * @category Developer |
|
| 398 | + * @see client/html/catalog/domains |
|
| 399 | + * @see client/html/catalog/lists/domains |
|
| 400 | + * @see client/html/catalog/detail/domains |
|
| 401 | + */ |
|
| 402 | + $domains = $config->get( 'client/html/catalog/session/pinned/domains', $domains ); |
|
| 403 | + |
|
| 404 | + $pinned = $session->get( 'aimeos/catalog/session/pinned/list', array() ); |
|
| 405 | + |
|
| 406 | + $controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' ); |
|
| 407 | + $result = $controller->getProductItems( $pinned, $domains ); |
|
| 408 | + |
|
| 409 | + foreach( array_reverse( $pinned ) as $id ) |
|
| 410 | + { |
|
| 411 | + if( isset( $result[$id] ) ) { |
|
| 412 | + $items[$id] = $result[$id]; |
|
| 413 | + } |
|
| 414 | + } |
|
| 415 | + |
|
| 416 | + $view->pinnedProductItems = $items; |
|
| 417 | + $view->pinnedParams = $this->getClientParams( $view->param() ); |
|
| 418 | + |
|
| 419 | + $this->cache = $view; |
|
| 420 | + } |
|
| 421 | + |
|
| 422 | + return $this->cache; |
|
| 423 | + } |
|
| 424 | 424 | } |
| 425 | 425 | \ No newline at end of file |
@@ -68,7 +68,7 @@ discard block |
||
| 68 | 68 | * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
| 69 | 69 | * @return string HTML code |
| 70 | 70 | */ |
| 71 | - public function getBody( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 71 | + public function getBody($uid = '', array &$tags = array(), &$expire = null) |
|
| 72 | 72 | { |
| 73 | 73 | $context = $this->getContext(); |
| 74 | 74 | $session = $context->getSession(); |
@@ -83,16 +83,16 @@ discard block |
||
| 83 | 83 | * @category Developer |
| 84 | 84 | * @see client/html/catalog/session#pinned |
| 85 | 85 | */ |
| 86 | - $config = $context->getConfig()->get( 'client/html/catalog/session/pinned', array() ); |
|
| 87 | - $key = $this->getParamHash( array(), $uid . ':catalog:session-pinned-body', $config ); |
|
| 86 | + $config = $context->getConfig()->get('client/html/catalog/session/pinned', array()); |
|
| 87 | + $key = $this->getParamHash(array(), $uid.':catalog:session-pinned-body', $config); |
|
| 88 | 88 | |
| 89 | - if( ( $html = $session->get( $key ) ) === null ) |
|
| 89 | + if (($html = $session->get($key)) === null) |
|
| 90 | 90 | { |
| 91 | - $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 91 | + $view = $this->setViewParams($this->getView(), $tags, $expire); |
|
| 92 | 92 | |
| 93 | 93 | $output = ''; |
| 94 | - foreach( $this->getSubClients() as $subclient ) { |
|
| 95 | - $output .= $subclient->setView( $view )->getBody( $uid, $tags, $expire ); |
|
| 94 | + foreach ($this->getSubClients() as $subclient) { |
|
| 95 | + $output .= $subclient->setView($view)->getBody($uid, $tags, $expire); |
|
| 96 | 96 | } |
| 97 | 97 | $view->pinnedBody = $output; |
| 98 | 98 | |
@@ -119,11 +119,11 @@ discard block |
||
| 119 | 119 | $tplconf = 'client/html/catalog/session/pinned/standard/template-body'; |
| 120 | 120 | $default = 'catalog/session/pinned-body-default.php'; |
| 121 | 121 | |
| 122 | - $html = $view->render( $view->config( $tplconf, $default ) ); |
|
| 122 | + $html = $view->render($view->config($tplconf, $default)); |
|
| 123 | 123 | |
| 124 | - $cached = $session->get( 'aimeos/catalog/session/pinned/cache', array() ) + array( $key => true ); |
|
| 125 | - $session->set( 'aimeos/catalog/session/pinned/cache', $cached ); |
|
| 126 | - $session->set( $key, $html ); |
|
| 124 | + $cached = $session->get('aimeos/catalog/session/pinned/cache', array()) + array($key => true); |
|
| 125 | + $session->set('aimeos/catalog/session/pinned/cache', $cached); |
|
| 126 | + $session->set($key, $html); |
|
| 127 | 127 | } |
| 128 | 128 | |
| 129 | 129 | return $html; |
@@ -138,21 +138,21 @@ discard block |
||
| 138 | 138 | * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
| 139 | 139 | * @return string|null String including HTML tags for the header on error |
| 140 | 140 | */ |
| 141 | - public function getHeader( $uid = '', array &$tags = array(), &$expire = null ) |
|
| 141 | + public function getHeader($uid = '', array &$tags = array(), &$expire = null) |
|
| 142 | 142 | { |
| 143 | 143 | $context = $this->getContext(); |
| 144 | 144 | $session = $context->getSession(); |
| 145 | 145 | |
| 146 | - $config = $context->getConfig()->get( 'client/html/catalog/session/pinned', array() ); |
|
| 147 | - $key = $this->getParamHash( array(), $uid . ':catalog:session-pinned-header', $config ); |
|
| 146 | + $config = $context->getConfig()->get('client/html/catalog/session/pinned', array()); |
|
| 147 | + $key = $this->getParamHash(array(), $uid.':catalog:session-pinned-header', $config); |
|
| 148 | 148 | |
| 149 | - if( ( $html = $session->get( $key ) ) === null ) |
|
| 149 | + if (($html = $session->get($key)) === null) |
|
| 150 | 150 | { |
| 151 | - $view = $this->setViewParams( $this->getView(), $tags, $expire ); |
|
| 151 | + $view = $this->setViewParams($this->getView(), $tags, $expire); |
|
| 152 | 152 | |
| 153 | 153 | $output = ''; |
| 154 | - foreach( $this->getSubClients() as $subclient ) { |
|
| 155 | - $output .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire ); |
|
| 154 | + foreach ($this->getSubClients() as $subclient) { |
|
| 155 | + $output .= $subclient->setView($view)->getHeader($uid, $tags, $expire); |
|
| 156 | 156 | } |
| 157 | 157 | $view->pinnedHeader = $output; |
| 158 | 158 | |
@@ -180,11 +180,11 @@ discard block |
||
| 180 | 180 | $tplconf = 'client/html/catalog/session/pinned/standard/template-header'; |
| 181 | 181 | $default = 'catalog/session/pinned-header-default.php'; |
| 182 | 182 | |
| 183 | - $html = $view->render( $view->config( $tplconf, $default ) ); |
|
| 183 | + $html = $view->render($view->config($tplconf, $default)); |
|
| 184 | 184 | |
| 185 | - $cached = $session->get( 'aimeos/catalog/session/pinned/cache', array() ) + array( $key => true ); |
|
| 186 | - $session->set( 'aimeos/catalog/session/pinned/cache', $cached ); |
|
| 187 | - $session->set( $key, $html ); |
|
| 185 | + $cached = $session->get('aimeos/catalog/session/pinned/cache', array()) + array($key => true); |
|
| 186 | + $session->set('aimeos/catalog/session/pinned/cache', $cached); |
|
| 187 | + $session->set($key, $html); |
|
| 188 | 188 | } |
| 189 | 189 | |
| 190 | 190 | return $html; |
@@ -198,7 +198,7 @@ discard block |
||
| 198 | 198 | * @param string|null $name Name of the sub-client (Default if null) |
| 199 | 199 | * @return \Aimeos\Client\Html\Iface Sub-client object |
| 200 | 200 | */ |
| 201 | - public function getSubClient( $type, $name = null ) |
|
| 201 | + public function getSubClient($type, $name = null) |
|
| 202 | 202 | { |
| 203 | 203 | /** client/html/catalog/session/pinned/decorators/excludes |
| 204 | 204 | * Excludes decorators added by the "common" option from the catalog session pinned html client |
@@ -274,7 +274,7 @@ discard block |
||
| 274 | 274 | * @see client/html/catalog/session/pinned/decorators/global |
| 275 | 275 | */ |
| 276 | 276 | |
| 277 | - return $this->createSubClient( 'catalog/session/pinned/' . $type, $name ); |
|
| 277 | + return $this->createSubClient('catalog/session/pinned/'.$type, $name); |
|
| 278 | 278 | } |
| 279 | 279 | |
| 280 | 280 | |
@@ -289,13 +289,13 @@ discard block |
||
| 289 | 289 | $view = $this->getView(); |
| 290 | 290 | $context = $this->getContext(); |
| 291 | 291 | $session = $context->getSession(); |
| 292 | - $pinned = $session->get( 'aimeos/catalog/session/pinned/list', array() ); |
|
| 292 | + $pinned = $session->get('aimeos/catalog/session/pinned/list', array()); |
|
| 293 | 293 | |
| 294 | - switch( $view->param( 'pin_action' ) ) |
|
| 294 | + switch ($view->param('pin_action')) |
|
| 295 | 295 | { |
| 296 | 296 | case 'add': |
| 297 | 297 | |
| 298 | - foreach( (array) $view->param( 'pin_id', array() ) as $id ) { |
|
| 298 | + foreach ((array) $view->param('pin_id', array()) as $id) { |
|
| 299 | 299 | $pinned[$id] = $id; |
| 300 | 300 | } |
| 301 | 301 | |
@@ -316,16 +316,16 @@ discard block |
||
| 316 | 316 | * @category User |
| 317 | 317 | * @category Developer |
| 318 | 318 | */ |
| 319 | - $max = $context->getConfig()->get( 'client/html/catalog/session/pinned/standard/maxitems', 50 ); |
|
| 319 | + $max = $context->getConfig()->get('client/html/catalog/session/pinned/standard/maxitems', 50); |
|
| 320 | 320 | |
| 321 | - $pinned = array_slice( $pinned, -$max, $max, true ); |
|
| 321 | + $pinned = array_slice($pinned, -$max, $max, true); |
|
| 322 | 322 | $refresh = true; |
| 323 | 323 | break; |
| 324 | 324 | |
| 325 | 325 | case 'delete': |
| 326 | 326 | |
| 327 | - foreach( (array) $view->param( 'pin_id', array() ) as $id ) { |
|
| 328 | - unset( $pinned[$id] ); |
|
| 327 | + foreach ((array) $view->param('pin_id', array()) as $id) { |
|
| 328 | + unset($pinned[$id]); |
|
| 329 | 329 | } |
| 330 | 330 | |
| 331 | 331 | $refresh = true; |
@@ -333,12 +333,12 @@ discard block |
||
| 333 | 333 | } |
| 334 | 334 | |
| 335 | 335 | |
| 336 | - if( $refresh ) |
|
| 336 | + if ($refresh) |
|
| 337 | 337 | { |
| 338 | - $session->set( 'aimeos/catalog/session/pinned/list', $pinned ); |
|
| 338 | + $session->set('aimeos/catalog/session/pinned/list', $pinned); |
|
| 339 | 339 | |
| 340 | - foreach( $session->get( 'aimeos/catalog/session/pinned/cache', array() ) as $key => $value ) { |
|
| 341 | - $session->set( $key, null ); |
|
| 340 | + foreach ($session->get('aimeos/catalog/session/pinned/cache', array()) as $key => $value) { |
|
| 341 | + $session->set($key, null); |
|
| 342 | 342 | } |
| 343 | 343 | } |
| 344 | 344 | |
@@ -353,7 +353,7 @@ discard block |
||
| 353 | 353 | */ |
| 354 | 354 | protected function getSubClientNames() |
| 355 | 355 | { |
| 356 | - return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames ); |
|
| 356 | + return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames); |
|
| 357 | 357 | } |
| 358 | 358 | |
| 359 | 359 | |
@@ -365,9 +365,9 @@ discard block |
||
| 365 | 365 | * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
| 366 | 366 | * @return \Aimeos\MW\View\Iface Modified view object |
| 367 | 367 | */ |
| 368 | - protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null ) |
|
| 368 | + protected function setViewParams(\Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null) |
|
| 369 | 369 | { |
| 370 | - if( !isset( $this->cache ) ) |
|
| 370 | + if (!isset($this->cache)) |
|
| 371 | 371 | { |
| 372 | 372 | $expire = null; |
| 373 | 373 | $tags = $items = array(); |
@@ -375,8 +375,8 @@ discard block |
||
| 375 | 375 | $config = $context->getConfig(); |
| 376 | 376 | $session = $context->getSession(); |
| 377 | 377 | |
| 378 | - $default = array( 'media', 'price', 'text' ); |
|
| 379 | - $domains = $config->get( 'client/html/catalog/domains', $default ); |
|
| 378 | + $default = array('media', 'price', 'text'); |
|
| 379 | + $domains = $config->get('client/html/catalog/domains', $default); |
|
| 380 | 380 | |
| 381 | 381 | /** client/html/catalog/session/pinned/domains |
| 382 | 382 | * A list of domain names whose items should be available in the pinned view template for the product |
@@ -399,22 +399,22 @@ discard block |
||
| 399 | 399 | * @see client/html/catalog/lists/domains |
| 400 | 400 | * @see client/html/catalog/detail/domains |
| 401 | 401 | */ |
| 402 | - $domains = $config->get( 'client/html/catalog/session/pinned/domains', $domains ); |
|
| 402 | + $domains = $config->get('client/html/catalog/session/pinned/domains', $domains); |
|
| 403 | 403 | |
| 404 | - $pinned = $session->get( 'aimeos/catalog/session/pinned/list', array() ); |
|
| 404 | + $pinned = $session->get('aimeos/catalog/session/pinned/list', array()); |
|
| 405 | 405 | |
| 406 | - $controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' ); |
|
| 407 | - $result = $controller->getProductItems( $pinned, $domains ); |
|
| 406 | + $controller = \Aimeos\Controller\Frontend\Factory::createController($context, 'catalog'); |
|
| 407 | + $result = $controller->getProductItems($pinned, $domains); |
|
| 408 | 408 | |
| 409 | - foreach( array_reverse( $pinned ) as $id ) |
|
| 409 | + foreach (array_reverse($pinned) as $id) |
|
| 410 | 410 | { |
| 411 | - if( isset( $result[$id] ) ) { |
|
| 411 | + if (isset($result[$id])) { |
|
| 412 | 412 | $items[$id] = $result[$id]; |
| 413 | 413 | } |
| 414 | 414 | } |
| 415 | 415 | |
| 416 | 416 | $view->pinnedProductItems = $items; |
| 417 | - $view->pinnedParams = $this->getClientParams( $view->param() ); |
|
| 417 | + $view->pinnedParams = $this->getClientParams($view->param()); |
|
| 418 | 418 | |
| 419 | 419 | $this->cache = $view; |
| 420 | 420 | } |
@@ -19,69 +19,69 @@ |
||
| 19 | 19 | * @subpackage Html |
| 20 | 20 | */ |
| 21 | 21 | class Factory |
| 22 | - extends \Aimeos\Client\Html\Common\Factory\Base |
|
| 23 | - implements \Aimeos\Client\Html\Common\Factory\Iface |
|
| 22 | + extends \Aimeos\Client\Html\Common\Factory\Base |
|
| 23 | + implements \Aimeos\Client\Html\Common\Factory\Iface |
|
| 24 | 24 | { |
| 25 | - /** |
|
| 26 | - * Creates a catalog session client object. |
|
| 27 | - * |
|
| 28 | - * @param \Aimeos\MShop\Context\Item\Iface $context Shop context instance with necessary objects |
|
| 29 | - * @param array $templatePaths List of file system paths where the templates are stored |
|
| 30 | - * @param string|null $name Client name (default: "Standard") |
|
| 31 | - * @return \Aimeos\Client\Html\Iface Filter part implementing \Aimeos\Client\Html\Iface |
|
| 32 | - * @throws \Aimeos\Client\Html\Exception If requested client implementation couldn't be found or initialisation fails |
|
| 33 | - */ |
|
| 34 | - public static function createClient( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths, $name = null ) |
|
| 35 | - { |
|
| 36 | - /** client/html/catalog/session/name |
|
| 37 | - * Class name of the used catalog session client implementation |
|
| 38 | - * |
|
| 39 | - * Each default HTML client can be replace by an alternative imlementation. |
|
| 40 | - * To use this implementation, you have to set the last part of the class |
|
| 41 | - * name as configuration value so the client factory knows which class it |
|
| 42 | - * has to instantiate. |
|
| 43 | - * |
|
| 44 | - * For example, if the name of the default class is |
|
| 45 | - * |
|
| 46 | - * \Aimeos\Client\Html\Catalog\Session\Standard |
|
| 47 | - * |
|
| 48 | - * and you want to replace it with your own version named |
|
| 49 | - * |
|
| 50 | - * \Aimeos\Client\Html\Catalog\Session\Mysession |
|
| 51 | - * |
|
| 52 | - * then you have to set the this configuration option: |
|
| 53 | - * |
|
| 54 | - * client/html/catalog/session/name = Mysession |
|
| 55 | - * |
|
| 56 | - * The value is the last part of your own class name and it's case sensitive, |
|
| 57 | - * so take care that the configuration value is exactly named like the last |
|
| 58 | - * part of the class name. |
|
| 59 | - * |
|
| 60 | - * The allowed characters of the class name are A-Z, a-z and 0-9. No other |
|
| 61 | - * characters are possible! You should always start the last part of the class |
|
| 62 | - * name with an upper case character and continue only with lower case characters |
|
| 63 | - * or numbers. Avoid chamel case names like "MySession"! |
|
| 64 | - * |
|
| 65 | - * @param string Last part of the class name |
|
| 66 | - * @since 2014.03 |
|
| 67 | - * @category Developer |
|
| 68 | - */ |
|
| 69 | - if( $name === null ) { |
|
| 70 | - $name = $context->getConfig()->get( 'client/html/catalog/session/name', 'Standard' ); |
|
| 71 | - } |
|
| 25 | + /** |
|
| 26 | + * Creates a catalog session client object. |
|
| 27 | + * |
|
| 28 | + * @param \Aimeos\MShop\Context\Item\Iface $context Shop context instance with necessary objects |
|
| 29 | + * @param array $templatePaths List of file system paths where the templates are stored |
|
| 30 | + * @param string|null $name Client name (default: "Standard") |
|
| 31 | + * @return \Aimeos\Client\Html\Iface Filter part implementing \Aimeos\Client\Html\Iface |
|
| 32 | + * @throws \Aimeos\Client\Html\Exception If requested client implementation couldn't be found or initialisation fails |
|
| 33 | + */ |
|
| 34 | + public static function createClient( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths, $name = null ) |
|
| 35 | + { |
|
| 36 | + /** client/html/catalog/session/name |
|
| 37 | + * Class name of the used catalog session client implementation |
|
| 38 | + * |
|
| 39 | + * Each default HTML client can be replace by an alternative imlementation. |
|
| 40 | + * To use this implementation, you have to set the last part of the class |
|
| 41 | + * name as configuration value so the client factory knows which class it |
|
| 42 | + * has to instantiate. |
|
| 43 | + * |
|
| 44 | + * For example, if the name of the default class is |
|
| 45 | + * |
|
| 46 | + * \Aimeos\Client\Html\Catalog\Session\Standard |
|
| 47 | + * |
|
| 48 | + * and you want to replace it with your own version named |
|
| 49 | + * |
|
| 50 | + * \Aimeos\Client\Html\Catalog\Session\Mysession |
|
| 51 | + * |
|
| 52 | + * then you have to set the this configuration option: |
|
| 53 | + * |
|
| 54 | + * client/html/catalog/session/name = Mysession |
|
| 55 | + * |
|
| 56 | + * The value is the last part of your own class name and it's case sensitive, |
|
| 57 | + * so take care that the configuration value is exactly named like the last |
|
| 58 | + * part of the class name. |
|
| 59 | + * |
|
| 60 | + * The allowed characters of the class name are A-Z, a-z and 0-9. No other |
|
| 61 | + * characters are possible! You should always start the last part of the class |
|
| 62 | + * name with an upper case character and continue only with lower case characters |
|
| 63 | + * or numbers. Avoid chamel case names like "MySession"! |
|
| 64 | + * |
|
| 65 | + * @param string Last part of the class name |
|
| 66 | + * @since 2014.03 |
|
| 67 | + * @category Developer |
|
| 68 | + */ |
|
| 69 | + if( $name === null ) { |
|
| 70 | + $name = $context->getConfig()->get( 'client/html/catalog/session/name', 'Standard' ); |
|
| 71 | + } |
|
| 72 | 72 | |
| 73 | - if( ctype_alnum( $name ) === false ) |
|
| 74 | - { |
|
| 75 | - $classname = is_string( $name ) ? '\\Aimeos\\Client\\Html\\Catalog\\Session\\' . $name : '<not a string>'; |
|
| 76 | - throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid characters in class name "%1$s"', $classname ) ); |
|
| 77 | - } |
|
| 73 | + if( ctype_alnum( $name ) === false ) |
|
| 74 | + { |
|
| 75 | + $classname = is_string( $name ) ? '\\Aimeos\\Client\\Html\\Catalog\\Session\\' . $name : '<not a string>'; |
|
| 76 | + throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid characters in class name "%1$s"', $classname ) ); |
|
| 77 | + } |
|
| 78 | 78 | |
| 79 | - $iface = '\\Aimeos\\Client\\Html\\Iface'; |
|
| 80 | - $classname = '\\Aimeos\\Client\\Html\\Catalog\\Session\\' . $name; |
|
| 79 | + $iface = '\\Aimeos\\Client\\Html\\Iface'; |
|
| 80 | + $classname = '\\Aimeos\\Client\\Html\\Catalog\\Session\\' . $name; |
|
| 81 | 81 | |
| 82 | - $client = self::createClientBase( $context, $classname, $iface, $templatePaths ); |
|
| 82 | + $client = self::createClientBase( $context, $classname, $iface, $templatePaths ); |
|
| 83 | 83 | |
| 84 | - return self::addClientDecorators( $context, $client, $templatePaths, 'catalog/session' ); |
|
| 85 | - } |
|
| 84 | + return self::addClientDecorators( $context, $client, $templatePaths, 'catalog/session' ); |
|
| 85 | + } |
|
| 86 | 86 | } |
| 87 | 87 | |
@@ -31,7 +31,7 @@ discard block |
||
| 31 | 31 | * @return \Aimeos\Client\Html\Iface Filter part implementing \Aimeos\Client\Html\Iface |
| 32 | 32 | * @throws \Aimeos\Client\Html\Exception If requested client implementation couldn't be found or initialisation fails |
| 33 | 33 | */ |
| 34 | - public static function createClient( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths, $name = null ) |
|
| 34 | + public static function createClient(\Aimeos\MShop\Context\Item\Iface $context, array $templatePaths, $name = null) |
|
| 35 | 35 | { |
| 36 | 36 | /** client/html/catalog/session/name |
| 37 | 37 | * Class name of the used catalog session client implementation |
@@ -66,22 +66,22 @@ discard block |
||
| 66 | 66 | * @since 2014.03 |
| 67 | 67 | * @category Developer |
| 68 | 68 | */ |
| 69 | - if( $name === null ) { |
|
| 70 | - $name = $context->getConfig()->get( 'client/html/catalog/session/name', 'Standard' ); |
|
| 69 | + if ($name === null) { |
|
| 70 | + $name = $context->getConfig()->get('client/html/catalog/session/name', 'Standard'); |
|
| 71 | 71 | } |
| 72 | 72 | |
| 73 | - if( ctype_alnum( $name ) === false ) |
|
| 73 | + if (ctype_alnum($name) === false) |
|
| 74 | 74 | { |
| 75 | - $classname = is_string( $name ) ? '\\Aimeos\\Client\\Html\\Catalog\\Session\\' . $name : '<not a string>'; |
|
| 76 | - throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid characters in class name "%1$s"', $classname ) ); |
|
| 75 | + $classname = is_string($name) ? '\\Aimeos\\Client\\Html\\Catalog\\Session\\'.$name : '<not a string>'; |
|
| 76 | + throw new \Aimeos\Client\Html\Exception(sprintf('Invalid characters in class name "%1$s"', $classname)); |
|
| 77 | 77 | } |
| 78 | 78 | |
| 79 | 79 | $iface = '\\Aimeos\\Client\\Html\\Iface'; |
| 80 | - $classname = '\\Aimeos\\Client\\Html\\Catalog\\Session\\' . $name; |
|
| 80 | + $classname = '\\Aimeos\\Client\\Html\\Catalog\\Session\\'.$name; |
|
| 81 | 81 | |
| 82 | - $client = self::createClientBase( $context, $classname, $iface, $templatePaths ); |
|
| 82 | + $client = self::createClientBase($context, $classname, $iface, $templatePaths); |
|
| 83 | 83 | |
| 84 | - return self::addClientDecorators( $context, $client, $templatePaths, 'catalog/session' ); |
|
| 84 | + return self::addClientDecorators($context, $client, $templatePaths, 'catalog/session'); |
|
| 85 | 85 | } |
| 86 | 86 | } |
| 87 | 87 | |
