File_Therion_DataTypes
[ class tree: File_Therion_DataTypes ] [ index: File_Therion_DataTypes ] [ all elements ]

Class: File_Therion_Person

Source Location: /File_Therion-0.4.1/File/Therion/DataTypes/Person.php

Class Overview

File_Therion_DataType
   |
   --File_Therion_Person

Class representing a therion person object.


Author(s):

Copyright:

  • 2016 Benedikt Hallinger

Variables

Methods


Inherited Variables

Inherited Methods

Class: File_Therion_DataType

File_Therion_DataType::parse()
Parse string content into this datatype
File_Therion_DataType::toString()
Get string representation
File_Therion_DataType::__toString()
Magic __toString() method calls toString().

Class Details

[line 25]
Class representing a therion person object.


[ Top ]


Class Variables

$givenName =  ""

[line 30]

  • Access: protected

Type:   mixed


[ Top ]

$surname =  ""

[line 29]

  • Access: protected

Type:   mixed


[ Top ]



Method Detail

__construct (Constructor)   [line 42]

File_Therion_Person __construct( [$givenName $givenName = ""], [$surname $surname = ""])

Create a new therion person object.

You may supplay givenName and surname; if there are several, just separate them with whitespace.

  • Access: public

Parameters:

$givenName   $givenName   —  First name of person.
$surname   $surname   —  Last name of person.

[ Top ]

getGivenname   [line 176]

string getGivenname( )

Returns givenName of person.
  • Access: public

[ Top ]

getSurname   [line 186]

string getSurname( )

Returns lastname of person.
  • Access: public

[ Top ]

parse   [line 101]

mixed parse( $string $string)

Parse string content into this datatype
  • Return: crafted object
  • Todo: unsure if single name should be interpreted as last-name
  • Access: public

Overrides File_Therion_DataType::parse() (Parse string content into this datatype)

Parameters:

$string   $string   —  data to parse

[ Top ]

setGivenname   [line 154]

void setGivenname( string $name)

Sets givenname of person.
  • Todo: proper checks for type
  • Access: public

Parameters:

string   $name   — 

[ Top ]

setSurname   [line 165]

void setSurname( string $name)

Sets surname of person.
  • Todo: proper checks for type
  • Access: public

Parameters:

string   $name   — 

[ Top ]

toString   [line 54]

Therion toString( )

Get string representation
  • Return: compliant String of this type
  • Access: public

Overrides File_Therion_DataType::toString() (Get string representation)
[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:09:45 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.