Collaboration diagram for PhpOffice\PhpSpreadsheet\Document\Properties:

Public Member Functions
	__construct ()
	Create a new Document Properties instance. More...

	getCreator ()
	Get Creator. More...

	setCreator (string $creator)
	Set Creator. More...

	getLastModifiedBy ()
	Get Last Modified By. More...

	setLastModifiedBy (string $modifier)
	Set Last Modified By. More...

	getCreated ()
	Get Created. More...

	setCreated ($timestamp)
	Set Created. More...

	getModified ()
	Get Modified. More...

	setModified ($timestamp)
	Set Modified. More...

	getTitle ()
	Get Title. More...

	setTitle (string $title)
	Set Title. More...

	getDescription ()
	Get Description. More...

	setDescription (string $description)
	Set Description. More...

	getSubject ()
	Get Subject. More...

	setSubject (string $subject)
	Set Subject. More...

	getKeywords ()
	Get Keywords. More...

	setKeywords (string $keywords)
	Set Keywords. More...

	getCategory ()
	Get Category. More...

	setCategory (string $category)
	Set Category. More...

	getCompany ()
	Get Company. More...

	setCompany (string $company)
	Set Company. More...

	getManager ()
	Get Manager. More...

	setManager (string $manager)
	Set Manager. More...

	getCustomProperties ()
	Get a List of Custom Property Names. More...

	isCustomPropertySet (string $propertyName)
	Check if a Custom Property is defined. More...

	getCustomPropertyValue (string $propertyName)
	Get a Custom Property Value. More...

	getCustomPropertyType (string $propertyName)
	Get a Custom Property Type. More...

	setCustomProperty (string $propertyName, $propertyValue='', $propertyType=null)
	Set a Custom Property. More...

Static Public Member Functions
const const static	convertProperty ($propertyValue, string $propertyType)
	Convert property to form desired by Excel. More...

static	convertPropertyType (string $propertyType)

Data Fields
const	PROPERTY_TYPE_BOOLEAN = 'b'
	constants More...

const	PROPERTY_TYPE_INTEGER = 'i'

const	PROPERTY_TYPE_FLOAT = 'f'

const	PROPERTY_TYPE_DATE = 'd'

const	PROPERTY_TYPE_STRING = 's'

const	PROPERTY_TYPE_UNKNOWN = 'u'

Private Member Functions
	identifyPropertyType ($propertyValue)

Static Private Member Functions
static	intOrFloatTimestamp ($timestamp)

static	convertProperty2 ($propertyValue, string $type)
	Convert property to form desired by Excel. More...

Private Attributes
const	VALID_PROPERTY_TYPE_LIST

	$creator = 'Unknown Creator'

	$lastModifiedBy

	$created

	$modified

	$title = 'Untitled Spreadsheet'

	$description = ''

	$subject = ''

	$keywords = ''

	$category = ''

	$manager = ''

	$company = ''

	$customProperties = []

const	PROPERTY_TYPE_ARRAY

const const	SPECIAL_TYPES

Detailed Description

Definition at line 8 of file Properties.php.

Constructor & Destructor Documentation

◆ __construct()

PhpOffice\PhpSpreadsheet\Document\Properties::__construct ( )

Create a new Document Properties instance.

Definition at line 113 of file Properties.php.

References PhpOffice\PhpSpreadsheet\Document\Properties\$creator.

     {
         // Initialise values
         $this->lastModifiedBy = $this->creator;
         $this->created = self::intOrFloatTimestamp(null);
         $this->modified = self::intOrFloatTimestamp(null);
     }

Member Function Documentation

◆ convertProperty()

const const static PhpOffice\PhpSpreadsheet\Document\Properties::convertProperty	(		$propertyValue,
		string	$propertyType
	)

static

Convert property to form desired by Excel.

Parameters

mixed $propertyValue

Returns: mixed

Definition at line 500 of file Properties.php.

     {
         return self::SPECIAL_TYPES[$propertyType] ?? self::convertProperty2($propertyValue, $propertyType);
     }

◆ convertProperty2()

static PhpOffice\PhpSpreadsheet\Document\Properties::convertProperty2	(		$propertyValue,
		string	$type
	)

staticprivate

Convert property to form desired by Excel.

Parameters

mixed $propertyValue

Returns: mixed

Definition at line 512 of file Properties.php.

     {
         $propertyType = self::convertPropertyType($type);
         switch ($propertyType) {
             case self::PROPERTY_TYPE_INTEGER:
                 $intValue = (int) $propertyValue;
 
                 return ($type[0] === 'u') ? abs($intValue) : $intValue;
             case self::PROPERTY_TYPE_FLOAT:
                 return (float) $propertyValue;
             case self::PROPERTY_TYPE_DATE:
                 return self::intOrFloatTimestamp($propertyValue);
             case self::PROPERTY_TYPE_BOOLEAN:
                 return is_bool($propertyValue) ? $propertyValue : ($propertyValue === 'true');
             default: // includes string
                 return $propertyValue;
         }
     }

◆ convertPropertyType()

static PhpOffice\PhpSpreadsheet\Document\Properties::convertPropertyType ( string $propertyType )

static

Definition at line 531 of file Properties.php.

                                                                     : string
     {
         return self::PROPERTY_TYPE_ARRAY[$propertyType] ?? self::PROPERTY_TYPE_UNKNOWN;
     }

◆ getCategory()

PhpOffice\PhpSpreadsheet\Document\Properties::getCategory ( )

Get Category.

Definition at line 313 of file Properties.php.

References PhpOffice\PhpSpreadsheet\Document\Properties\$category.

                                  : string
     {
         return $this->category;
     }

◆ getCompany()

PhpOffice\PhpSpreadsheet\Document\Properties::getCompany ( )

Get Company.

Definition at line 333 of file Properties.php.

References PhpOffice\PhpSpreadsheet\Document\Properties\$company.

                                 : string
     {
         return $this->company;
     }

◆ getCreated()

PhpOffice\PhpSpreadsheet\Document\Properties::getCreated ( )

Get Created.

Returns: float|int

Definition at line 187 of file Properties.php.

References PhpOffice\PhpSpreadsheet\Document\Properties\$created.

     {
         return $this->created;
     }

◆ getCreator()

PhpOffice\PhpSpreadsheet\Document\Properties::getCreator ( )

Get Creator.

Definition at line 124 of file Properties.php.

References PhpOffice\PhpSpreadsheet\Document\Properties\$creator.

                                 : string
     {
         return $this->creator;
     }

◆ getCustomProperties()

PhpOffice\PhpSpreadsheet\Document\Properties::getCustomProperties ( )

Get a List of Custom Property Names.

Returns: string[]

Definition at line 375 of file Properties.php.

                                          : array
     {
         return array_keys($this->customProperties);
     }

◆ getCustomPropertyType()

PhpOffice\PhpSpreadsheet\Document\Properties::getCustomPropertyType ( string $propertyName )

Get a Custom Property Type.

Returns: null|string

Definition at line 407 of file Properties.php.

     {
         return $this->customProperties[$propertyName]['type'] ?? null;
     }

◆ getCustomPropertyValue()

PhpOffice\PhpSpreadsheet\Document\Properties::getCustomPropertyValue ( string $propertyName )

Get a Custom Property Value.

Returns: mixed

Definition at line 393 of file Properties.php.

     {
         if (isset($this->customProperties[$propertyName])) {
             return $this->customProperties[$propertyName]['value'];
         }
 
         return null;
     }

◆ getDescription()

PhpOffice\PhpSpreadsheet\Document\Properties::getDescription ( )

Get Description.

Definition at line 253 of file Properties.php.

References PhpOffice\PhpSpreadsheet\Document\Properties\$description.

                                     : string
     {
         return $this->description;
     }

◆ getKeywords()

PhpOffice\PhpSpreadsheet\Document\Properties::getKeywords ( )

Get Keywords.

Definition at line 293 of file Properties.php.

References PhpOffice\PhpSpreadsheet\Document\Properties\$keywords.

                                  : string
     {
         return $this->keywords;
     }

◆ getLastModifiedBy()

PhpOffice\PhpSpreadsheet\Document\Properties::getLastModifiedBy ( )

Get Last Modified By.

Definition at line 144 of file Properties.php.

References PhpOffice\PhpSpreadsheet\Document\Properties\$lastModifiedBy.

                                        : string
     {
         return $this->lastModifiedBy;
     }

◆ getManager()

PhpOffice\PhpSpreadsheet\Document\Properties::getManager ( )

Get Manager.

Definition at line 353 of file Properties.php.

References PhpOffice\PhpSpreadsheet\Document\Properties\$manager.

                                 : string
     {
         return $this->manager;
     }

◆ getModified()

PhpOffice\PhpSpreadsheet\Document\Properties::getModified ( )

Get Modified.

Returns: float|int

Definition at line 211 of file Properties.php.

References PhpOffice\PhpSpreadsheet\Document\Properties\$modified.

     {
         return $this->modified;
     }

◆ getSubject()

PhpOffice\PhpSpreadsheet\Document\Properties::getSubject ( )

Get Subject.

Definition at line 273 of file Properties.php.

References PhpOffice\PhpSpreadsheet\Document\Properties\$subject.

                                 : string
     {
         return $this->subject;
     }

◆ getTitle()

PhpOffice\PhpSpreadsheet\Document\Properties::getTitle ( )

Get Title.

Definition at line 233 of file Properties.php.

References PhpOffice\PhpSpreadsheet\Document\Properties\$title.

                               : string
     {
         return $this->title;
     }

◆ identifyPropertyType()

PhpOffice\PhpSpreadsheet\Document\Properties::identifyPropertyType ( $propertyValue )

private

Parameters

mixed $propertyValue

Definition at line 415 of file Properties.php.

Referenced by PhpOffice\PhpSpreadsheet\Document\Properties\setCustomProperty().

                                                          : string
     {
         if (is_float($propertyValue)) {
             return self::PROPERTY_TYPE_FLOAT;
         }
         if (is_int($propertyValue)) {
             return self::PROPERTY_TYPE_INTEGER;
         }
         if (is_bool($propertyValue)) {
             return self::PROPERTY_TYPE_BOOLEAN;
         }
 
         return self::PROPERTY_TYPE_STRING;
     }

Here is the caller graph for this function:

◆ intOrFloatTimestamp()

static PhpOffice\PhpSpreadsheet\Document\Properties::intOrFloatTimestamp ( $timestamp )

staticprivate

Parameters

null | float | int | string $timestamp

Returns: float|int

Definition at line 166 of file Properties.php.

References $timestamp, and PhpOffice\PhpSpreadsheet\Shared\IntOrFloat\evaluate().

     {
         if ($timestamp === null) {
             $timestamp = (float) (new DateTime())->format('U');
         } elseif (is_string($timestamp)) {
             if (is_numeric($timestamp)) {
                 $timestamp = (float) $timestamp;
             } else {
                 $timestamp = preg_replace('/[.][0-9]*$/', '', $timestamp) ?? '';
                 $timestamp = (float) (new DateTime($timestamp))->format('U');
             }
         }
 
         return IntOrFloat::evaluate($timestamp);
     }

Here is the call graph for this function:

◆ isCustomPropertySet()

PhpOffice\PhpSpreadsheet\Document\Properties::isCustomPropertySet ( string $propertyName )

Check if a Custom Property is defined.

Definition at line 383 of file Properties.php.

                                                              : bool
     {
         return array_key_exists($propertyName, $this->customProperties);
     }

◆ setCategory()

PhpOffice\PhpSpreadsheet\Document\Properties::setCategory ( string $category )

Set Category.

Returns: $this

Definition at line 323 of file Properties.php.

References PhpOffice\PhpSpreadsheet\Document\Properties\$category.

                                                  : self
     {
         $this->category = $category;
 
         return $this;
     }

◆ setCompany()

PhpOffice\PhpSpreadsheet\Document\Properties::setCompany ( string $company )

Set Company.

Returns: $this

Definition at line 343 of file Properties.php.

References PhpOffice\PhpSpreadsheet\Document\Properties\$company.

                                                : self
     {
         $this->company = $company;
 
         return $this;
     }

◆ setCreated()

PhpOffice\PhpSpreadsheet\Document\Properties::setCreated ( $timestamp )

Set Created.

Parameters

null | float | int | string $timestamp

Returns: $this

Definition at line 199 of file Properties.php.

References $timestamp.

                                           : self
     {
         $this->created = self::intOrFloatTimestamp($timestamp);
 
         return $this;
     }

◆ setCreator()

PhpOffice\PhpSpreadsheet\Document\Properties::setCreator ( string $creator )

Set Creator.

Returns: $this

Definition at line 134 of file Properties.php.

References PhpOffice\PhpSpreadsheet\Document\Properties\$creator.

                                                : self
     {
         $this->creator = $creator;
 
         return $this;
     }

◆ setCustomProperty()

PhpOffice\PhpSpreadsheet\Document\Properties::setCustomProperty	(	string	$propertyName,
			$propertyValue = `''`,
			$propertyType = `null`
	)

Set a Custom Property.

Parameters

mixed	$propertyValue
string	$propertyType	'i' : Integer 'f' : Floating Point 's' : String 'd' : Date/Time 'b' : Boolean

Returns: $this

Definition at line 443 of file Properties.php.

References PhpOffice\PhpSpreadsheet\Document\Properties\identifyPropertyType().

                                                                                                       : self
     {
         if (($propertyType === null) || (!in_array($propertyType, self::VALID_PROPERTY_TYPE_LIST))) {
             $propertyType = $this->identifyPropertyType($propertyValue);
         }
 
         if (!is_object($propertyValue)) {
             $this->customProperties[$propertyName] = [
                 'value' => self::convertProperty($propertyValue, $propertyType),
                 'type' => $propertyType,
             ];
         }
 
         return $this;
     }

Here is the call graph for this function:

◆ setDescription()

PhpOffice\PhpSpreadsheet\Document\Properties::setDescription ( string $description )

Set Description.

Returns: $this

Definition at line 263 of file Properties.php.

References PhpOffice\PhpSpreadsheet\Document\Properties\$description.

                                                        : self
     {
         $this->description = $description;
 
         return $this;
     }

◆ setKeywords()

PhpOffice\PhpSpreadsheet\Document\Properties::setKeywords ( string $keywords )

Set Keywords.

Returns: $this

Definition at line 303 of file Properties.php.

References PhpOffice\PhpSpreadsheet\Document\Properties\$keywords.

                                                  : self
     {
         $this->keywords = $keywords;
 
         return $this;
     }

◆ setLastModifiedBy()

PhpOffice\PhpSpreadsheet\Document\Properties::setLastModifiedBy ( string $modifier )

Set Last Modified By.

Returns: $this

Definition at line 154 of file Properties.php.

                                                        : self
     {
         $this->lastModifiedBy = $modifier;
 
         return $this;
     }

◆ setManager()

PhpOffice\PhpSpreadsheet\Document\Properties::setManager ( string $manager )

Set Manager.

Returns: $this

Definition at line 363 of file Properties.php.

References PhpOffice\PhpSpreadsheet\Document\Properties\$manager.

                                                : self
     {
         $this->manager = $manager;
 
         return $this;
     }

◆ setModified()

PhpOffice\PhpSpreadsheet\Document\Properties::setModified ( $timestamp )

Set Modified.

Parameters

null | float | int | string $timestamp

Returns: $this

Definition at line 223 of file Properties.php.

References $timestamp.

                                            : self
     {
         $this->modified = self::intOrFloatTimestamp($timestamp);
 
         return $this;
     }

◆ setSubject()

PhpOffice\PhpSpreadsheet\Document\Properties::setSubject ( string $subject )

Set Subject.

Returns: $this

Definition at line 283 of file Properties.php.

References PhpOffice\PhpSpreadsheet\Document\Properties\$subject.

                                                : self
     {
         $this->subject = $subject;
 
         return $this;
     }

◆ setTitle()

PhpOffice\PhpSpreadsheet\Document\Properties::setTitle ( string $title )

Set Title.

Returns: $this

Definition at line 243 of file Properties.php.

References PhpOffice\PhpSpreadsheet\Document\Properties\$title.

                                            : self
     {
         $this->title = $title;
 
         return $this;
     }

Field Documentation

◆ $category

PhpOffice\PhpSpreadsheet\Document\Properties::$category = ''

private

Definition at line 87 of file Properties.php.

Referenced by PhpOffice\PhpSpreadsheet\Document\Properties\getCategory(), and PhpOffice\PhpSpreadsheet\Document\Properties\setCategory().

◆ $company

PhpOffice\PhpSpreadsheet\Document\Properties::$company = ''

private

Definition at line 101 of file Properties.php.

Referenced by PhpOffice\PhpSpreadsheet\Document\Properties\getCompany(), and PhpOffice\PhpSpreadsheet\Document\Properties\setCompany().

◆ $created

PhpOffice\PhpSpreadsheet\Document\Properties::$created

private

Definition at line 45 of file Properties.php.

Referenced by PhpOffice\PhpSpreadsheet\Document\Properties\getCreated().

◆ $creator

PhpOffice\PhpSpreadsheet\Document\Properties::$creator = 'Unknown Creator'

private

Definition at line 31 of file Properties.php.

Referenced by PhpOffice\PhpSpreadsheet\Document\Properties\__construct(), PhpOffice\PhpSpreadsheet\Document\Properties\getCreator(), and PhpOffice\PhpSpreadsheet\Document\Properties\setCreator().

◆ $customProperties

PhpOffice\PhpSpreadsheet\Document\Properties::$customProperties = []

private

Definition at line 108 of file Properties.php.

◆ $description

PhpOffice\PhpSpreadsheet\Document\Properties::$description = ''

private

Definition at line 66 of file Properties.php.

Referenced by PhpOffice\PhpSpreadsheet\Document\Properties\getDescription(), and PhpOffice\PhpSpreadsheet\Document\Properties\setDescription().

◆ $keywords

PhpOffice\PhpSpreadsheet\Document\Properties::$keywords = ''

private

Definition at line 80 of file Properties.php.

Referenced by PhpOffice\PhpSpreadsheet\Document\Properties\getKeywords(), and PhpOffice\PhpSpreadsheet\Document\Properties\setKeywords().

◆ $lastModifiedBy

PhpOffice\PhpSpreadsheet\Document\Properties::$lastModifiedBy

private

Definition at line 38 of file Properties.php.

Referenced by PhpOffice\PhpSpreadsheet\Document\Properties\getLastModifiedBy().

◆ $manager

PhpOffice\PhpSpreadsheet\Document\Properties::$manager = ''

private

Definition at line 94 of file Properties.php.

Referenced by PhpOffice\PhpSpreadsheet\Document\Properties\getManager(), and PhpOffice\PhpSpreadsheet\Document\Properties\setManager().

◆ $modified

PhpOffice\PhpSpreadsheet\Document\Properties::$modified

private

Definition at line 52 of file Properties.php.

Referenced by PhpOffice\PhpSpreadsheet\Document\Properties\getModified().

◆ $subject

PhpOffice\PhpSpreadsheet\Document\Properties::$subject = ''

private

Definition at line 73 of file Properties.php.

Referenced by PhpOffice\PhpSpreadsheet\Document\Properties\getSubject(), and PhpOffice\PhpSpreadsheet\Document\Properties\setSubject().

◆ $title

PhpOffice\PhpSpreadsheet\Document\Properties::$title = 'Untitled Spreadsheet'

private

Definition at line 59 of file Properties.php.

Referenced by PhpOffice\PhpSpreadsheet\Document\Properties\getTitle(), and PhpOffice\PhpSpreadsheet\Document\Properties\setTitle().

◆ PROPERTY_TYPE_ARRAY

const PhpOffice\PhpSpreadsheet\Document\Properties::PROPERTY_TYPE_ARRAY

private

Initial value:

= [

'i' => self::PROPERTY_TYPE_INTEGER

Definition at line 459 of file Properties.php.

◆ PROPERTY_TYPE_BOOLEAN

const PhpOffice\PhpSpreadsheet\Document\Properties::PROPERTY_TYPE_BOOLEAN = 'b'

constants

Definition at line 11 of file Properties.php.

◆ PROPERTY_TYPE_DATE

const PhpOffice\PhpSpreadsheet\Document\Properties::PROPERTY_TYPE_DATE = 'd'

Definition at line 14 of file Properties.php.

◆ PROPERTY_TYPE_FLOAT

const PhpOffice\PhpSpreadsheet\Document\Properties::PROPERTY_TYPE_FLOAT = 'f'

Definition at line 13 of file Properties.php.

◆ PROPERTY_TYPE_INTEGER

const PhpOffice\PhpSpreadsheet\Document\Properties::PROPERTY_TYPE_INTEGER = 'i'

Definition at line 12 of file Properties.php.

◆ PROPERTY_TYPE_STRING

const PhpOffice\PhpSpreadsheet\Document\Properties::PROPERTY_TYPE_STRING = 's'

Definition at line 15 of file Properties.php.

◆ PROPERTY_TYPE_UNKNOWN

const PhpOffice\PhpSpreadsheet\Document\Properties::PROPERTY_TYPE_UNKNOWN = 'u'

Definition at line 16 of file Properties.php.

◆ SPECIAL_TYPES

const const PhpOffice\PhpSpreadsheet\Document\Properties::SPECIAL_TYPES

private

Initial value:

= [

'empty' => ''

Definition at line 488 of file Properties.php.

◆ VALID_PROPERTY_TYPE_LIST

const PhpOffice\PhpSpreadsheet\Document\Properties::VALID_PROPERTY_TYPE_LIST

private

Initial value:

= [
        self::PROPERTY_TYPE_BOOLEAN,
        self::PROPERTY_TYPE_INTEGER,
        self::PROPERTY_TYPE_FLOAT,
        self::PROPERTY_TYPE_DATE,
        self::PROPERTY_TYPE_STRING,
    ]

Definition at line 18 of file Properties.php.

The documentation for this class was generated from the following file:

libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Document/Properties.php

Public Member Functions

Static Public Member Functions

Data Fields

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ convertProperty()

◆ convertProperty2()

◆ convertPropertyType()

◆ getCategory()

◆ getCompany()

◆ getCreated()

◆ getCreator()

◆ getCustomProperties()

◆ getCustomPropertyType()

◆ getCustomPropertyValue()

◆ getDescription()

◆ getKeywords()

◆ getLastModifiedBy()

◆ getManager()

◆ getModified()

◆ getSubject()

◆ getTitle()

◆ identifyPropertyType()

◆ intOrFloatTimestamp()

◆ isCustomPropertySet()

◆ setCategory()

◆ setCompany()

◆ setCreated()

◆ setCreator()

◆ setCustomProperty()

◆ setDescription()

◆ setKeywords()

◆ setLastModifiedBy()

◆ setManager()

◆ setModified()

◆ setSubject()

◆ setTitle()

Field Documentation

◆ $category

◆ $company

◆ $created

◆ $creator

◆ $customProperties

◆ $description

◆ $keywords

◆ $lastModifiedBy

◆ $manager

◆ $modified

◆ $subject

◆ $title

◆ PROPERTY_TYPE_ARRAY

◆ PROPERTY_TYPE_BOOLEAN

◆ PROPERTY_TYPE_DATE

◆ PROPERTY_TYPE_FLOAT

◆ PROPERTY_TYPE_INTEGER

◆ PROPERTY_TYPE_STRING

◆ PROPERTY_TYPE_UNKNOWN

◆ SPECIAL_TYPES

◆ VALID_PROPERTY_TYPE_LIST