The Card object represents a single Card from an addressbook. More...

Inheritance diagram for Sabre\CardDAV\Card:

Collaboration diagram for Sabre\CardDAV\Card:

Public Member Functions
	__construct (Backend\BackendInterface $carddavBackend, array $addressBookInfo, array $cardData)
	Constructor. More...

	getName ()
	Returns the uri for this object. More...

	get ()
	Returns the VCard-formatted object. More...

	put ($cardData)
	Updates the VCard-formatted object. More...

	delete ()
	Deletes the card. More...

	getContentType ()
	Returns the mime content-type. More...

	getETag ()
	Returns an ETag for this object. More...

	getLastModified ()
	Returns the last modification date as a unix timestamp. More...

	getSize ()
	Returns the size of this object in bytes. More...

	getOwner ()
	Returns the owner principal. More...

	getACL ()
	Returns a list of ACE's for this node. More...

	put ($data)
	Replaces the contents of the file. More...

	get ()
	Returns the data. More...

	getSize ()
	Returns the size of the file, in bytes. More...

	getETag ()
	Returns the ETag for a file. More...

	getContentType ()
	Returns the mime-type for a file. More...

Public Member Functions inherited from Sabre\DAV\Node
	getLastModified ()
	Returns the last modification time as a unix timestamp. More...

	delete ()
	Deletes the current node. More...

	setName ($name)
	Renames the node. More...

	delete ()
	Deleted the current node. More...

	getName ()
	Returns the name of the node. More...

	setName ($name)
	Renames the node. More...

	getLastModified ()
	Returns the last modification time, as a unix timestamp. More...

	put ($data)
	Replaces the contents of the file. More...

	get ()
	Returns the data. More...

	getContentType ()
	Returns the mime-type for a file. More...

	getETag ()
	Returns the ETag for a file. More...

	getSize ()
	Returns the size of the node, in bytes. More...

Public Member Functions inherited from Sabre\DAVACL\IACL
	getOwner ()
	Returns the owner principal. More...

	getGroup ()
	Returns a group principal. More...

	getACL ()
	Returns a list of ACE's for this node. More...

	setACL (array $acl)
	Updates the ACL. More...

	getSupportedPrivilegeSet ()
	Returns the list of supported privileges for this node. More...

Protected Attributes
	$carddavBackend

	$cardData

	$addressBookInfo

Detailed Description

The Card object represents a single Card from an addressbook.

Copyright: Copyright (C) fruux GmbH (https://fruux.com/)

Author: Evert Pot (http://evertpot.com/) @license http://sabre.io/license/ Modified BSD License

Definition at line 15 of file Card.php.

Constructor & Destructor Documentation

◆ __construct()

Sabre\CardDAV\Card::__construct	(	Backend\BackendInterface	$carddavBackend,
		array	$addressBookInfo,
		array	$cardData
	)

Constructor.

Parameters

Backend\BackendInterface	$carddavBackend
array	$addressBookInfo
array	$cardData

Definition at line 47 of file Card.php.

                                                                                                            {
 
        $this->carddavBackend = $carddavBackend;
        $this->addressBookInfo = $addressBookInfo;
        $this->cardData = $cardData;
 
    }

References Sabre\CardDAV\Card\$addressBookInfo, Sabre\CardDAV\Card\$cardData, and Sabre\CardDAV\Card\$carddavBackend.

Member Function Documentation

◆ delete()

Sabre\CardDAV\Card::delete ( )

Deletes the card.

Returns: void

Implements Sabre\DAV\INode.

Definition at line 109 of file Card.php.

                      {
 
        $this->carddavBackend->deleteCard($this->addressBookInfo['id'], $this->cardData['uri']);
 
    }

◆ get()

Sabre\CardDAV\Card::get ( )

Returns the VCard-formatted object.

Returns: string

Reimplemented from Sabre\DAV\File.

Definition at line 71 of file Card.php.

                   {
 
        // Pre-populating 'carddata' is optional. If we don't yet have it
        // already, we fetch it from the backend.
        if (!isset($this->cardData['carddata'])) {
            $this->cardData = $this->carddavBackend->getCard($this->addressBookInfo['id'], $this->cardData['uri']);
        }
        return $this->cardData['carddata'];
 
    }

◆ getACL()

Sabre\CardDAV\Card::getACL ( )

Returns a list of ACE's for this node.

Each ACE has the following properties:

'privilege', a string such as {DAV:}read or {DAV:}write. These are currently the only supported privileges
'principal', a url to the principal who owns the node
'protected' (optional), indicating that this ACE is not allowed to be updated.

Returns: array

Implements Sabre\DAVACL\IACL.

Definition at line 199 of file Card.php.

                      {
 
        // An alternative acl may be specified through the cardData array.
        if (isset($this->cardData['acl'])) {
            return $this->cardData['acl'];
        }
 
        return [
            [
                'privilege' => '{DAV:}all',
                'principal' => $this->addressBookInfo['principaluri'],
                'protected' => true,
            ],
        ];
 
    }

◆ getContentType()

Sabre\CardDAV\Card::getContentType ( )

Returns the mime content-type.

Returns: string

Reimplemented from Sabre\DAV\File.

Definition at line 120 of file Card.php.

                              {
 
        return 'text/vcard; charset=utf-8';
 
    }

◆ getETag()

Sabre\CardDAV\Card::getETag ( )

Returns an ETag for this object.

Returns: string

Reimplemented from Sabre\DAV\File.

Definition at line 131 of file Card.php.

                       {
 
        if (isset($this->cardData['etag'])) {
            return $this->cardData['etag'];
        } else {
            $data = $this->get();
            if (is_string($data)) {
                return '"' . md5($data) . '"';
            } else {
                // We refuse to calculate the md5 if it's a stream.
                return null;
            }
        }
 
    }

References $data.

◆ getLastModified()

Sabre\CardDAV\Card::getLastModified ( )

Returns the last modification date as a unix timestamp.

Returns: int

Implements Sabre\DAV\INode.

Definition at line 152 of file Card.php.

                               {
 
        return isset($this->cardData['lastmodified']) ? $this->cardData['lastmodified'] : null;
 
    }

◆ getName()

Sabre\CardDAV\Card::getName ( )

Returns the uri for this object.

Returns: string

Implements Sabre\DAV\INode.

Definition at line 60 of file Card.php.

                       {
 
        return $this->cardData['uri'];
 
    }

◆ getOwner()

Sabre\CardDAV\Card::getOwner ( )

Returns the owner principal.

This must be a url to a principal, or null if there's no owner

Returns: string|null

Implements Sabre\DAVACL\IACL.

Definition at line 180 of file Card.php.

                        {
 
        return $this->addressBookInfo['principaluri'];
 
    }

◆ getSize()

Sabre\CardDAV\Card::getSize ( )

Returns the size of this object in bytes.

Returns: int

Reimplemented from Sabre\DAV\File.

Definition at line 163 of file Card.php.

                       {
 
        if (array_key_exists('size', $this->cardData)) {
            return $this->cardData['size'];
        } else {
            return strlen($this->get());
        }
 
    }

◆ put()

Sabre\CardDAV\Card::put ( $cardData )

Updates the VCard-formatted object.

Parameters

string $cardData

Returns: string|null

Reimplemented from Sabre\DAV\File.

Definition at line 88 of file Card.php.

                            {
 
        if (is_resource($cardData))
            $cardData = stream_get_contents($cardData);
 
        // Converting to UTF-8, if needed
        $cardData = DAV\StringUtil::ensureUTF8($cardData);
 
        $etag = $this->carddavBackend->updateCard($this->addressBookInfo['id'], $this->cardData['uri'], $cardData);
        $this->cardData['carddata'] = $cardData;
        $this->cardData['etag'] = $etag;
 
        return $etag;
 
    }

References Sabre\CardDAV\Card\$cardData, and Sabre\DAV\StringUtil\ensureUTF8().

Here is the call graph for this function:

Field Documentation

◆ $addressBookInfo

Sabre\CardDAV\Card::$addressBookInfo

protected

Definition at line 38 of file Card.php.

Referenced by Sabre\CardDAV\Card\__construct().

◆ $cardData

Sabre\CardDAV\Card::$cardData

protected

Definition at line 31 of file Card.php.

Referenced by Sabre\CardDAV\Card\__construct(), and Sabre\CardDAV\Card\put().

◆ $carddavBackend

Sabre\CardDAV\Card::$carddavBackend

protected

Definition at line 24 of file Card.php.

Referenced by Sabre\CardDAV\Card\__construct().

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

libs/composer/vendor/sabre/dav/lib/CardDAV/Card.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ delete()

◆ get()

◆ getACL()

◆ getContentType()

◆ getETag()

◆ getLastModified()

◆ getName()

◆ getOwner()

◆ getSize()

◆ put()

Field Documentation

◆ $addressBookInfo

◆ $cardData

◆ $carddavBackend