VCardContact::getHomepageCount() - Code Metrics - Inspection of "win test" - Stefanius67/VCard - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 5ec36b...a966a8 )

by Stefan

created 2021-07-18 17:19 UTC

VCardContact::getHomepageCount() A

↳ Parent: VCardContact

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	1
c	0
b	0
f	0
dl	0
loc	3
rs	10
cc	1
nc	1
nop	0

<?php
declare(strict_types=1);

namespace SKien\VCard;

/**
 * Class representing all data to one contact.
 * Each contact may contains multiple
 * - adresses
 * - communication numbers
 * - e-mail addresses
 * - homepages
 * - categories
 *
 * #### Add a contact to a VCard for writing:
 * Create a new instance of a `VCardContact`, set all properties and add the contact
 * to a vcard using `VCard::addContact()`
 *
 * #### Retrieve a contact from a read VCard:
 * Use `VCard::getContact()` to retrieve existing contact within vcard.
 *
 * @see VCard::addContact()
 * @see VCard::getContact()
 *
 * @package VCard
 * @author Stefanius <[email protected]>
 * @copyright MIT License - see the LICENSE file for details
 */
class VCardContact
{
    use VCardHelper;

    /** gender: female (Microsoft specific) */
    public const MS_FEMALE    = '1';
    /** gender: male (Microsoft specific) */
    public const MS_MALE    = '2';
    /** Date type: string */
    public const DT_STRING = 0;
    /** Date type: unix timestamp */
    public const DT_UNIX_TIMESTAMP = 1;
    /** Date type: DateTime - Object */
    public const DT_OBJECT = 2;

    /** @var string  lastname   */
    protected string $strLastName = '';
    /** @var string  firstname  */
    protected string $strFirstName = '';
    /** @var string  prefix (salutation, title,...) */
    protected string $strPrefix = '';
    /** @var string  suffix (graduation,...)    */
    protected string $strSuffix = '';
    /** @var string  nickname   */
    protected string $strNickName = '';
    /** @var string  organisation name  */
    protected string $strOrganisation = '';
    /** @var string  position within the organisation   */
    protected string $strPosition = '';
    /** @var string  section within the organisation    */
    protected string $strSection = '';
    /** @var string  role / profession  */
    protected string $strRole = '';
    /** @var VCardAddress[] array of VCardAddress objects  */
    protected array $aAddress = array();
    /** @var array[] array of phone numbers */
    protected array $aPhone = array();
    /** @var string[] array of email addresses   */
    protected array $aEMail = array();
    /** @var string[] array of categories    */
    protected array $aCategories = array();
    /** @var string[] array of homepage URL's    */
    protected array $aHomepages = array();
    /** @var string  date of birth in format YYYY-MM-DD */
    protected string $strDateOfBirth = '';
    /** @var int     gender (0: not specified, 1: female, 2: male)  */
    protected int $iGender = 0;
    /** @var string  note   */
    protected string $strNote = '';
    /** @var string  binary portrait base64 coded   */
    protected string $blobPortrait = '';

    /**
     * Add address.
     * Only one address should be marked as preferred.
     * @param VCardAddress $oAddress
     * @param bool $bPreferred  mark address as preferred.
     */
    public function addAddress(VCardAddress $oAddress, bool $bPreferred) : void
    {
        $oAddress->setPreferred($bPreferred);
        $this->aAddress[] = $oAddress;
    }

    /**
     * Add phone number.
     * Use to set a communication number (phone, mobile, FAX, ...). <br/>
     * Any combination of the predefined communication number constants plus the definition
     * HOME or WORK can be specified as the type. <br/>
     * Multiple numbers of the same type can be set within one contact.
     * @see VCard::constants VCard communication number constants
     * @link https://datatracker.ietf.org/doc/html/rfc2426#section-3.3.1
     * @link https://en.wikipedia.org/wiki/E.164
     * @link https://www.itu.int/rec/T-REC-X.121-200010-I/en
     * @param string $strPhone      the number (SHOULD conform to the semantics of E.164 / X.121)
     * @param string|array $type    one single type or an array of multiple types
     * @param bool $bPreferred      mark number as preferred
     */
    public function addPhone(string $strPhone, $type, bool $bPreferred) : void
    {
        $strType = is_array($type) ? implode(',', $type) : $type;
        if ($bPreferred && strpos($strType, 'PREF') === false) {
            $strType .= ',PREF';
        }
        $this->aPhone[] = array('strPhone' => $strPhone, 'strType' => $strType);
    }

    /**
     * Add mail address.
     * @link https://datatracker.ietf.org/doc/html/rfc2426#section-3.3.2
     * @param string $strEMail  valid e-mail address
     * @param bool $bPreferred  mark e-mail as preferred
     */
    public function addEMail(string $strEMail, bool $bPreferred) : void
    {
        if ($bPreferred) {
            // just set preferred mail on top of the list!
            array_unshift($this->aEMail, $strEMail);
        } else {
            $this->aEMail[] = $strEMail;
        }
    }

    /**
     * Add a category.
     * @param string $strCategory
     */
    public function addCategory(string $strCategory) : void
    {
        $this->aCategories[] = $strCategory;
    }

    /**
     * Set date of birth.
     * @param mixed $DateOfBirth    may be string (format YYYY-MM-DD), int (unixtimestamp) or DateTime - object
     */
    public function setDateOfBirth($DateOfBirth) : void
    {
        if (is_object($DateOfBirth) && get_class($DateOfBirth) == 'DateTime') {
            // DateTime -object
            $this->strDateOfBirth = $DateOfBirth->format('Y-m-d');
        } else if (is_numeric($DateOfBirth)) {
            $this->strDateOfBirth = date('Y-m-d', $DateOfBirth);
        } else {
            $this->strDateOfBirth = $DateOfBirth;
        }
    }

    /**
     * Set the gender.
     * <b>Note: this is a MS-extension! </b><ul>
     * <li> windows contacts: export/import. </li>
     * <li> outlook: import only. </li></ul><br/>
     * Only the first char of the `$strGender` param (converted to lowercase) is taken into account! <ul>
     * <li> male: 'm', '2' </li>
     * <li> female: 'f', 'w', '1' </li></ul>
     * @param string $strGender
     */
    public function setGender(string $strGender) : void
    {
        $chGender = strtolower(substr($strGender, 0, 1));
        if (in_array($chGender, array('w', 'f', self::MS_FEMALE))) {
            // weibl., female
            $this->iGender = 1;
        } elseif (in_array($chGender, array('m', self::MS_MALE))) {
            // männl., male
            $this->iGender = 2;
        }
    }

    /**
     * Set portrait from image file.
     * Supported types are JPG, PNG, GIF and BMP. <br/>
     * > <b>Note: </b></br>
     * > For transparency the image type itself MUST support transparency (PNG, GIF)
     * > and when reading a portrait, it MUST be saved in the same image format!
     * @param string $strFilename
     */
    public function setPortraitFile(string $strFilename) : void
    {
        if (filter_var($strFilename, FILTER_VALIDATE_URL)) {
            // get type from extension
            $strType = strtolower((string) pathinfo($strFilename, PATHINFO_EXTENSION));
            $this->blobPortrait = 'data:image/' . $strType . ';base64,';

            // use curl to be independet of [allow_url_fopen] enabled on the system
            $curl = curl_init();
            curl_setopt($curl, CURLOPT_URL, $strFilename);
            curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);

            $img = curl_exec($curl);
            curl_close($curl);

            if (is_string($img)) {
                $this->blobPortrait .= base64_encode($img);
            }
        } elseif (file_exists($strFilename)) {
            switch (exif_imagetype($strFilename)) {
                case IMAGETYPE_JPEG:
                    $this->blobPortrait = 'data:image/jpg;base64,';
                    break;
                case IMAGETYPE_PNG:
                    $this->blobPortrait = 'data:image/png;base64,';
                    break;
                case IMAGETYPE_GIF:
                    $this->blobPortrait = 'data:image/gif;base64,';
                    break;
                case IMAGETYPE_BMP:
                    $this->blobPortrait = 'data:image/bmp;base64,';
                    break;
                default:
                    break;
            }
            $img = file_get_contents($strFilename);

            $this->blobPortrait .= base64_encode($img);
        }
    }

    /**
     * Set the full name.
     * For companies just leave one of the params blank!
     * @param string $strLastName
     * @param string $strFirstName
     */
    public function setName(string $strLastName, string $strFirstName) : void
    {
        $this->strLastName = $strLastName;
        $this->strFirstName = $strFirstName;
    }

    /**
     * Set (honorific) name prefix.
     * i.E. 'Dr.', 'Prof.', ...
     * @param string $strPrefix
     */
    public function setPrefix(string $strPrefix) : void
    {
        $this->strPrefix = $strPrefix;
    }

    /**
     * Set (honorific) name suffix.
     * i.E. 'Jr.', 'M.D.', ...
     * @param string $strSuffix
     */
    public function setSuffix(string $strSuffix) : void
    {
        $this->strSuffix = $strSuffix;
    }

    /**
     * Set nickname.
     * @param string $strNickName
     */
    public function setNickName(string $strNickName) : void
    {
        $this->strNickName = $strNickName;
    }

    /**
     * Set name of the organisation.
     * @param string $strOrganisation
     */
    public function setOrganisation(string $strOrganisation) : void
    {
        $this->strOrganisation = $strOrganisation;
    }

    /**
     * Set section or organizational unit within the organisation.
     * @param string $strSection
     */
    public function setSection(string $strSection) : void
    {
        $this->strSection = $strSection;
    }

    /**
     * Set position, job title or function within the organisation.
     * @param string $strPosition
     */
    public function setPosition(string $strPosition) : void
    {
        $this->strPosition = $strPosition;
    }

    /**
     * Set role, occupation or business category within the organisation.
     * @param string $strRole
     */
    public function setRole(string $strRole) : void
    {
        $this->strPosition = $strRole;
    }

    /**
     * Set homepage
     * @param string $strHomepage
     */
    public function setHomepage(string $strHomepage) : void
    {
        // keep method for backward compatibility!
        // just set value on top of the list!
        array_unshift($this->aHomepages, $strHomepage);
        trigger_error('call of VCardContact::setHomepage() is deprecated - use VCardContact::addtHomepage() instead!', E_USER_DEPRECATED);
    }

    /**
     * Add homepage
     * @param string $strHomepage
     */
    public function addHomepage(string $strHomepage) : void
    {
        $this->aHomepages[] = $strHomepage;
    }

    /**
     * Set annotation.
     * @param string $strNote
     */
    public function setNote(string $strNote) : void
    {
        $this->strNote = $strNote;
    }

    /**
     * Set portrait from base64 encoded image data.
     * @param string $blobPortrait base64 encoded image
     */
    public function setPortraitBlob(string $blobPortrait) : void
    {
        $this->blobPortrait = $blobPortrait;
    }

    /**
     * Save portrait as file.
     * Supportet types are JPG, PNG, GIF and BMP
     * The type depends on the fileextension. If no extensiomnm given, the
     * type of the imported image will be used.
     * @param string $strFilename
     */
    public function savePortrait(string $strFilename) : void
    {
        if (strlen($this->blobPortrait) > 0) {
            $strType = '';
            $strImage = '';
            $this->parseImageData($this->blobPortrait, $strType, $strImage);
            if (strlen($strType) > 0 && strlen($strImage) > 0) {
                $img = $this->imageFromString($strImage, $strType);
                imagealphablending($img, true);
                imagesavealpha($img, true);
                $strExt = strtolower((string) pathinfo($strFilename, PATHINFO_EXTENSION));
                if (strlen($strExt) == 0) {
                    $strExt = strtolower($strType);
                    $strFilename .= '.' . $strExt;
                }
                switch ($strExt) {
                    case 'jpg':
                    case 'jpeg':
                        imagejpeg($img, $strFilename);
                        break;
                    case 'png':
                        imagepng($img, $strFilename);
                        break;
                    case 'gif':
                        imagegif($img, $strFilename);
                        break;
                    case 'bmp':
                        imagebmp($img, $strFilename);
                        break;
                }
            }
        }
    }

    /**
     * Number of addresses the contact contains.
     * @return int
     */
    public function getAddressCount() : int
    {
        return count($this->aAddress);
    }

    /**
     * Get address.
     * An address can be referenced by index or by type. <br/>
     * For Type requests (=> $i non numeric value): <ul>
     * <li> The first address matches specified type is used (contact may contains multiple
     *      addresses of same type)  </li>
     * <li> If VCard::PREF is requested, the first preferred address in contact used (even
     *      if more than one is defined as preferred), if no preferred address found, the
     *      first address within the contact will be returned!   </li></ul>
     * @param int|string $i     reference to address (int => index, string => type)
     * @return VCardAddress|null    valid address object or null, if not found
     */
    public function getAddress($i) : ?VCardAddress
    {
        $oAddr = null;
        if (is_numeric($i)) {
            if ($i >= 0 && $i < count($this->aAddress)) {
                $oAddr = $this->aAddress[$i];
            }
        } else {
            foreach ($this->aAddress as $oAddress) {
                if (strpos($oAddress->getType(), $i) !== false) {
                    $oAddr = $oAddress;
                    break;
                }
            }
        }
        if (!$oAddr && $i == VCard::PREF && count($this->aAddress) > 0) {
            // if preferred item requested and no address in contact defined as prefered, just return first...
            $oAddr = $this->aAddress[0];
        }
        return $oAddr;
    }

    /**
     * Count of phone numbers.
     * @return int
     */
    public function getPhoneCount() : int
    {
        return count($this->aPhone);
    }

    /**
     * Get phone number.
     * Requested number can be referenced by index or type. <br/>
     * For index request: `0 <= $i < self::getPhoneCount()` <br/>
     * For type requests (=> $i non numeric value): <ul>
     * <li> first phone matches specified type is used (contact may contains multiple phone numbers of same type) </li>
     * <li> if VCard::PREF specified, first number in contact used, if no preferred item found </li></ul>
     * @param mixed $i     reference to address (int => index, string => type)
     * @return array or null
     */
    public function getPhone($i) : ?array
    {
        $aPhone = null;
        if (is_numeric($i)) {
            if ($i >= 0 && $i < count($this->aPhone)) {
                $aPhone = $this->aPhone[$i];
            }
        } else {
            foreach ($this->aPhone as $aPhone) {
                if (strpos($aPhone['strType'], $i) !== false) {
                    return $aPhone;
                }
                $aPhone = null;
            }
        }
        if (!$aPhone && $i == VCard::PREF && count($this->aPhone) > 0) {
            // if preferred item requested and no phone in contact defined as prefered, just return first...
            $aPhone = $this->aPhone[0];
        }
        return $aPhone;
    }

    /**
     * Number of email addresses contained.
     * @return int
     */
    public function getEMailCount() : int
    {
        return count($this->aEMail);
    }

    /**
     * Get EMail addres at given index.
     * @param int $i    index (`0 <= $i < self::getEMailCount()`)
     * @return string
     */
    public function getEMail(int $i) : string
    {
        $strEMail = '';
        if ($i >= 0 && $i < count($this->aEMail)) {
            $strEMail = $this->aEMail[$i];
        }
        return $strEMail;
    }

    /**
     * Number of categories contained.
     * @return int
     */
    public function getCategoriesCount() : int
    {
        return count($this->aCategories);
    }

    /**
     * Get category for given index.
     * @param int $i    index (`0 <= $i < self::getCategoriesCount()`)
     * @return string
     */
    public function getCategory(int $i) : string
    {
        $strCategory = '';
        if ($i >= 0 && $i < count($this->aCategories)) {
            $strCategory = $this->aCategories[$i];
        }
        return $strCategory;
    }

    /**
     * Return Categories separated by comma.
     * @return string
     */
    public function getCategories() : string
    {
        $strCategories = '';
        $strSep = '';
        foreach ($this->aCategories as $strCategory) {
            $strCategories .= $strSep . $strCategory;
            $strSep = ',';
        }
        return $strCategories;
    }

    /**
     * Get full name.
     * `$strFirstName` followed by `$strLastName` separeted by blank.
     * @return string
     */
    public function getName() : string
    {
        $strSep = (empty($this->strFirstName) || empty($this->strLastName)) ? '' : ' ';
        return $this->strFirstName . $strSep . $this->strLastName;
    }

    /**
     * Get lastname.
     * @return string
     */
    public function getLastName() : string
    {
        return $this->strLastName;
    }

    /**
     * Get firstname.
     * @return string
     */
    public function getFirstName() : string
    {
        return $this->strFirstName;
    }

    /**
     * Get nickname.
     * @return string
     */
    public function getNickName() : string
    {
        return $this->strNickName;
    }

    /**
     * Get name of the organisation.
     * @return string
     */
    public function getOrganisation() : string
    {
        return $this->strOrganisation;
    }

    /**
     * Get position, job title or function within the organisation.
     * @return string
     */
    public function getPosition() : string
    {
        return $this->strPosition;
    }

    /**
     * Get role, occupation or business category within the organisation.
     * @return string
     */
    public function getRole() : string
    {
        return $this->strRole;
    }

    /**
     * Number of homepages contained.
     * @return int
     */
    public function getHomepageCount() : int
    {
        return count($this->aHomepages);
    }

    /**
     * Get homepage for given index.
     * @param int $i    index (`0 <= $i < self::getHomepageCount()`)
     * @return string
     */
    public function getHomepage(int $i = -1) : string
    {
        $strHomepage = '';
        if ($i === -1) {
            // default value -1 set for backward compatibility but give chance for a 'deprecated' message!
            // version < 1.05 of this package hadn't support for multiple homepages!
            trigger_error('call of VCardContact::getHomepage() without index is deprecated!', E_USER_DEPRECATED);
            $i = 0;
        }
        if ($i >= 0 && $i < count($this->aHomepages)) {
            $strHomepage = $this->aHomepages[$i];
        }
        return $strHomepage;
    }

    /**
     * Get date of birth.
     * The return type can be specified in the `$iType`parameter: <ul>
     * <li><b> self::DT_STRING (default):</b> Date as String in f´the format set with `$strFormat`param (default = 'Y-m-d') </li>
     * <li><b> self::DT_UNIX_TIMESTAMP:</b> Date as unix timestamp</li>
     * <li><b> self::DT_OBJECT:</b> Date as DateTime object </li></ul>
     *
     * if the property is not set in the contact method returns: <ul>
     * <li><b> self::DT_STRING:</b> empty string </li>
     * <li><b> self::DT_UNIX_TIMESTAMP:</b> integer 0</li>
     * <li><b> self::DT_OBJECT:</b> null </li></ul>
     *
     * @link https://datatracker.ietf.org/doc/html/rfc2426#section-3.1.5
     * @link https://www.php.net/manual/en/datetime.format.php
     * @param int $iType    self::DT_STRING (default), self::DT_UNIX_TIMESTAMP or self::DT_OBJECT
     * @param string $strFormat Date format compliant to DateTime::format() (default 'Y-m-d')
     * @return string|int|\DateTime
     */
    public function getDateOfBirth(int $iType = self::DT_STRING, string $strFormat = 'Y-m-d')
    {
        $dtBirth = new \DateTime($this->strDateOfBirth);
        switch ($iType) {
            case self::DT_UNIX_TIMESTAMP:
                return (empty($this->strDateOfBirth) ? 0 : $dtBirth->getTimestamp());
            case self::DT_OBJECT:
                return (empty($this->strDateOfBirth) ? null : $dtBirth);
            default:
                return (empty($this->strDateOfBirth) ? '' : $dtBirth->format($strFormat));
        }
    }

    /**
     * Get gender (Microsoft only).
     * @return int  0: not set, 1: female, 2: male
     */
    public function getGender() : int
    {
        return $this->iGender;
    }

    /**
     * Get section or organizational unit within the organisation.
     * @return string
     */
    public function getSection() : string
    {
        return $this->strSection;
    }

    /**
     * Get annotation.
     * @return string
     */
    public function getNote() : string
    {
        return $this->strNote;
    }

    /**
     * Get (honorific) name prefix.
     * i.E. 'Dr.', 'Prof.', ...
     * @return string
     */
    public function getPrefix() : string
    {
        return $this->strPrefix;
    }

    /**
     * Get (honorific) name suffix.
     * i.E. 'Jr.', 'M.D.', ...
     * @return string
     */
    public function getSuffix() : string
    {
        return $this->strSuffix;
    }

    /**
     * Get the image as base64 encoded string.
     * @return string base64 encoded image
     */
    public function getPortraitBlob() : string
    {
        return $this->blobPortrait;
    }
}


1			<?php
2			declare(strict_types=1);
3
4			namespace SKien\VCard;
5
6			/**
7			* Class representing all data to one contact.
8			* Each contact may contains multiple
9			* - adresses
10			* - communication numbers
11			* - e-mail addresses
12			* - homepages
13			* - categories
14			*
15			* #### Add a contact to a VCard for writing:
16			* Create a new instance of a `VCardContact`, set all properties and add the contact
17			* to a vcard using `VCard::addContact()`
18			*
19			* #### Retrieve a contact from a read VCard:
20			* Use `VCard::getContact()` to retrieve existing contact within vcard.
21			*
22			* @see VCard::addContact()
23			* @see VCard::getContact()
24			*
25			* @package VCard
26			* @author Stefanius <[email protected]>
27			* @copyright MIT License - see the LICENSE file for details
28			*/
29			class VCardContact
30			{
31			use VCardHelper;
32
33			/** gender: female (Microsoft specific) */
34			public const MS_FEMALE = '1';
35			/** gender: male (Microsoft specific) */
36			public const MS_MALE = '2';
37			/** Date type: string */
38			public const DT_STRING = 0;
39			/** Date type: unix timestamp */
40			public const DT_UNIX_TIMESTAMP = 1;
41			/** Date type: DateTime - Object */
42			public const DT_OBJECT = 2;
43
44			/** @var string lastname */
45			protected string $strLastName = '';
46			/** @var string firstname */
47			protected string $strFirstName = '';
48			/** @var string prefix (salutation, title,...) */
49			protected string $strPrefix = '';
50			/** @var string suffix (graduation,...) */
51			protected string $strSuffix = '';
52			/** @var string nickname */
53			protected string $strNickName = '';
54			/** @var string organisation name */
55			protected string $strOrganisation = '';
56			/** @var string position within the organisation */
57			protected string $strPosition = '';
58			/** @var string section within the organisation */
59			protected string $strSection = '';
60			/** @var string role / profession */
61			protected string $strRole = '';
62			/** @var VCardAddress[] array of VCardAddress objects */
63			protected array $aAddress = array();
64			/** @var array[] array of phone numbers */
65			protected array $aPhone = array();
66			/** @var string[] array of email addresses */
67			protected array $aEMail = array();
68			/** @var string[] array of categories */
69			protected array $aCategories = array();
70			/** @var string[] array of homepage URL's */
71			protected array $aHomepages = array();
72			/** @var string date of birth in format YYYY-MM-DD */
73			protected string $strDateOfBirth = '';
74			/** @var int gender (0: not specified, 1: female, 2: male) */
75			protected int $iGender = 0;
76			/** @var string note */
77			protected string $strNote = '';
78			/** @var string binary portrait base64 coded */
79			protected string $blobPortrait = '';
80
81			/**
82			* Add address.
83			* Only one address should be marked as preferred.
84			* @param VCardAddress $oAddress
85			* @param bool $bPreferred mark address as preferred.
86			*/
87			public function addAddress(VCardAddress $oAddress, bool $bPreferred) : void
88			{
89			$oAddress->setPreferred($bPreferred);
90			$this->aAddress[] = $oAddress;
91			}
92
93			/**
94			* Add phone number.
95			* Use to set a communication number (phone, mobile, FAX, ...). <br/>
96			* Any combination of the predefined communication number constants plus the definition
97			* HOME or WORK can be specified as the type. <br/>
98			* Multiple numbers of the same type can be set within one contact.
99			* @see VCard::constants VCard communication number constants
100			* @link https://datatracker.ietf.org/doc/html/rfc2426#section-3.3.1
101			* @link https://en.wikipedia.org/wiki/E.164
102			* @link https://www.itu.int/rec/T-REC-X.121-200010-I/en
103			* @param string $strPhone the number (SHOULD conform to the semantics of E.164 / X.121)
104			* @param string\|array $type one single type or an array of multiple types
105			* @param bool $bPreferred mark number as preferred
106			*/
107			public function addPhone(string $strPhone, $type, bool $bPreferred) : void
108			{
109			$strType = is_array($type) ? implode(',', $type) : $type;
110			if ($bPreferred && strpos($strType, 'PREF') === false) {
111			$strType .= ',PREF';
112			}
113			$this->aPhone[] = array('strPhone' => $strPhone, 'strType' => $strType);
114			}
115
116			/**
117			* Add mail address.
118			* @link https://datatracker.ietf.org/doc/html/rfc2426#section-3.3.2
119			* @param string $strEMail valid e-mail address
120			* @param bool $bPreferred mark e-mail as preferred
121			*/
122			public function addEMail(string $strEMail, bool $bPreferred) : void
123			{
124			if ($bPreferred) {
125			// just set preferred mail on top of the list!
126			array_unshift($this->aEMail, $strEMail);
127			} else {
128			$this->aEMail[] = $strEMail;
129			}
130			}
131
132			/**
133			* Add a category.
134			* @param string $strCategory
135			*/
136			public function addCategory(string $strCategory) : void
137			{
138			$this->aCategories[] = $strCategory;
139			}
140
141			/**
142			* Set date of birth.
143			* @param mixed $DateOfBirth may be string (format YYYY-MM-DD), int (unixtimestamp) or DateTime - object
144			*/
145			public function setDateOfBirth($DateOfBirth) : void
146			{
147			if (is_object($DateOfBirth) && get_class($DateOfBirth) == 'DateTime') {
148			// DateTime -object
149			$this->strDateOfBirth = $DateOfBirth->format('Y-m-d');
150			} else if (is_numeric($DateOfBirth)) {
151			$this->strDateOfBirth = date('Y-m-d', $DateOfBirth);
152			} else {
153			$this->strDateOfBirth = $DateOfBirth;
154			}
155			}
156
157			/**
158			* Set the gender.
159			* <b>Note: this is a MS-extension! </b><ul>
160			* <li> windows contacts: export/import. </li>
161			* <li> outlook: import only. </li></ul><br/>
162			* Only the first char of the `$strGender` param (converted to lowercase) is taken into account! <ul>
163			* <li> male: 'm', '2' </li>
164			* <li> female: 'f', 'w', '1' </li></ul>
165			* @param string $strGender
166			*/
167			public function setGender(string $strGender) : void
168			{
169			$chGender = strtolower(substr($strGender, 0, 1));
170			if (in_array($chGender, array('w', 'f', self::MS_FEMALE))) {
171			// weibl., female
172			$this->iGender = 1;
173			} elseif (in_array($chGender, array('m', self::MS_MALE))) {
174			// männl., male
175			$this->iGender = 2;
176			}
177			}
178
179			/**
180			* Set portrait from image file.
181			* Supported types are JPG, PNG, GIF and BMP. <br/>
182			* > <b>Note: </b></br>
183			* > For transparency the image type itself MUST support transparency (PNG, GIF)
184			* > and when reading a portrait, it MUST be saved in the same image format!
185			* @param string $strFilename
186			*/
187			public function setPortraitFile(string $strFilename) : void
188			{
189			if (filter_var($strFilename, FILTER_VALIDATE_URL)) {
190			// get type from extension
191			$strType = strtolower((string) pathinfo($strFilename, PATHINFO_EXTENSION));
192			$this->blobPortrait = 'data:image/' . $strType . ';base64,';
193
194			// use curl to be independet of [allow_url_fopen] enabled on the system
195			$curl = curl_init();
196			curl_setopt($curl, CURLOPT_URL, $strFilename);
197			curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
198
199			$img = curl_exec($curl);
200			curl_close($curl);
201
202			if (is_string($img)) {
203			$this->blobPortrait .= base64_encode($img);
204			}
205			} elseif (file_exists($strFilename)) {
206			switch (exif_imagetype($strFilename)) {
207			case IMAGETYPE_JPEG:
208			$this->blobPortrait = 'data:image/jpg;base64,';
209			break;
210			case IMAGETYPE_PNG:
211			$this->blobPortrait = 'data:image/png;base64,';
212			break;
213			case IMAGETYPE_GIF:
214			$this->blobPortrait = 'data:image/gif;base64,';
215			break;
216			case IMAGETYPE_BMP:
217			$this->blobPortrait = 'data:image/bmp;base64,';
218			break;
219			default:
220			break;
221			}
222			$img = file_get_contents($strFilename);
223
224			$this->blobPortrait .= base64_encode($img);
225			}
226			}
227
228			/**
229			* Set the full name.
230			* For companies just leave one of the params blank!
231			* @param string $strLastName
232			* @param string $strFirstName
233			*/
234			public function setName(string $strLastName, string $strFirstName) : void
235			{
236			$this->strLastName = $strLastName;
237			$this->strFirstName = $strFirstName;
238			}
239
240			/**
241			* Set (honorific) name prefix.
242			* i.E. 'Dr.', 'Prof.', ...
243			* @param string $strPrefix
244			*/
245			public function setPrefix(string $strPrefix) : void
246			{
247			$this->strPrefix = $strPrefix;
248			}
249
250			/**
251			* Set (honorific) name suffix.
252			* i.E. 'Jr.', 'M.D.', ...
253			* @param string $strSuffix
254			*/
255			public function setSuffix(string $strSuffix) : void
256			{
257			$this->strSuffix = $strSuffix;
258			}
259
260			/**
261			* Set nickname.
262			* @param string $strNickName
263			*/
264			public function setNickName(string $strNickName) : void
265			{
266			$this->strNickName = $strNickName;
267			}
268
269			/**
270			* Set name of the organisation.
271			* @param string $strOrganisation
272			*/
273			public function setOrganisation(string $strOrganisation) : void
274			{
275			$this->strOrganisation = $strOrganisation;
276			}
277
278			/**
279			* Set section or organizational unit within the organisation.
280			* @param string $strSection
281			*/
282			public function setSection(string $strSection) : void
283			{
284			$this->strSection = $strSection;
285			}
286
287			/**
288			* Set position, job title or function within the organisation.
289			* @param string $strPosition
290			*/
291			public function setPosition(string $strPosition) : void
292			{
293			$this->strPosition = $strPosition;
294			}
295
296			/**
297			* Set role, occupation or business category within the organisation.
298			* @param string $strRole
299			*/
300			public function setRole(string $strRole) : void
301			{
302			$this->strPosition = $strRole;
303			}
304
305			/**
306			* Set homepage
307			* @param string $strHomepage
308			*/
309			public function setHomepage(string $strHomepage) : void
310			{
311			// keep method for backward compatibility!
312			// just set value on top of the list!
313			array_unshift($this->aHomepages, $strHomepage);
314			trigger_error('call of VCardContact::setHomepage() is deprecated - use VCardContact::addtHomepage() instead!', E_USER_DEPRECATED);
315			}
316
317			/**
318			* Add homepage
319			* @param string $strHomepage
320			*/
321			public function addHomepage(string $strHomepage) : void
322			{
323			$this->aHomepages[] = $strHomepage;
324			}
325
326			/**
327			* Set annotation.
328			* @param string $strNote
329			*/
330			public function setNote(string $strNote) : void
331			{
332			$this->strNote = $strNote;
333			}
334
335			/**
336			* Set portrait from base64 encoded image data.
337			* @param string $blobPortrait base64 encoded image
338			*/
339			public function setPortraitBlob(string $blobPortrait) : void
340			{
341			$this->blobPortrait = $blobPortrait;
342			}
343
344			/**
345			* Save portrait as file.
346			* Supportet types are JPG, PNG, GIF and BMP
347			* The type depends on the fileextension. If no extensiomnm given, the
348			* type of the imported image will be used.
349			* @param string $strFilename
350			*/
351			public function savePortrait(string $strFilename) : void
352			{
353			if (strlen($this->blobPortrait) > 0) {
354			$strType = '';
355			$strImage = '';
356			$this->parseImageData($this->blobPortrait, $strType, $strImage);
357			if (strlen($strType) > 0 && strlen($strImage) > 0) {
358			$img = $this->imageFromString($strImage, $strType);
359			imagealphablending($img, true);
360			imagesavealpha($img, true);
361			$strExt = strtolower((string) pathinfo($strFilename, PATHINFO_EXTENSION));
362			if (strlen($strExt) == 0) {
363			$strExt = strtolower($strType);
364			$strFilename .= '.' . $strExt;
365			}
366			switch ($strExt) {
367			case 'jpg':
368			case 'jpeg':
369			imagejpeg($img, $strFilename);
370			break;
371			case 'png':
372			imagepng($img, $strFilename);
373			break;
374			case 'gif':
375			imagegif($img, $strFilename);
376			break;
377			case 'bmp':
378			imagebmp($img, $strFilename);
379			break;
380			}
381			}
382			}
383			}
384
385			/**
386			* Number of addresses the contact contains.
387			* @return int
388			*/
389			public function getAddressCount() : int
390			{
391			return count($this->aAddress);
392			}
393
394			/**
395			* Get address.
396			* An address can be referenced by index or by type. <br/>
397			* For Type requests (=> $i non numeric value): <ul>
398			* <li> The first address matches specified type is used (contact may contains multiple
399			* addresses of same type) </li>
400			* <li> If VCard::PREF is requested, the first preferred address in contact used (even
401			* if more than one is defined as preferred), if no preferred address found, the
402			* first address within the contact will be returned! </li></ul>
403			* @param int\|string $i reference to address (int => index, string => type)
404			* @return VCardAddress\|null valid address object or null, if not found
405			*/
406			public function getAddress($i) : ?VCardAddress
407			{
408			$oAddr = null;
409			if (is_numeric($i)) {
410			if ($i >= 0 && $i < count($this->aAddress)) {
411			$oAddr = $this->aAddress[$i];
412			}
413			} else {
414			foreach ($this->aAddress as $oAddress) {
415			if (strpos($oAddress->getType(), $i) !== false) {
416			$oAddr = $oAddress;
417			break;
418			}
419			}
420			}
421			if (!$oAddr && $i == VCard::PREF && count($this->aAddress) > 0) {
422			// if preferred item requested and no address in contact defined as prefered, just return first...
423			$oAddr = $this->aAddress[0];
424			}
425			return $oAddr;
426			}
427
428			/**
429			* Count of phone numbers.
430			* @return int
431			*/
432			public function getPhoneCount() : int
433			{
434			return count($this->aPhone);
435			}
436
437			/**
438			* Get phone number.
439			* Requested number can be referenced by index or type. <br/>
440			* For index request: `0 <= $i < self::getPhoneCount()` <br/>
441			* For type requests (=> $i non numeric value): <ul>
442			* <li> first phone matches specified type is used (contact may contains multiple phone numbers of same type) </li>
443			* <li> if VCard::PREF specified, first number in contact used, if no preferred item found </li></ul>
444			* @param mixed $i reference to address (int => index, string => type)
445			* @return array or null
446			*/
447			public function getPhone($i) : ?array
448			{
449			$aPhone = null;
450			if (is_numeric($i)) {
451			if ($i >= 0 && $i < count($this->aPhone)) {
452			$aPhone = $this->aPhone[$i];
453			}
454			} else {
455			foreach ($this->aPhone as $aPhone) {
456			if (strpos($aPhone['strType'], $i) !== false) {
457			return $aPhone;
458			}
459			$aPhone = null;
460			}
461			}
462			if (!$aPhone && $i == VCard::PREF && count($this->aPhone) > 0) {
463			// if preferred item requested and no phone in contact defined as prefered, just return first...
464			$aPhone = $this->aPhone[0];
465			}
466			return $aPhone;
467			}
468
469			/**
470			* Number of email addresses contained.
471			* @return int
472			*/
473			public function getEMailCount() : int
474			{
475			return count($this->aEMail);
476			}
477
478			/**
479			* Get EMail addres at given index.
480			* @param int $i index (`0 <= $i < self::getEMailCount()`)
481			* @return string
482			*/
483			public function getEMail(int $i) : string
484			{
485			$strEMail = '';
486			if ($i >= 0 && $i < count($this->aEMail)) {
487			$strEMail = $this->aEMail[$i];
488			}
489			return $strEMail;
490			}
491
492			/**
493			* Number of categories contained.
494			* @return int
495			*/
496			public function getCategoriesCount() : int
497			{
498			return count($this->aCategories);
499			}
500
501			/**
502			* Get category for given index.
503			* @param int $i index (`0 <= $i < self::getCategoriesCount()`)
504			* @return string
505			*/
506			public function getCategory(int $i) : string
507			{
508			$strCategory = '';
509			if ($i >= 0 && $i < count($this->aCategories)) {
510			$strCategory = $this->aCategories[$i];
511			}
512			return $strCategory;
513			}
514
515			/**
516			* Return Categories separated by comma.
517			* @return string
518			*/
519			public function getCategories() : string
520			{
521			$strCategories = '';
522			$strSep = '';
523			foreach ($this->aCategories as $strCategory) {
524			$strCategories .= $strSep . $strCategory;
525			$strSep = ',';
526			}
527			return $strCategories;
528			}
529
530			/**
531			* Get full name.
532			* `$strFirstName` followed by `$strLastName` separeted by blank.
533			* @return string
534			*/
535			public function getName() : string
536			{
537			$strSep = (empty($this->strFirstName) \|\| empty($this->strLastName)) ? '' : ' ';
538			return $this->strFirstName . $strSep . $this->strLastName;
539			}
540
541			/**
542			* Get lastname.
543			* @return string
544			*/
545			public function getLastName() : string
546			{
547			return $this->strLastName;
548			}
549
550			/**
551			* Get firstname.
552			* @return string
553			*/
554			public function getFirstName() : string
555			{
556			return $this->strFirstName;
557			}
558
559			/**
560			* Get nickname.
561			* @return string
562			*/
563			public function getNickName() : string
564			{
565			return $this->strNickName;
566			}
567
568			/**
569			* Get name of the organisation.
570			* @return string
571			*/
572			public function getOrganisation() : string
573			{
574			return $this->strOrganisation;
575			}
576
577			/**
578			* Get position, job title or function within the organisation.
579			* @return string
580			*/
581			public function getPosition() : string
582			{
583			return $this->strPosition;
584			}
585
586			/**
587			* Get role, occupation or business category within the organisation.
588			* @return string
589			*/
590			public function getRole() : string
591			{
592			return $this->strRole;
593			}
594
595			/**
596			* Number of homepages contained.
597			* @return int
598			*/
599			public function getHomepageCount() : int
600			{
601			return count($this->aHomepages);
602			}
603
604			/**
605			* Get homepage for given index.
606			* @param int $i index (`0 <= $i < self::getHomepageCount()`)
607			* @return string
608			*/
609			public function getHomepage(int $i = -1) : string
610			{
611			$strHomepage = '';
612			if ($i === -1) {
613			// default value -1 set for backward compatibility but give chance for a 'deprecated' message!
614			// version < 1.05 of this package hadn't support for multiple homepages!
615			trigger_error('call of VCardContact::getHomepage() without index is deprecated!', E_USER_DEPRECATED);
616			$i = 0;
617			}
618			if ($i >= 0 && $i < count($this->aHomepages)) {
619			$strHomepage = $this->aHomepages[$i];
620			}
621			return $strHomepage;
622			}
623
624			/**
625			* Get date of birth.
626			* The return type can be specified in the `$iType`parameter: <ul>
627			* <li><b> self::DT_STRING (default):</b> Date as String in f´the format set with `$strFormat`param (default = 'Y-m-d') </li>
628			* <li><b> self::DT_UNIX_TIMESTAMP:</b> Date as unix timestamp</li>
629			* <li><b> self::DT_OBJECT:</b> Date as DateTime object </li></ul>
630			*
631			* if the property is not set in the contact method returns: <ul>
632			* <li><b> self::DT_STRING:</b> empty string </li>
633			* <li><b> self::DT_UNIX_TIMESTAMP:</b> integer 0</li>
634			* <li><b> self::DT_OBJECT:</b> null </li></ul>
635			*
636			* @link https://datatracker.ietf.org/doc/html/rfc2426#section-3.1.5
637			* @link https://www.php.net/manual/en/datetime.format.php
638			* @param int $iType self::DT_STRING (default), self::DT_UNIX_TIMESTAMP or self::DT_OBJECT
639			* @param string $strFormat Date format compliant to DateTime::format() (default 'Y-m-d')
640			* @return string\|int\|\DateTime
641			*/
642			public function getDateOfBirth(int $iType = self::DT_STRING, string $strFormat = 'Y-m-d')
643			{
644			$dtBirth = new \DateTime($this->strDateOfBirth);
645			switch ($iType) {
646			case self::DT_UNIX_TIMESTAMP:
647			return (empty($this->strDateOfBirth) ? 0 : $dtBirth->getTimestamp());
648			case self::DT_OBJECT:
649			return (empty($this->strDateOfBirth) ? null : $dtBirth);
650			default:
651			return (empty($this->strDateOfBirth) ? '' : $dtBirth->format($strFormat));
652			}
653			}
654
655			/**
656			* Get gender (Microsoft only).
657			* @return int 0: not set, 1: female, 2: male
658			*/
659			public function getGender() : int
660			{
661			return $this->iGender;
662			}
663
664			/**
665			* Get section or organizational unit within the organisation.
666			* @return string
667			*/
668			public function getSection() : string
669			{
670			return $this->strSection;
671			}
672
673			/**
674			* Get annotation.
675			* @return string
676			*/
677			public function getNote() : string
678			{
679			return $this->strNote;
680			}
681
682			/**
683			* Get (honorific) name prefix.
684			* i.E. 'Dr.', 'Prof.', ...
685			* @return string
686			*/
687			public function getPrefix() : string
688			{
689			return $this->strPrefix;
690			}
691
692			/**
693			* Get (honorific) name suffix.
694			* i.E. 'Jr.', 'M.D.', ...
695			* @return string
696			*/
697			public function getSuffix() : string
698			{
699			return $this->strSuffix;
700			}
701
702			/**
703			* Get the image as base64 encoded string.
704			* @return string base64 encoded image
705			*/
706			public function getPortraitBlob() : string
707			{
708			return $this->blobPortrait;
709			}
710			}
711

Stefanius67 / VCard

Push — master ( 5ec36b...a966a8 )

VCardContact::getHomepageCount() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like