CirrusSearch\Profile\SearchProfileRepositoryTransformer Class Reference

Transforms profile content based on a transformer implementation. More...

Inheritance diagram for CirrusSearch\Profile\SearchProfileRepositoryTransformer:

Collaboration diagram for CirrusSearch\Profile\SearchProfileRepositoryTransformer:

Public Member Functions
	__construct (SearchProfileRepository $repository, $transformer)
	repositoryType ()
	The repository type.
	repositoryName ()
	The repository name.
	getProfile ( $name)
	Load a profile named $name.
	hasProfile ( $name)
	Check if a profile named $name exists in this repository.
	listExposedProfiles ()
	Get the list of profiles that we want to expose to the user.

Detailed Description

Transforms profile content based on a transformer implementation.

Constructor & Destructor Documentation

__construct()

CirrusSearch\Profile\SearchProfileRepositoryTransformer::__construct	(	SearchProfileRepository	$repository,
			$transformer )

Parameters

SearchProfileRepository	$repository
array | ArrayPathSetter	$transformer

Member Function Documentation

getProfile()

CirrusSearch\Profile\SearchProfileRepositoryTransformer::getProfile

(

$name

)

Load a profile named $name.

Parameters

string

$name

Returns

array|null the profile data or null if not found

Implements CirrusSearch\Profile\SearchProfileRepository.

hasProfile()

CirrusSearch\Profile\SearchProfileRepositoryTransformer::hasProfile

(

$name

)

Check if a profile named $name exists in this repository.

Parameters

string

$name

Returns

bool

Implements CirrusSearch\Profile\SearchProfileRepository.

listExposedProfiles()

CirrusSearch\Profile\SearchProfileRepositoryTransformer::listExposedProfiles

(

)

Get the list of profiles that we want to expose to the user.

Returns

array[] list of profiles indexed by name

Implements CirrusSearch\Profile\SearchProfileRepository.

repositoryName()

CirrusSearch\Profile\SearchProfileRepositoryTransformer::repositoryName

(

)

The repository name.

Returns

string

Implements CirrusSearch\Profile\SearchProfileRepository.

repositoryType()

CirrusSearch\Profile\SearchProfileRepositoryTransformer::repositoryType

(

)

The repository type.

Returns

string

Implements CirrusSearch\Profile\SearchProfileRepository.

---

The documentation for this class was generated from the following file:

• includes/Profile/SearchProfileRepositoryTransformer.php