Copied!

ContentSuggestion

ContentSuggestion.php : 14
Final
Extends Suggestion

The base class for all value objects and structs.

Supports read-only properties by marking them as protected. In this case they will only be writable using constructor, and need to be documented using @property-read <type> <$var> annotation in class doc in addition to inline property doc. Writable properties must be public and must be documented inline.

Methods

public__construct()

ContentSuggestion.php : 27

Construct object optionally with a set of properties.

 
public __construct(float $score, Content $content, ContentType $contentType[, string $pathString = '' ][, array<string|int, Location> $parentLocations = [] ])

Parameters

Name Type Default value Description
$score float - -
$content Content - -
$contentType ContentType - -
$pathString string '' -
$parentLocations array<string|int, Location> [] -

publicgetContent()

ContentSuggestion.php : 41 
public getContent() : Content

Return values

Content

publicgetContentType()

ContentSuggestion.php : 46 
public getContentType() : ContentType

Return values

ContentType

publicgetName()

Suggestion.php : 34 
public getName() : string|null

Return values

string|null

publicgetParentsLocation()

ContentSuggestion.php : 56 
public getParentsLocation() : ParentLocationCollection

Return values

ParentLocationCollection

publicgetPathString()

ContentSuggestion.php : 51 
public getPathString() : string

Return values

string

publicgetScore()

Suggestion.php : 29 
public getScore() : float

Return values

float

protectedgetProperties()

ValueObject.php : 54

Returns list of available properties' names.

 
protected getProperties([array<int, string> $dynamicProperties = [] ]) : array<int, string>

Override to add dynamic properties.

Parameters

Name Type Default value Description
$dynamicProperties array<int, string> []

Additional dynamic properties exposed on the object

Return values

array<int, string>

Tags
Serializerignore

()