The following classes are used in development using the Information Block module.
CIBlockElement allows various types of operations on information blocks.
Method | Description |
---|---|
GetList | Returns a list of elements. Filters allowed. |
GetByID | Returns an element by its ID. |
GetElementGroups | Takes the element ID and returns sections to which the element is bound. |
GetProperty | Obtains the element properties. |
Add | Adds a new element. |
Update | Updates an element. |
Delete | Deletes an element from an information block. |
SetElementSection | Binds an information block element to sections. |
SetPropertyValues | Updates a set of the element properties. |
SetPropertyValueCode | Modifies the value of the element property. |
UpdateSearch | Indexes an element in the search module. |
CounterInc | Increments the element shows counter. |
CIBlockSection is the class for handling the information block sections.
Method | Description |
---|---|
GetList | Returns a filtered list of sections. |
GetByID | Returns a section by its ID. |
Add | Adds a new section to an information block. |
Update | Updates a section. |
Delete | Deletes a section from an information block. |
GetCount | Returns the number of sections. |
GetSectionElementsCount | Returns the number of elements in the section. |
GetTreeList | Returns a list of sections sorted in the order of the fully expanded tree. |
GetNavChain | Returns the path from the root to the section. |
ReSort | Recalculates the left and right margins. |
CIBlock is the general class for use with information blocks.
Method | Description |
---|---|
ShowPanel | Adds the block, section and element control buttons to the site toolbar. |
SetPermission | Assigns the user group permissions to access an information block. |
GetProperties | Returns the information block properties. |
GetGroupPermissions | Returns access permissions to the information block. |
GetPermission | Retrieves access permissions of the current user. |
GetList | Returns the filtered list of information blocks. |
GetByID | Returns the block by the ID. |
Add | Adds a new block. |
Update | Updates an information block. |
Delete | Deletes an information block. |
CIBlockProperty allows handling the information block properties.
Method | Description |
---|---|
GetList | Returns a filtered list of properties. |
GetByID | Returns a property by the ID. |
Add | Adds a new property. |
Update | Updates the property parameters. |
Delete | Deletes a property. |
GetPropertyEnum | Enumerates the LIST property variants. |
UpdateEnum | Updates the array of the property enumeration results. |
CIBlockPropertyEnum is used for handling values of properties of the type LIST.
Method | Description |
---|---|
GetList | Returns a filtered list of variants. |
Add | Adds a new variant. |
Update | Updates a variant. |
Delete | Deletes the property variant. |
CIBlockType provides the programming interface to the information block types.
Method | Description |
---|---|
GetList | Returns a filtered list of types. |
GetByID | Returns a type by the ID. |
Add | Adds a new type. |
Update | Updates a set of the type parameters. |
Delete | Delete the block type. |
CIBlockResult is the helper class for handling the results of operations.
Method | Description |
---|---|
GetNext | Returns an array of the selected fields. |
GetNextElement | Returns an instance of _CIBElement from the selection. |
_CIBElement is the helper class for handling the element selection objects.
Method | Description |
---|---|
GetFields | Returns the fields of an element. |
GetProperty | Returns the value of an element property. |
GetProperties | Returns values of a set of the element properties. |
GetGroups | Returns a list of sections to which the element is bound. |
© 2001-2005 Bitrix | Bitrix Site Manager - Content Management & Portal Solutions |