Documentation

People

Trait People

Provides ability to extract people and build their respective roles

Table of Contents

$people  : array<string|int, mixed>
Involved people (all roles)
actor()  : Role
Exports actor(s)
author()  : Role
Exports author(s)
composer()  : Role
Export composer(s)
director()  : Role
Exports director(s)
drawer()  : Role
Exports drawer(s)
editor()  : Role
Exports editor(s)
getRole()  : Role
Exports people of given role
illustrator()  : Role
Exports illustrator(s)
narrator()  : Role
Exports narrator(s)
original()  : Role
Exports original author(s
participant()  : Role
Exports participant(s)
people()  : Roles
Exports (just) involved people
photographer()  : Role
Exports photographer(s)
producer()  : Role
Exports producer(s)
translator()  : Role
Exports translator(s)
buildActor()  : array<string|int, mixed>
Builds actor(s)
buildAuthor()  : array<string|int, mixed>
Builds author(s)
buildComposer()  : array<string|int, mixed>
Builds composer(s)
buildDirector()  : array<string|int, mixed>
Builds director(s)
buildDrawer()  : array<string|int, mixed>
Builds drawer(s)
buildEditor()  : array<string|int, mixed>
Builds editor(s)
buildIllustrator()  : array<string|int, mixed>
Builds illustrator(s)
buildNarrator()  : array<string|int, mixed>
Builds narrator(s)
buildOriginal()  : array<string|int, mixed>
Builds original author(s)
buildParticipant()  : array<string|int, mixed>
Builds participant(s)
buildPhotographer()  : array<string|int, mixed>
Builds photographer(s)
buildProducer()  : array<string|int, mixed>
Builds producer(s)
buildTranslator()  : array<string|int, mixed>
Builds translator(s)
organizePeople()  : array<string|int, mixed>
Parses & organizes involved people by first & last name
setUpPeople()  : array<string|int, mixed>
Extracts involved people from raw data

Properties

$people

Involved people (all roles)

public array<string|int, mixed> $people

Methods

author()

Exports author(s)

public author() : Role
Return values
Role

composer()

Export composer(s)

public composer() : Role
Return values
Role

director()

Exports director(s)

public director() : Role
Return values
Role

drawer()

Exports drawer(s)

public drawer() : Role
Return values
Role

editor()

Exports editor(s)

public editor() : Role
Return values
Role

getRole()

Exports people of given role

public getRole(string $role) : Role
Parameters
$role : string

Role (= involvement)

Tags
throws
UnknownRoleException
Return values
Role

illustrator()

Exports illustrator(s)

public illustrator() : Role
Return values
Role

narrator()

Exports narrator(s)

public narrator() : Role
Return values
Role

original()

Exports original author(s

public original() : Role
Return values
Role

participant()

Exports participant(s)

public participant() : Role
Return values
Role

people()

Exports (just) involved people

public people() : Roles
Return values
Roles

photographer()

Exports photographer(s)

public photographer() : Role
Return values
Role

producer()

Exports producer(s)

public producer() : Role
Return values
Role

translator()

Exports translator(s)

public translator() : Role
Return values
Role

buildActor()

Builds actor(s)

protected buildActor() : array<string|int, mixed>
Return values
array<string|int, mixed>

buildAuthor()

Builds author(s)

protected buildAuthor() : array<string|int, mixed>
Return values
array<string|int, mixed>

buildComposer()

Builds composer(s)

protected buildComposer() : array<string|int, mixed>
Return values
array<string|int, mixed>

buildDirector()

Builds director(s)

protected buildDirector() : array<string|int, mixed>
Return values
array<string|int, mixed>

buildDrawer()

Builds drawer(s)

protected buildDrawer() : array<string|int, mixed>
Return values
array<string|int, mixed>

buildEditor()

Builds editor(s)

protected buildEditor() : array<string|int, mixed>
Return values
array<string|int, mixed>

buildIllustrator()

Builds illustrator(s)

protected buildIllustrator() : array<string|int, mixed>
Return values
array<string|int, mixed>

buildNarrator()

Builds narrator(s)

protected buildNarrator() : array<string|int, mixed>
Return values
array<string|int, mixed>

buildOriginal()

Builds original author(s)

protected buildOriginal() : array<string|int, mixed>
Return values
array<string|int, mixed>

buildParticipant()

Builds participant(s)

protected buildParticipant() : array<string|int, mixed>
Return values
array<string|int, mixed>

buildPhotographer()

Builds photographer(s)

protected buildPhotographer() : array<string|int, mixed>
Return values
array<string|int, mixed>

buildProducer()

Builds producer(s)

protected buildProducer() : array<string|int, mixed>
Return values
array<string|int, mixed>

buildTranslator()

Builds translator(s)

protected buildTranslator() : array<string|int, mixed>
Return values
array<string|int, mixed>

organizePeople()

Parses & organizes involved people by first & last name

protected organizePeople(string $string[, string $groupDelimiter = ';' ][, string $nameDelimiter = ',' ]) : array<string|int, mixed>

Example: 'Doe, John; Doe, Jane'

.. becomes ..

[ [ 'firstName' => 'John', 'lastName' => 'Doe', ], [ 'firstName' => 'Jane', 'lastName' => 'Doe', ], ]

Parameters
$string : string

Involved people

$groupDelimiter : string = ';'

Character between people

$nameDelimiter : string = ','

Character between first & last name

Return values
array<string|int, mixed>

setUpPeople()

Extracts involved people from raw data

protected setUpPeople() : array<string|int, mixed>

This includes the following roles by default:

  • author
  • original
  • illustrator
  • drawer
  • photographer
  • translator
  • narrator
  • composer
  • director
  • producer
  • actor
  • participant
Return values
array<string|int, mixed>

Search results