Overview
  • Package
  • Class
  • Tree
  • Todo

Packages

  • AddonValue
    • Interfaces
  • ApiV2Controllers
  • Category
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • Customer
    • Address
    • Country
    • CountryZone
    • Interfaces
    • Validation
    • ValueObjects
  • Email
    • Collections
    • Entities
    • Exceptions
    • Interfaces
    • Repository
    • ValueObjects
  • Http
    • Collections
    • Exceptions
    • Factories
    • Interfaces
    • ValueObjects
  • Loaders
    • CrossCuttingLoader
    • GXCoreLoader
    • Interfaces
  • None
  • Order
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Storages
    • ValueObjects
  • Product
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • ProductModule
    • Collections
    • Deleter
    • Entities
    • Factories
    • Interface
    • Interfaces
    • Reader
    • Repositories
    • Writer
  • Shared
    • Exceptions
    • FileSystem
    • Interfaces
    • Storage
    • Types
  • Statistics
    • Interfaces
  • UserConfiguration
    • Interfaces
    • Repository

Classes

  • CategoryListProvider

Class CategoryListProvider

Class CategoryListProvider

This class provides methods for creating a list of flattened categories with just its essential data. The list of categories is filtered by its parent category ID and customer status permissions and for simplicity it contains language specific data only in one language.

CategoryListProvider implements CategoryListProviderInterface
Package: Category\Providers
Category: System
Located at CoreServices/Category/Providers/CategoryListProvider.inc.php

Methods summary

public
# __construct( LanguageCode $languageCode, array $conditions, CategoryRepositoryInterface $categoryRepo, CI_DB_query_builder $db )

CategoryListProvider constructor.

CategoryListProvider constructor.

Parameters

$languageCode
Two letter language code.
$conditions
Additional data request conditions.
$categoryRepo
$db Database connector.
$db
$categoryRepo Category repository.
public CategoryListItemCollection
# getByParentId( IdType $parentId )

Returns a category list based the parent ID provided.

Returns a category list based the parent ID provided.

Parameters

$parentId
Category parent ID.

Returns

CategoryListItemCollection

Implementation of

CategoryListProviderInterface::getByParentId()
protected CategoryListProvider
# _select( )

Build the select part of the query build.

Build the select part of the query build.

Returns

CategoryListProvider
Same instance for chained method calls.
protected CategoryListItemCollection
# _prepareCollection( array $result )

Prepares the CategoryListItemCollection object.

Prepares the CategoryListItemCollection object.

Parameters

$result
Query result.

Returns

CategoryListItemCollection

Properties summary

protected LanguageCode $languageCode

Language code.

Language code.

#
protected array $conditions

Array of conditions.

Array of conditions.

#
protected CI_DB_query_builder $db

Database query builder.

Database query builder.

#
protected CategoryRepositoryInterface $categoryRepo

Category Repository.

Category Repository.

#
API documentation generated by ApiGen