Documentation

Problem
in package

Represents a problem detected while solving dependencies

Tags
author

Nils Adermann naderman@naderman.de

Table of Contents

$pool  : mixed
$reasons  : array<string|int, mixed>
A set of reasons for the problem, each is a rule or a job and a rule
$reasonSeen  : array<string|int, mixed>
A map containing the id of each rule part of this problem as a key
$section  : mixed
__construct()  : mixed
addRule()  : mixed
Add a rule as a reason
getPrettyString()  : string
A human readable textual representation of the problem's reasons
getReasons()  : array<string|int, mixed>
Retrieve all reasons for this problem
nextSection()  : mixed
addReason()  : mixed
Store a reason descriptor but ignore duplicates
constraintToText()  : string
Turns a constraint into text usable in a sentence describing a job
getPackageList()  : mixed
jobToText()  : string
Turns a job into a human readable description

Properties

$reasons

A set of reasons for the problem, each is a rule or a job and a rule

protected array<string|int, mixed> $reasons = array()

$reasonSeen

A map containing the id of each rule part of this problem as a key

protected array<string|int, mixed> $reasonSeen

$section

protected mixed $section = 0

Methods

__construct()

public __construct(Pool $pool) : mixed
Parameters
$pool : Pool
Return values
mixed

addRule()

Add a rule as a reason

public addRule(Rule $rule) : mixed
Parameters
$rule : Rule

A rule which is a reason for this problem

Return values
mixed

getPrettyString()

A human readable textual representation of the problem's reasons

public getPrettyString([array<string|int, mixed> $installedMap = array() ]) : string
Parameters
$installedMap : array<string|int, mixed> = array()

A map of all installed packages

Return values
string

getReasons()

Retrieve all reasons for this problem

public getReasons() : array<string|int, mixed>
Return values
array<string|int, mixed>

The problem's reasons

nextSection()

public nextSection() : mixed
Return values
mixed

addReason()

Store a reason descriptor but ignore duplicates

protected addReason(string $id, string $reason) : mixed
Parameters
$id : string

A canonical identifier for the reason

$reason : string

The reason descriptor

Return values
mixed

constraintToText()

Turns a constraint into text usable in a sentence describing a job

protected constraintToText(ConstraintInterface $constraint) : string
Parameters
$constraint : ConstraintInterface
Return values
string

getPackageList()

protected getPackageList(mixed $packages) : mixed
Parameters
$packages : mixed
Return values
mixed

jobToText()

Turns a job into a human readable description

protected jobToText(array<string|int, mixed> $job) : string
Parameters
$job : array<string|int, mixed>
Return values
string

Search results