Class luya\web\jsonld\Person
| Inheritance | luya\web\jsonld\Person » luya\web\jsonld\BaseThing » yii\base\BaseObject |
|---|---|
| Implements | luya\web\jsonld\PersonInterface, luya\web\jsonld\ThingInterface, yii\base\Arrayable, yii\base\Configurable |
| Uses Traits | luya\web\jsonld\PersonTrait, luya\web\jsonld\ThingTrait, yii\base\ArrayableTrait |
| Available since version | 1.0.0 |
| Source Code | https://github.com/luyadev/luya/blob/master/core/web/jsonld/Person.php |
Public Properties
Public Methods
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| extractFieldsFor() | Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id". | yii\base\ArrayableTrait |
| extractRootFields() | Extracts the root field names from nested fields. | yii\base\ArrayableTrait |
| resolveFields() | Determines which fields can be returned by toArray(). | yii\base\ArrayableTrait |
Method Details
Defined in: yii\base\BaseObject::__call()
Calls the named method which is not a class method.
Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.
| public mixed __call ( $name, $params ) | ||
| $name | string |
The method name |
| $params | array |
Method parameters |
| return | mixed |
The method return value |
|---|---|---|
| throws | yii\base\UnknownMethodException |
when calling unknown method |
public function __call($name, $params)
{
throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
Defined in: yii\base\BaseObject::__construct()
Constructor.
The default implementation does two things:
- Initializes the object with the given configuration
$config. - Call init().
If this method is overridden in a child class, it is recommended that
- the last parameter of the constructor is a configuration array, like
$confighere. - call the parent implementation at the end of the constructor.
| public void __construct ( $config = [] ) | ||
| $config | array |
Name-value pairs that will be used to initialize the object properties |
public function __construct($config = [])
{
if (!empty($config)) {
Yii::configure($this, $config);
}
$this->init();
}
Defined in: yii\base\BaseObject::__get()
Returns the value of an object property.
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing $value = $object->property;.
See also __set().
| public mixed __get ( $name ) | ||
| $name | string |
The property name |
| return | mixed |
The property value |
|---|---|---|
| throws | yii\base\UnknownPropertyException |
if the property is not defined |
| throws | yii\base\InvalidCallException |
if the property is write-only |
public function __get($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter();
} elseif (method_exists($this, 'set' . $name)) {
throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
Defined in: yii\base\BaseObject::__isset()
Checks if a property is set, i.e. defined and not null.
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing isset($object->property).
Note that if the property is not defined, false will be returned.
| public boolean __isset ( $name ) | ||
| $name | string |
The property name or the event name |
| return | boolean |
Whether the named property is set (not null). |
|---|---|---|
public function __isset($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter() !== null;
}
return false;
}
Defined in: yii\base\BaseObject::__set()
Sets value of an object property.
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing $object->property = $value;.
See also __get().
| public void __set ( $name, $value ) | ||
| $name | string |
The property name or the event name |
| $value | mixed |
The property value |
| throws | yii\base\UnknownPropertyException |
if the property is not defined |
|---|---|---|
| throws | yii\base\InvalidCallException |
if the property is read-only |
public function __set($name, $value)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter($value);
} elseif (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
} else {
throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}
}
Defined in: yii\base\BaseObject::__unset()
Sets an object property to null.
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing unset($object->property).
Note that if the property is not defined, this method will do nothing. If the property is read-only, it will throw an exception.
| public void __unset ( $name ) | ||
| $name | string |
The property name |
| throws | yii\base\InvalidCallException |
if the property is read only. |
|---|---|---|
public function __unset($name)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter(null);
} elseif (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
}
}
Defined in: yii\base\BaseObject::canGetProperty()
Returns a value indicating whether a property can be read.
A property is readable if:
- the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVarsis true);
See also canSetProperty().
| public boolean canGetProperty ( $name, $checkVars = true ) | ||
| $name | string |
The property name |
| $checkVars | boolean |
Whether to treat member variables as properties |
| return | boolean |
Whether the property can be read |
|---|---|---|
public function canGetProperty($name, $checkVars = true)
{
return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
Defined in: yii\base\BaseObject::canSetProperty()
Returns a value indicating whether a property can be set.
A property is writable if:
- the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVarsis true);
See also canGetProperty().
| public boolean canSetProperty ( $name, $checkVars = true ) | ||
| $name | string |
The property name |
| $checkVars | boolean |
Whether to treat member variables as properties |
| return | boolean |
Whether the property can be written |
|---|---|---|
public function canSetProperty($name, $checkVars = true)
{
return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
::class instead.
Defined in: yii\base\BaseObject::className()
Returns the fully qualified name of this class.
| public static string className ( ) | ||
| return | string |
The fully qualified name of this class. |
|---|---|---|
public static function className()
{
return get_called_class();
}
Defined in: yii\base\ArrayableTrait::extraFields()
Returns the list of fields that can be expanded further and returned by toArray().
This method is similar to fields() except that the list of fields returned by this method are not returned by default by toArray(). Only when field names to be expanded are explicitly specified when calling toArray(), will their values be exported.
The default implementation returns an empty array.
You may override this method to return a list of expandable fields based on some context information (e.g. the current application user).
See also:
| public array extraFields ( ) | ||
| return | array |
The list of expandable field names or field definitions. Please refer to fields() on the format of the return value. |
|---|---|---|
public function extraFields()
{
return [];
}
Defined in: yii\base\ArrayableTrait::extractFieldsFor()
Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id".
| protected array extractFieldsFor ( array $fields, $rootField ) | ||
| $fields | array |
The fields requested for extraction |
| $rootField | string |
The root field for which we want to extract the nested fields |
| return | array |
Nested fields extracted for the given field |
|---|---|---|
protected function extractFieldsFor(array $fields, $rootField)
{
$result = [];
foreach ($fields as $field) {
if (0 === strpos($field, "{$rootField}.")) {
$result[] = preg_replace('/^' . preg_quote($rootField, '/') . '\./i', '', $field);
}
}
return array_unique($result);
}
Defined in: yii\base\ArrayableTrait::extractRootFields()
Extracts the root field names from nested fields.
Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "item".
| protected array extractRootFields ( array $fields ) | ||
| $fields | array |
The fields requested for extraction |
| return | array |
Root fields extracted from the given nested fields |
|---|---|---|
protected function extractRootFields(array $fields)
{
$result = [];
foreach ($fields as $field) {
$result[] = current(explode('.', $field, 2));
}
if (in_array('*', $result, true)) {
$result = [];
}
return array_unique($result);
}
Defined in: luya\web\jsonld\BaseThing::fields()
Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.
A field is a named element in the returned array by toArray().
This method should return an array of field names or field definitions. If the former, the field name will be treated as an object property name whose value will be used as the field value. If the latter, the array key should be the field name while the array value should be the corresponding field definition which can be either an object property name or a PHP callable returning the corresponding field value. The signature of the callable should be:
function ($model, $field) {
// return field value
}
For example, the following code declares four fields:
email: the field name is the same as the property nameemail;firstNameandlastName: the field names arefirstNameandlastName, and their values are obtained from thefirst_nameandlast_nameproperties;fullName: the field name isfullName. Its value is obtained by concatenatingfirst_nameandlast_name.
return [
'email',
'firstName' => 'first_name',
'lastName' => 'last_name',
'fullName' => function ($model) {
return $model->first_name . ' ' . $model->last_name;
},
];
| public array fields ( ) | ||
| return | array |
The list of field names or field definitions. |
|---|---|---|
public function fields()
{
return $this->resolveGetterMethods();
}
Defined in: luya\web\jsonld\PersonTrait::getAdditionalName()
| public string getAdditionalName ( ) |
public function getAdditionalName()
{
return $this->_additionalName;
}
Defined in: luya\web\jsonld\ThingTrait::getAdditionalType()
| public string getAdditionalType ( ) |
public function getAdditionalType()
{
return $this->_additionalType;
}
Defined in: luya\web\jsonld\PersonTrait::getAddress()
| public luya\web\jsonld\PostalAddress|string getAddress ( ) |
public function getAddress()
{
return $this->_address;
}
Defined in: luya\web\jsonld\PersonTrait::getAffiliation()
| public luya\web\jsonld\Organization getAffiliation ( ) |
public function getAffiliation()
{
return $this->_affiliation;
}
Defined in: luya\web\jsonld\ThingTrait::getAlternateName()
| public string getAlternateName ( ) |
public function getAlternateName()
{
return $this->_alternateName;
}
Defined in: luya\web\jsonld\PersonTrait::getAward()
| public string getAward ( ) |
public function getAward()
{
return $this->_award;
}
Defined in: luya\web\jsonld\PersonTrait::getBirthDate()
| public string getBirthDate ( ) |
public function getBirthDate()
{
return $this->_birthDate;
}
Defined in: luya\web\jsonld\PersonTrait::getBirthPlace()
| public luya\web\jsonld\Place getBirthPlace ( ) |
public function getBirthPlace()
{
return $this->_birthPlace;
}
Defined in: luya\web\jsonld\PersonTrait::getBrand()
| public \luya\web\jsonld\Brand|luya\web\jsonld\Organization getBrand ( ) |
public function getBrand()
{
return $this->_brand;
}
Defined in: luya\web\jsonld\PersonTrait::getChildren()
| public luya\web\jsonld\Person getChildren ( ) |
public function getChildren()
{
return $this->_children;
}
Defined in: luya\web\jsonld\PersonTrait::getColleague()
| public luya\web\jsonld\Person getColleague ( ) |
public function getColleague()
{
return $this->_colleague;
}
Defined in: luya\web\jsonld\PersonTrait::getContactPoint()
| public luya\web\jsonld\ContactPoint getContactPoint ( ) |
public function getContactPoint()
{
return $this->_contactPoint;
}
Defined in: luya\web\jsonld\PersonTrait::getDeathDate()
| public string getDeathDate ( ) |
public function getDeathDate()
{
return $this->_deathDate;
}
Defined in: luya\web\jsonld\PersonTrait::getDeathPlace()
| public luya\web\jsonld\Place getDeathPlace ( ) |
public function getDeathPlace()
{
return $this->_deathPlace;
}
Defined in: luya\web\jsonld\ThingTrait::getDescription()
| public string getDescription ( ) |
public function getDescription()
{
return $this->_description;
}
| public string getDisambiguatingDescription ( ) |
public function getDisambiguatingDescription()
{
return $this->_disambiguatingDescription;
}
Defined in: luya\web\jsonld\PersonTrait::getDuns()
| public string getDuns ( ) |
public function getDuns()
{
return $this->_duns;
}
Defined in: luya\web\jsonld\PersonTrait::getEmail()
| public string getEmail ( ) |
public function getEmail()
{
return $this->_email;
}
Defined in: luya\web\jsonld\PersonTrait::getFamilyName()
| public string getFamilyName ( ) |
public function getFamilyName()
{
return $this->_familyName;
}
Defined in: luya\web\jsonld\PersonTrait::getFaxNumber()
| public string getFaxNumber ( ) |
public function getFaxNumber()
{
return $this->_faxNumber;
}
Defined in: luya\web\jsonld\PersonTrait::getFollows()
| public luya\web\jsonld\Person getFollows ( ) |
public function getFollows()
{
return $this->_follows;
}
Defined in: luya\web\jsonld\PersonTrait::getFunder()
| public luya\web\jsonld\Organization|luya\web\jsonld\Person getFunder ( ) |
public function getFunder()
{
return $this->_funder;
}
Defined in: luya\web\jsonld\PersonTrait::getGender()
| public \luya\web\jsonld\GenderType|string getGender ( ) |
public function getGender()
{
return $this->_gender;
}
Defined in: luya\web\jsonld\PersonTrait::getGivenName()
| public string getGivenName ( ) |
public function getGivenName()
{
return $this->_givenName;
}
| public string getGlobalLocationNumber ( ) |
public function getGlobalLocationNumber()
{
return $this->_globalLocationNumber;
}
Defined in: luya\web\jsonld\PersonTrait::getHasPOS()
| public luya\web\jsonld\Place getHasPOS ( ) |
public function getHasPOS()
{
return $this->_hasPOS;
}
Defined in: luya\web\jsonld\PersonTrait::getHeight()
| public \luya\web\jsonld\Distance|\luya\web\jsonld\QuantitativeValue getHeight ( ) |
public function getHeight()
{
return $this->_height;
}
Defined in: luya\web\jsonld\PersonTrait::getHomeLocation()
| public luya\web\jsonld\ContactPoint|luya\web\jsonld\Place getHomeLocation ( ) |
public function getHomeLocation()
{
return $this->_homeLocation;
}
| public string getHonorificPrefix ( ) |
public function getHonorificPrefix()
{
return $this->_honorificPrefix;
}
| public string getHonorificSuffix ( ) |
public function getHonorificSuffix()
{
return $this->_honorificSuffix;
}
Defined in: luya\web\jsonld\ThingTrait::getIdentifier()
| public luya\web\jsonld\PropertyValue getIdentifier ( ) |
public function getIdentifier()
{
return $this->_identifier;
}
Defined in: luya\web\jsonld\ThingTrait::getImage()
| public luya\web\jsonld\ImageObject getImage ( ) |
public function getImage()
{
return $this->_image;
}
Defined in: luya\web\jsonld\PersonTrait::getIsicV4()
| public string getIsicV4 ( ) |
public function getIsicV4()
{
return $this->_isicV4;
}
Defined in: luya\web\jsonld\PersonTrait::getJobTitle()
| public string getJobTitle ( ) |
public function getJobTitle()
{
return $this->_jobTitle;
}
Defined in: luya\web\jsonld\PersonTrait::getKnows()
| public luya\web\jsonld\Person getKnows ( ) |
public function getKnows()
{
return $this->_knows;
}
| public luya\web\jsonld\CreativeWork getMainEntityOfPage ( ) |
public function getMainEntityOfPage()
{
return $this->_mainEntityOfPage;
}
Defined in: luya\web\jsonld\PersonTrait::getMakesOffer()
| public luya\web\jsonld\Offer getMakesOffer ( ) |
public function getMakesOffer()
{
return $this->_makesOffer;
}
Defined in: luya\web\jsonld\PersonTrait::getMemberOf()
| public luya\web\jsonld\Organization|\luya\web\jsonld\ProgramMembership getMemberOf ( ) |
public function getMemberOf()
{
return $this->_memberOf;
}
Defined in: luya\web\jsonld\PersonTrait::getNaics()
| public string getNaics ( ) |
public function getNaics()
{
return $this->_naics;
}
Defined in: luya\web\jsonld\ThingTrait::getName()
| public string getName ( ) |
public function getName()
{
return $this->_name;
}
Defined in: luya\web\jsonld\PersonTrait::getNationality()
| public luya\web\jsonld\Country getNationality ( ) |
public function getNationality()
{
return $this->_nationality;
}
Defined in: luya\web\jsonld\ThingTrait::getOffers()
Get Offer
| public luya\web\jsonld\Offer getOffers ( ) |
public function getOffers()
{
return $this->_offers;
}
Defined in: luya\web\jsonld\PersonTrait::getParent()
| public luya\web\jsonld\Person getParent ( ) |
public function getParent()
{
return $this->_parent;
}
Defined in: luya\web\jsonld\PersonTrait::getPerformerIn()
| public luya\web\jsonld\Event getPerformerIn ( ) |
public function getPerformerIn()
{
return $this->_performerIn;
}
| public luya\web\jsonld\CreativeWork|\luya\web\jsonld\URL getPublishingPrinciples ( ) |
public function getPublishingPrinciples()
{
return $this->_publishingPrinciples;
}
Defined in: luya\web\jsonld\PersonTrait::getRelatedTo()
| public luya\web\jsonld\Person getRelatedTo ( ) |
public function getRelatedTo()
{
return $this->_relatedTo;
}
Defined in: luya\web\jsonld\ThingTrait::getSameAs()
| public string getSameAs ( ) |
public function getSameAs()
{
return $this->_sameAs;
}
Defined in: luya\web\jsonld\PersonTrait::getSibling()
| public luya\web\jsonld\Person getSibling ( ) |
public function getSibling()
{
return $this->_sibling;
}
Defined in: luya\web\jsonld\PersonTrait::getSponsor()
| public luya\web\jsonld\Organization|luya\web\jsonld\Person getSponsor ( ) |
public function getSponsor()
{
return $this->_sponsor;
}
Defined in: luya\web\jsonld\PersonTrait::getSpouse()
| public luya\web\jsonld\Person getSpouse ( ) |
public function getSpouse()
{
return $this->_spouse;
}
Defined in: luya\web\jsonld\ThingTrait::getSubjectOf()
| public luya\web\jsonld\CreativeWork|luya\web\jsonld\Event getSubjectOf ( ) |
public function getSubjectOf()
{
return $this->_subjectOf;
}
Defined in: luya\web\jsonld\PersonTrait::getTaxID()
| public string getTaxID ( ) |
public function getTaxID()
{
return $this->_taxID;
}
Defined in: luya\web\jsonld\PersonTrait::getTelephone()
| public string getTelephone ( ) |
public function getTelephone()
{
return $this->_telephone;
}
Defined in: luya\web\jsonld\ThingTrait::getUrl()
| public string getUrl ( ) |
public function getUrl()
{
return $this->_url;
}
Defined in: luya\web\jsonld\PersonTrait::getVatID()
| public string getVatID ( ) |
public function getVatID()
{
return $this->_vatID;
}
Defined in: luya\web\jsonld\PersonTrait::getWorkLocation()
| public luya\web\jsonld\ContactPoint|luya\web\jsonld\Place getWorkLocation ( ) |
public function getWorkLocation()
{
return $this->_workLocation;
}
Defined in: luya\web\jsonld\PersonTrait::getWorksFor()
| public luya\web\jsonld\Organization getWorksFor ( ) |
public function getWorksFor()
{
return $this->_worksFor;
}
Defined in: yii\base\BaseObject::hasMethod()
Returns a value indicating whether a method is defined.
The default implementation is a call to php function method_exists().
You may override this method when you implemented the php magic method __call().
| public boolean hasMethod ( $name ) | ||
| $name | string |
The method name |
| return | boolean |
Whether the method is defined |
|---|---|---|
public function hasMethod($name)
{
return method_exists($this, $name);
}
Defined in: yii\base\BaseObject::hasProperty()
Returns a value indicating whether a property is defined.
A property is defined if:
- the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVarsis true);
See also:
| public boolean hasProperty ( $name, $checkVars = true ) | ||
| $name | string |
The property name |
| $checkVars | boolean |
Whether to treat member variables as properties |
| return | boolean |
Whether the property is defined |
|---|---|---|
public function hasProperty($name, $checkVars = true)
{
return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
Defined in: yii\base\BaseObject::init()
Initializes the object.
This method is invoked at the end of the constructor after the object is initialized with the given configuration.
| public void init ( ) |
public function init()
{
}
Defined in: yii\base\ArrayableTrait::resolveFields()
Determines which fields can be returned by toArray().
This method will first extract the root fields from the given fields. Then it will check the requested root fields against those declared in fields() and extraFields() to determine which fields can be returned.
| protected array resolveFields ( array $fields, array $expand ) | ||
| $fields | array |
The fields being requested for exporting |
| $expand | array |
The additional fields being requested for exporting |
| return | array |
The list of fields to be exported. The array keys are the field names, and the array values are the corresponding object property names or PHP callables returning the field values. |
|---|---|---|
protected function resolveFields(array $fields, array $expand)
{
$fields = $this->extractRootFields($fields);
$expand = $this->extractRootFields($expand);
$result = [];
foreach ($this->fields() as $field => $definition) {
if (is_int($field)) {
$field = $definition;
}
if (empty($fields) || in_array($field, $fields, true)) {
$result[$field] = $definition;
}
}
if (empty($expand)) {
return $result;
}
foreach ($this->extraFields() as $field => $definition) {
if (is_int($field)) {
$field = $definition;
}
if (in_array($field, $expand, true)) {
$result[$field] = $definition;
}
}
return $result;
}
Defined in: luya\web\jsonld\BaseThing::resolveGetterMethods()
Find all getter methods.
| public array resolveGetterMethods ( ) |
public function resolveGetterMethods()
{
$resolved = [];
$methods = get_class_methods($this);
if (!$methods) {
return [];
}
foreach ($methods as $method) {
if (StringHelper::startsWith($method, 'get', true)) {
$resolved[] = lcfirst(StringHelper::replaceFirst('get', '', $method));
}
}
asort($resolved);
return $resolved;
}
Defined in: luya\web\jsonld\PersonTrait::setAdditionalName()
An additional name for a Person, can be used for a middle name.
| public static setAdditionalName ( $additionalName ) | ||
| $additionalName | string | |
public function setAdditionalName($additionalName)
{
$this->_additionalName = $additionalName;
return $this;
}
Defined in: luya\web\jsonld\ThingTrait::setAdditionalType()
An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax.
This is a relationship between something and a class that the thing is in.
| public static setAdditionalType ( luya\web\jsonld\UrlValue $additionalType ) | ||
| $additionalType | string | |
public function setAdditionalType(UrlValue $additionalType)
{
$this->_additionalType = $additionalType->getValue();
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setAddress()
Physical address of the item.
| public static setAddress ( luya\web\jsonld\PostalAddress $address ) | ||
| $address | luya\web\jsonld\PostalAddress|string | |
public function setAddress(PostalAddress $address)
{
$this->_address = $address;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setAffiliation()
An organization that this person is affiliated with. For example, a school/university, a club, or a team.
| public static setAffiliation ( luya\web\jsonld\Organization $affiliation ) | ||
| $affiliation | luya\web\jsonld\Organization | |
public function setAffiliation(Organization $affiliation)
{
$this->_affiliation = $affiliation;
return $this;
}
Defined in: luya\web\jsonld\ThingTrait::setAlternateName()
An alias for the item
| public static setAlternateName ( $alternateName ) | ||
| $alternateName | string | |
public function setAlternateName($alternateName)
{
$this->_alternateName = $alternateName;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setAward()
An award won by or for this item.
Supersedes awards.
| public static setAward ( $award ) | ||
| $award | string | |
public function setAward($award)
{
$this->_award = $award;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setBirthDate()
Date of birth.
| public static setBirthDate ( luya\web\jsonld\DateValue $birthDate ) | ||
| $birthDate | luya\web\jsonld\DateValue | |
public function setBirthDate(DateValue $birthDate)
{
$this->_birthDate = $birthDate->getValue();
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setBirthPlace()
The place where the person was born.
| public static setBirthPlace ( $birthPlace ) | ||
| $birthPlace | luya\web\jsonld\Place | |
public function setBirthPlace($birthPlace)
{
$this->_birthPlace = $birthPlace;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setBrand()
The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.
| public static setBrand ( $brand ) | ||
| $brand | \luya\web\jsonld\Brand|luya\web\jsonld\Organization | |
public function setBrand($brand)
{
$this->_brand = $brand;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setChildren()
A child of the person.
| public static setChildren ( luya\web\jsonld\Person $children ) | ||
| $children | luya\web\jsonld\Person | |
public function setChildren(Person $children)
{
$this->_children = $children;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setColleague()
A colleague of the person.
Supersedes colleagues.
| public static setColleague ( luya\web\jsonld\Person $colleague ) | ||
| $colleague | luya\web\jsonld\Person | |
public function setColleague(Person $colleague)
{
$this->_colleague = $colleague;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setContactPoint()
A contact point for a person or organization.
Supersedes contactPoints.
| public static setContactPoint ( luya\web\jsonld\ContactPoint $contactPoint ) | ||
| $contactPoint | luya\web\jsonld\ContactPoint | |
public function setContactPoint(ContactPoint $contactPoint)
{
$this->_contactPoint = $contactPoint;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setDeathDate()
Date of death.
| public static setDeathDate ( luya\web\jsonld\DateValue $deathDate ) | ||
| $deathDate | luya\web\jsonld\DateValue | |
public function setDeathDate(DateValue $deathDate)
{
$this->_deathDate = $deathDate->getValue();
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setDeathPlace()
The place where the person died.
| public static setDeathPlace ( luya\web\jsonld\Place $deathPlace ) | ||
| $deathPlace | luya\web\jsonld\Place | |
public function setDeathPlace(Place $deathPlace)
{
$this->_deathPlace = $deathPlace;
return $this;
}
Defined in: luya\web\jsonld\ThingTrait::setDescription()
A description of the item.
| public static setDescription ( $description ) | ||
| $description | string | |
public function setDescription($description)
{
$this->_description = $description;
return $this;
}
Defined in: luya\web\jsonld\ThingTrait::setDisambiguatingDescription()
A sub property of description. A short description of the item used to disambiguate from other, similar items.
Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
| public static setDisambiguatingDescription ( $disambiguatingDescription ) | ||
| $disambiguatingDescription | string | |
public function setDisambiguatingDescription($disambiguatingDescription)
{
$this->_disambiguatingDescription = $disambiguatingDescription;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setDuns()
The Dun & Bradstreet DUNS number for identifying an organization or business person.
| public static setDuns ( luya\web\jsonld\Person $duns ) | ||
| $duns | string | |
public function setDuns(Person $duns)
{
$this->_duns = $duns;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setEmail()
Email address.
| public static setEmail ( $email ) | ||
| string | ||
public function setEmail($email)
{
$this->_email = $email;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setFamilyName()
Family name. In the U.S., the last name of an Person.
This can be used along with givenName instead of the name property.
| public static setFamilyName ( $familyName ) | ||
| $familyName | string | |
public function setFamilyName($familyName)
{
$this->_familyName = $familyName;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setFaxNumber()
The fax number.
| public static setFaxNumber ( $faxNumber ) | ||
| $faxNumber | string | |
public function setFaxNumber($faxNumber)
{
$this->_faxNumber = $faxNumber;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setFollows()
The most generic uni-directional social relation.
| public static setFollows ( luya\web\jsonld\Person $follows ) | ||
| $follows | luya\web\jsonld\Person | |
public function setFollows(Person $follows)
{
$this->_follows = $follows;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setFunder()
A person or organization that supports (sponsors) something through some kind of financial contribution.
| public static setFunder ( $funder ) | ||
| $funder | luya\web\jsonld\Organization|luya\web\jsonld\Person | |
public function setFunder($funder)
{
ObjectHelper::isInstanceOf($funder, [Organization::class, PersonInterface::class]);
$this->_funder = $funder;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setGender()
Gender of the person. While http://schema.org/Male and http://schema.org/Female may be used, text strings are also acceptable for people who do not identify as a binary gender.
| public static setGender ( $gender ) | ||
| $gender | \luya\web\jsonld\GenderType|string | |
public function setGender($gender)
{
$this->_gender = $gender;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setGivenName()
Given name. In the U.S., the first name of a Person.
This can be used along with familyName instead of the name property.
| public static setGivenName ( $givenName ) | ||
| $givenName | string | |
public function setGivenName($givenName)
{
$this->_givenName = $givenName;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setGlobalLocationNumber()
The Global Location Number (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place.
The GLN is a 13-digit number used to identify parties and physical locations.
| public static setGlobalLocationNumber ( $globalLocationNumber ) | ||
| $globalLocationNumber | string | |
public function setGlobalLocationNumber($globalLocationNumber)
{
$this->_globalLocationNumber = $globalLocationNumber;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setHasPOS()
Points-of-Sales operated by the organization or person.
| public static setHasPOS ( $hasPOS ) | ||
| $hasPOS | luya\web\jsonld\Place | |
public function setHasPOS($hasPOS)
{
$this->_hasPOS = $hasPOS;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setHeight()
The height of the item.
| public static setHeight ( $height ) | ||
| $height | \luya\web\jsonld\Distance|\luya\web\jsonld\QuantitativeValue | |
public function setHeight($height)
{
$this->_height = $height;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setHomeLocation()
A contact location for a person's residence.
| public static setHomeLocation ( $homeLocation ) | ||
| $homeLocation | luya\web\jsonld\ContactPoint|luya\web\jsonld\Place | |
public function setHomeLocation($homeLocation)
{
$this->_homeLocation = $homeLocation;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setHonorificPrefix()
An honorific prefix preceding a Person's name such as Dr/Mrs/Mr.
| public static setHonorificPrefix ( $honorificPrefix ) | ||
| $honorificPrefix | string | |
public function setHonorificPrefix($honorificPrefix)
{
$this->_honorificPrefix = $honorificPrefix;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setHonorificSuffix()
An honorific suffix preceding a Person's name such as M.D. /PhD/MSCSW.
| public static setHonorificSuffix ( $honorificSuffix ) | ||
| $honorificSuffix | string | |
public function setHonorificSuffix($honorificSuffix)
{
$this->_honorificSuffix = $honorificSuffix;
return $this;
}
Defined in: luya\web\jsonld\ThingTrait::setIdentifier()
The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details.
| public static setIdentifier ( luya\web\jsonld\PropertyValue $identifier ) | ||
| $identifier | luya\web\jsonld\PropertyValue | |
public function setIdentifier(PropertyValue $identifier)
{
$this->_identifier = $identifier;
return $this;
}
Defined in: luya\web\jsonld\ThingTrait::setImage()
An image of the item.
This can be a URL or a fully described ImageObject.
| public static setImage ( luya\web\jsonld\ImageObject $image ) | ||
| $image | luya\web\jsonld\ImageObject | |
public function setImage(ImageObject $image)
{
$this->_image = $image;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setIsicV4()
The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
| public static setIsicV4 ( $isicV4 ) | ||
| $isicV4 | string | |
public function setIsicV4($isicV4)
{
$this->_isicV4 = $isicV4;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setJobTitle()
The job title of the person (for example, Financial Manager).
| public static setJobTitle ( $jobTitle ) | ||
| $jobTitle | string | |
public function setJobTitle($jobTitle)
{
$this->_jobTitle = $jobTitle;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setKnows()
The most generic bi-directional social/work relation.
| public static setKnows ( luya\web\jsonld\Person $knows ) | ||
| $knows | luya\web\jsonld\Person | |
public function setKnows(Person $knows)
{
$this->_knows = $knows;
return $this;
}
Defined in: luya\web\jsonld\ThingTrait::setMainEntityOfPage()
Indicates a page (or other CreativeWork) for which this thing is the main entity being described.
Inverse property: mainEntity.
| public static setMainEntityOfPage ( luya\web\jsonld\CreativeWork $mainEntityOfPage ) | ||
| $mainEntityOfPage | luya\web\jsonld\CreativeWork | |
public function setMainEntityOfPage(CreativeWork $mainEntityOfPage)
{
$this->_mainEntityOfPage = $mainEntityOfPage;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setMakesOffer()
A pointer to products or services offered by the organization or person.
Inverse property: offeredBy.
| public static setMakesOffer ( luya\web\jsonld\Offer $makesOffer ) | ||
| $makesOffer | luya\web\jsonld\Offer | |
public function setMakesOffer(Offer $makesOffer)
{
$this->_makesOffer = $makesOffer;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setMemberOf()
An Organization (or ProgramMembership) to which this Person or Organization belongs.
Inverse property: member.
| public static setMemberOf ( $memberOf ) | ||
| $memberOf | luya\web\jsonld\Organization|\luya\web\jsonld\ProgramMembership | |
public function setMemberOf($memberOf)
{
$this->_memberOf = $memberOf;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setNaics()
The North American Industry Classification System (NAICS) code for a particular organization or business person.
| public static setNaics ( $naics ) | ||
| $naics | string | |
public function setNaics($naics)
{
$this->_naics = $naics;
return $this;
}
Defined in: luya\web\jsonld\ThingTrait::setName()
The name of the item.
| public static setName ( $name ) | ||
| $name | string | |
public function setName($name)
{
$this->_name = $name;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setNationality()
Nationality of the person.
| public static setNationality ( luya\web\jsonld\Country $nationality ) | ||
| $nationality | luya\web\jsonld\Country | |
public function setNationality(Country $nationality)
{
$this->_nationality = $nationality;
return $this;
}
Defined in: luya\web\jsonld\ThingTrait::setOffers()
Set Offer
| public static setOffers ( luya\web\jsonld\Offer $offers ) | ||
| $offers | ||
public function setOffers(Offer $offers)
{
$this->_offers = $offers;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setParent()
A parent of this person. Supersedes parents.
| public static setParent ( luya\web\jsonld\Person $parent ) | ||
| $parent | luya\web\jsonld\Person | |
public function setParent(Person $parent)
{
$this->_parent = $parent;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setPerformerIn()
Event that this person is a performer or participant in.
| public static setPerformerIn ( luya\web\jsonld\Event $performerIn ) | ||
| $performerIn | luya\web\jsonld\Event | |
public function setPerformerIn(Event $performerIn)
{
$this->_performerIn = $performerIn;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setPublishingPrinciples()
The publishingPrinciples property indicates (typically via URL) a document describing the editorial principles of an Organization (or individual e.g. a Person writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a CreativeWork (e.g. NewsArticle) the principles are those of the party primarily responsible for the creation of the CreativeWork.
While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a funder) can be expressed using schema.org terminology.
| public static setPublishingPrinciples ( $publishingPrinciples ) | ||
| $publishingPrinciples | luya\web\jsonld\CreativeWork|\luya\web\jsonld\URL | |
public function setPublishingPrinciples($publishingPrinciples)
{
$this->_publishingPrinciples = $publishingPrinciples;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setRelatedTo()
The most generic familial relation.
| public static setRelatedTo ( luya\web\jsonld\Person $relatedTo ) | ||
| $relatedTo | luya\web\jsonld\Person | |
public function setRelatedTo(Person $relatedTo)
{
$this->_relatedTo = $relatedTo;
return $this;
}
Defined in: luya\web\jsonld\ThingTrait::setSameAs()
URL of a reference Web page that unambiguously indicates the item's identity.
E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
| public static setSameAs ( luya\web\jsonld\UrlValue $sameAs ) | ||
| $sameAs | luya\web\jsonld\UrlValue | |
public function setSameAs(UrlValue $sameAs)
{
$this->_sameAs = $sameAs->getValue();
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setSibling()
A sibling of the person. Supersedes siblings.
| public static setSibling ( luya\web\jsonld\Person $sibling ) | ||
| $sibling | luya\web\jsonld\Person | |
public function setSibling(Person $sibling)
{
$this->_sibling = $sibling;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setSponsor()
A person or organization that supports a thing through a pledge, promise, or financial contribution.
e.g. a sponsor of a Medical Study or a corporate sponsor of an event.
| public static setSponsor ( $sponsor ) | ||
| $sponsor | luya\web\jsonld\Organization|luya\web\jsonld\Person | |
public function setSponsor($sponsor)
{
ObjectHelper::isInstanceOf($sponsor, [Organization::class, PersonInterface::class]);
$this->_sponsor = $sponsor;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setSpouse()
The person's spouse.
| public static setSpouse ( luya\web\jsonld\Person $spouse ) | ||
| $spouse | luya\web\jsonld\Person | |
public function setSpouse(Person $spouse)
{
$this->_spouse = $spouse;
return $this;
}
Defined in: luya\web\jsonld\ThingTrait::setSubjectOf()
A CreativeWork or Event about this Thing.
Inverse property: about.
| public static setSubjectOf ( $subjectOf ) | ||
| $subjectOf | luya\web\jsonld\CreativeWork|luya\web\jsonld\Event | |
public function setSubjectOf($subjectOf)
{
$this->_subjectOf = $subjectOf;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setTaxID()
The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in Spain.
| public static setTaxID ( $taxID ) | ||
| $taxID | string | |
public function setTaxID($taxID)
{
$this->_taxID = $taxID;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setTelephone()
The telephone number.
| public static setTelephone ( $telephone ) | ||
| $telephone | string | |
public function setTelephone($telephone)
{
$this->_telephone = $telephone;
return $this;
}
Defined in: luya\web\jsonld\ThingTrait::setUrl()
URL of the item.
| public static setUrl ( luya\web\jsonld\UrlValue $url ) | ||
| $url | luya\web\jsonld\UrlValue | |
public function setUrl(UrlValue $url)
{
$this->_url = $url->getValue();
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setVatID()
The Value-added Tax ID of the organization or person.
| public static setVatID ( $vatID ) | ||
| $vatID | string | |
public function setVatID($vatID)
{
$this->_vatID = $vatID;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setWorkLocation()
A contact location for a person's place of work.
| public static setWorkLocation ( $workLocation ) | ||
| $workLocation | luya\web\jsonld\ContactPoint|luya\web\jsonld\Place | |
public function setWorkLocation($workLocation)
{
$this->_workLocation = $workLocation;
return $this;
}
Defined in: luya\web\jsonld\PersonTrait::setWorksFor()
Organizations that the person works for.
| public static setWorksFor ( luya\web\jsonld\Organization $worksFor ) | ||
| $worksFor | luya\web\jsonld\Organization | |
public function setWorksFor(Organization $worksFor)
{
$this->_worksFor = $worksFor;
return $this;
}
Defined in: luya\web\jsonld\BaseThing::toArray()
Converts the object into an array.
| public array toArray ( array $fields = [], array $expand = [], $recursive = true ) | ||
| $fields | array |
The fields that the output array should contain. Fields not specified in fields() will be ignored. If this parameter is empty, all fields as specified in fields() will be returned. |
| $expand | array |
The additional fields that the output array should contain. Fields not specified in extraFields() will be ignored. If this parameter is empty, no extra fields will be returned. |
| $recursive | boolean |
Whether to recursively return array representation of embedded objects. |
| return | array |
The array representation of the object |
|---|---|---|
public function toArray(array $fields = [], array $expand = [], $recursive = true)
{
$array = $this->removeEmptyValues($this->internalToArray($fields, $expand, $recursive));
if ($this->typeDefintion()) {
$array['@type'] = $this->typeDefintion();
}
return $array;
}
Contains the jsonLd definton @type value if not null or false.
| public boolean|string typeDefintion ( ) | ||
| return | boolean|string |
Generates the @type field. |
|---|---|---|
public function typeDefintion()
{
return 'Person';
}