CBitrixComponent
CBitrixComponent class is used as the component wrapper. Separate CBitrixComponent class instance is created for each connected component. This class instance is active until the component is connected. Class methods inside this component are available via the variable alias $this.
| Method | Description | Available form version |
|---|---|---|
| StartResultCache | Updates support for the component internal caching. | |
| ShowComponentTemplate | Connects a component template. | 5.1.9 |
| SetTemplateCachedData | Returns to the template data to be saved in cache. | 5.1.9 |
| InitComponentTemplate | Initializes component template. | |
| IncludeComponentTemplate | Initializes and connects component template. | |
| GetTemplatePage | Returns component page name. | |
| GetTemplateName | Returns component template name. | |
| GetTemplateCachedData | Returns data to be saved in cache. | |
| GetTemplate | Returns reference to object of component template. | 12.0.0 |
| GetRelativePath | Returns component folder path relative to /bitrix/components. | |
| GetPath | Returns component folder path relative to site root. | |
| GetParent | Returns reference to object of the complex parent component. | 12.0.0 |
| GetName | Returns component name. | |
| AddIncludeAreaIcons | Adds array of new additional icons for component. | |
| AddIncludeAreaIcon | Adds a new icon to component icons. | |
| AbortResultCache | Updates support for the component internal caching. | |
| ClearResultCache | Updates support for the component internal caching. | |
| SetResultCacheKeys | Updates support for the component internal caching. | 7.0.14 |
| EndResultCache | Enables caching only of $arResult without html-code caching. The method is called at the end of the block that receives data, saved in cache (before closing bracket), and then IncludeComponentTemplate can be excluded from this block. | 5.1.8 |
© «Bitrix24», 2001-2024