### Install Dependencies Source: https://github.com/sabre-io/dav/blob/master/CONTRIBUTING.md Run this command to install project dependencies, including testing tools. ```bash composer install ``` -------------------------------- ### Start PHP Development Server Source: https://github.com/sabre-io/dav/blob/master/CONTRIBUTING.md Start a local PHP development server for testing. Ensure you are in the correct directory. ```bash php -S localhost:8000 -t vendor/sabre/http/tests/www ``` -------------------------------- ### Start the DAV Server Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-Server Initiates the execution of the DAV server to handle incoming requests. ```php void Sabre\DAV\Server::exec() ``` -------------------------------- ### exec Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-Server Starts the DAV Server, processing incoming HTTP requests and generating responses. ```APIDOC ## exec ### Description Starts the DAV Server. ### Method void Sabre\DAV\Server::exec() ``` -------------------------------- ### Invite Get Value Method Source: https://github.com/sabre-io/dav/wiki/Sabre-CalDAV-Property-Invite Retrieves the list of users as previously supplied to the constructor. ```php array Sabre\CalDAV\Property\Invite::getValue() ``` -------------------------------- ### Get Resource Information Path Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-FSExt-Node Returns the file system path associated with the resource. ```php string Sabre\DAV\FSExt\Node::getResourceInfoPath() ``` -------------------------------- ### Handle GET Method for Temporary Files Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-TemporaryFileFilterPlugin Processes GET requests for temporary files. If the file does not exist in the temporary location, it returns false, allowing the regular GET handler to proceed. ```php bool Sabre\DAV\TemporaryFileFilterPlugin::httpGet(string $tempLocation) ``` -------------------------------- ### Initialize Server with Tree or Node Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-Server Sets up the server with a directory tree, a single node as root, or an array of top-level children. If no argument is provided, a simple collection is created. ```php mixed Sabre\DAV\Server::__construct(\Sabre\DAV\Tree|\Sabre\DAV\INode|array|null $treeOrNode) ``` -------------------------------- ### Getting the HTTP Method Source: https://github.com/sabre-io/dav/wiki/Sabre-HTTP-Request Retrieve the HTTP request method, such as POST or GET. ```php string Sabre\HTTP\Request::getMethod() ``` -------------------------------- ### initialize Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-Locks-Plugin Initializes the plugin by setting up its connection to the server. ```APIDOC ## initialize ### Description This method is automatically called by the `Sabre\DAV\Server` class after the plugin has been added. It establishes the plugin's link to the server instance. ### Method ```php public function initialize(Sabre\DAV\Server $server) ``` ### Parameters #### Path Parameters * **server** (Sabre\DAV\Server) - Required - The server instance this plugin is attached to. ``` -------------------------------- ### Get Filename for URI Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-Locks-Backend-FS Protected method to get the filesystem filename for a given URI. This method is deprecated. ```php mixed Sabre\DAV\Locks\Backend\FS::getFileNameForUri($uri) ``` -------------------------------- ### Initialize Plugin Source: https://github.com/sabre-io/dav/wiki/Sabre-CalDAV-Plugin Initializes the plugin by setting up the reference to the server object. ```php void Sabre\CalDAV\Plugin::initialize(\Sabre\DAV\Server $server) ``` -------------------------------- ### Intercept GET Requests for Collections Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-Browser-Plugin Intercepts GET requests to collection resources and returns an HTML representation. ```php bool Sabre\DAV\Browser\Plugin::httpGetInterceptor(string $method, string $uri) ``` -------------------------------- ### initialize Source: https://github.com/sabre-io/dav/wiki/Sabre-CalDAV-Plugin Initializes the plugin by setting up its reference to the server object. ```APIDOC ## initialize ### Description Initializes the plugin. ### Method public ### Signature void initialize(\Sabre\DAV\Server $server) ### Arguments * $server (\Sabre\DAV\Server) - The server object instance. ``` -------------------------------- ### initialize Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-Browser-Plugin Initializes the plugin and subscribes it to server events. ```APIDOC ## initialize ### Description Initializes the plugin and subscribes to events. ### Method initialize ### Arguments * $server **[Sabre\DAV\Server](Sabre-DAV-Server)** ``` -------------------------------- ### TemporaryFileFilterPlugin httpGet Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-TemporaryFileFilterPlugin Handles the GET method for temporary files. If the temporary file does not exist, it returns false, allowing the regular system to handle the GET request. ```APIDOC ## httpGet ### Description This method handles the GET method for temporary files. If the file doesn't exist, it will return false which will kick in the regular system for the GET method. ### Method httpGet ### Arguments * $tempLocation (string) ### Returns (bool) ``` -------------------------------- ### initialize Method Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-Browser-GuessContentType Initializes the GuessContentType plugin by accepting the Sabre\DAV\Server object. ```APIDOC ## Method: initialize ### Description Initializes the plugin. ### Signature `void initialize(Sabre\DAV\Server $server)` ### Visibility `public` ### Arguments * **$server** (`Sabre\DAV\Server`) - The server instance. ``` -------------------------------- ### Intercept GET Requests and Convert to PROPFIND Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-Browser-MapGetToPropFind This method intercepts GET requests made to non-file resources and converts them into HTTP PROPFIND requests. It is a core function of the MapGetToPropFind plugin. ```php bool Sabre\DAV\Browser\MapGetToPropFind::httpGetInterceptor(string $method, string $uri) ``` -------------------------------- ### Getting the Requested URI Source: https://github.com/sabre-io/dav/wiki/Sabre-HTTP-Request Retrieve the URI that was requested. ```php string Sabre\HTTP\Request::getUri() ``` -------------------------------- ### initialize Source: https://github.com/sabre-io/dav/wiki/Sabre-CardDAV-Plugin Initializes the CardDAV plugin with the WebDAV server instance. ```APIDOC ## initialize ### Description Initializes the plugin with the provided Sabre\DAV\Server instance. ### Method public void initialize(\Sabre\DAV\Server $server) ### Arguments * $server **\Sabre\DAV\Server** - The server instance to initialize the plugin with. ``` -------------------------------- ### Get SimpleCollection Name Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-SimpleCollection Retrieves the name of the collection. ```php string Sabre\DAV\SimpleCollection::getName() ``` -------------------------------- ### Initialize Plugin Method Source: https://github.com/sabre-io/dav/wiki/Sabre-CardDAV-Plugin Initializes the CardDAV plugin with the provided WebDAV server instance. ```php void Sabre\CardDAV\Plugin::initialize(\Sabre\DAV\Server $server) ``` -------------------------------- ### Plugin Initialization Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-Browser-Plugin Initializes the plugin and subscribes it to server events. ```php void Sabre\DAV\Browser\Plugin::initialize(\Sabre\DAV\Server $server) ``` -------------------------------- ### Get Calendar Name Source: https://github.com/sabre-io/dav/wiki/Sabre-CalDAV-Calendar Retrieves the name of the calendar. ```php string Sabre\CalDAV\Calendar::getName() ``` -------------------------------- ### DigestAuth Get Username Source: https://github.com/sabre-io/dav/wiki/Sabre-HTTP-DigestAuth Retrieves the username from the current request. ```php string Sabre\HTTP\DigestAuth::getUsername() ``` -------------------------------- ### Client Constructor Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-Client Initializes the Sabre\DAV\Client with provided settings. Supported settings include baseUri, userName, password, and proxy. ```APIDOC ## __construct ### Description Constructor for the Sabre\DAV\Client. ### Arguments * $settings **array** - An array of settings. Supported keys are: * baseUri * userName (optional) * password (optional) * proxy (optional) ``` -------------------------------- ### Get AddressBook Name Source: https://github.com/sabre-io/dav/wiki/Sabre-CardDAV-AddressBook Retrieves the name of the address book. ```php string Sabre\CardDAV\AddressBook::getName() ``` -------------------------------- ### Plugin Constructor Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-Auth-Plugin Initializes the authentication plugin with a backend and a realm. ```APIDOC ## __construct ### Description Initializes the authentication plugin with a backend and a realm. ### Method public ### Signature Sabre\DAV\Auth\Plugin::__construct(\Sabre\DAV\Auth\Backend\BackendInterface $authBackend, string $realm) ``` -------------------------------- ### MapGetToPropFind Plugin Initialization Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-Browser-MapGetToPropFind Initializes the plugin and subscribes it to server events. This method is part of the Sabre\DAV\Browser\MapGetToPropFind class. ```php void Sabre\DAV\Browser\MapGetToPropFind::initialize(\Sabre\DAV\Server $server) ``` -------------------------------- ### Get Node Name Source: https://github.com/sabre-io/dav/wiki/Sabre-CardDAV-AddressBookRoot Returns the name of the current node. ```php string Sabre\CardDAV\AddressBookRoot::getName() ``` -------------------------------- ### __construct Source: https://github.com/sabre-io/dav/wiki/Sabre-CalDAV-Principal-User Initializes the principal object with a principal backend and properties. ```APIDOC ## __construct ### Description Creates the principal object. ### Method public ### Signature mixed __construct(\Sabre\DAVACL\IPrincipalBackend $principalBackend, array $principalProperties) ### Arguments * $principalBackend **Sabre\DAVACL\IPrincipalBackend** * $principalProperties **array** ``` -------------------------------- ### get Source: https://github.com/sabre-io/dav/wiki/Sabre-CalDAV-CalendarObject Fetches the content of the calendar object in iCalendar format. ```APIDOC ## get Sabre\CalDAV\CalendarObject ### Description Returns the ICalendar-formatted object. ### Returns * **string** - The iCalendar data for the object. ``` -------------------------------- ### File Authentication Backend Constructor Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-Auth-Backend-File Initializes the File authentication backend. Optionally parses a specified htdigest file upon creation. ```php mixed Sabre\DAV\Auth\Backend\File::__construct(string|null $filename) ``` -------------------------------- ### Getting HTTP Version Source: https://github.com/sabre-io/dav/wiki/Sabre-HTTP-Request Retrieve the HTTP version specified in the request. ```php string Sabre\HTTP\Request::getHTTPVersion() ``` -------------------------------- ### Initialize Sharing Plugin Source: https://github.com/sabre-io/dav/wiki/Sabre-CalDAV-SharingPlugin Initializes the plugin by setting up required event subscriptions after it's added to the server. ```php void Sabre\CalDAV\SharingPlugin::initialize(\Sabre\DAV\Server $server) ``` -------------------------------- ### Get All Children Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-SimpleCollection Returns a list of all child nodes within this collection. ```php array Sabre\DAV\SimpleCollection::getChildren() ``` -------------------------------- ### Get Children Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-Tree-Filesystem Returns a list of child nodes for a given path. ```APIDOC ## getChildren Tree ### Description Returns a list of childnodes for a given path. ### Method getChildren ### Arguments * $path **string** - The path for which to retrieve children. ``` -------------------------------- ### initialize Method Source: https://github.com/sabre-io/dav/wiki/Sabre-CalDAV-ICSExportPlugin Initializes the plugin and registers event handlers with the Sabre DAV Server. ```php void Sabre\CalDAV\ICSExportPlugin::initialize( Sabre\DAV\Server $server ) ``` -------------------------------- ### Get Href Value Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-Property-Href Retrieves the URL stored in the Href property. ```APIDOC ## getHref Sabre\DAV\Property\Href ### Description Returns the uri stored in the Href property. ### Method public ### Signature getHref(): string ``` -------------------------------- ### Plugin Initialization Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-Mount-Plugin Initializes the mount plugin and registers necessary event handlers with the SabreDAV server. ```APIDOC ## initialize ### Description Initializes the plugin and registers event handles. ### Method public function initialize(\Sabre\DAV\Server $server) ### Arguments * $server (**\Sabre\DAV\Server**) - Reference to the Server class. ``` -------------------------------- ### Get Href URI Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-Property-Href Retrieves the stored URI from the Href object. ```php string Sabre\DAV\Property\Href::getHref() ``` -------------------------------- ### Initialize Public Directories Property Source: https://github.com/sabre-io/dav/wiki/Sabre-CardDAV-Plugin Public property to configure URLs that will be exposed as user directories. ```php public array $directories = array() ``` -------------------------------- ### Get Resource Data Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-FSExt-Node Retrieves all stored resource information for the node. ```php array Sabre\DAV\FSExt\Node::getResourceData() ``` -------------------------------- ### get Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-FSExt-File Retrieves the entire content of the file as a readable stream resource. ```APIDOC ## get ### Description Returns the data of the file. ### Method `public resource get()` ### Returns * `resource` - A readable stream resource containing the file's data. ``` -------------------------------- ### __construct Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-FSExt-Directory Initializes the node by setting up the full path name. This is a public constructor. ```APIDOC ## __construct ### Description Sets up the node, expecting a full path name. ### Method public ### Signature `mixed Sabre\DAV\FS\Node::__construct(string $path)` ### Arguments * $path (string) - The full path name. ``` -------------------------------- ### AddressBook Constructor Source: https://github.com/sabre-io/dav/wiki/Sabre-CardDAV-AddressBook Initializes a new AddressBook instance with a CardDAV backend and address book information. ```php mixed Sabre\CardDAV\AddressBook::__construct( \Sabre\CardDAV\Backend\BackendInterface $carddavBackend, array $addressBookInfo ) ``` -------------------------------- ### get Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-FS-File Retrieves the data content of the file. The data is returned as a string. ```APIDOC ## get ### Description Returns the data content of the file. ### Method public ### Signature string Sabre\DAV\FS\File::get() ### Returns - **string** - The file data. ``` -------------------------------- ### Get Data (IFile Interface) Source: https://github.com/sabre-io/dav/wiki/Sabre-CalDAV-Notifications-Node Returns the node's data, which can be a string or a readable stream resource. ```php mixed Sabre\DAV\IFile::get() ``` -------------------------------- ### Get All User Calendars Source: https://github.com/sabre-io/dav/wiki/Sabre-CalDAV-UserCalendars Retrieves a list of all calendars associated with the user. ```php array Sabre\CalDAV\UserCalendars::getChildren() ``` -------------------------------- ### Sabre\DAV\Client Constructor Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-Client Initializes the Sabre\DAV\Client with provided settings. Supported settings include baseUri, userName, password, and proxy. ```php mixed Sabre\DAV\Client::__construct(array $settings) ``` -------------------------------- ### Get UserCalendars Name Source: https://github.com/sabre-io/dav/wiki/Sabre-CalDAV-UserCalendars Retrieves the name of the current UserCalendars object. ```php string Sabre\CalDAV\UserCalendars::getName() ``` -------------------------------- ### Get Card Size Source: https://github.com/sabre-io/dav/wiki/Sabre-CardDAV-Card Returns the size of the card object in bytes. ```php int Sabre\CardDAV\Card::getSize() ``` -------------------------------- ### initialize Source: https://github.com/sabre-io/dav/wiki/Sabre-DAVACL-Plugin Initializes the ACL plugin with the SabreDAV server instance. ```APIDOC ## initialize ### Description Sets up the plugin. This method is automatically called by the server class. ### Method `initialize(\Sabre\DAV\Server $server)` ### Arguments * `$server` (\Sabre\DAV\Server) - The SabreDAV server instance. ### Returns `void` ``` -------------------------------- ### Constructor for PDO Backend Source: https://github.com/sabre-io/dav/wiki/Sabre-CalDAV-Backend-PDO Initializes the PDO backend with a database connection and table names. ```php mixed Sabre\CalDAV\Backend\PDO::__construct(\PDO $pdo, string $calendarTableName, string $calendarObjectTableName) ``` -------------------------------- ### Get VCard Data Source: https://github.com/sabre-io/dav/wiki/Sabre-CardDAV-Card Fetches the VCard-formatted data for the current card. ```php string Sabre\CardDAV\Card::get() ``` -------------------------------- ### Get Card Name Source: https://github.com/sabre-io/dav/wiki/Sabre-CardDAV-Card Retrieves the URI (name) of the card object. ```php string Sabre\CardDAV\Card::getName() ``` -------------------------------- ### Filesystem Tree Constructor Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-Tree-Filesystem Initializes the Filesystem Tree with a base path on the filesystem. ```APIDOC ## __construct Filesystem ### Description Creates this tree. Supply the path you'd like to share. ### Method __construct ### Arguments * $basePath **string** - The base path on the filesystem to share. ``` -------------------------------- ### UserAddressBooks Constructor Source: https://github.com/sabre-io/dav/wiki/Sabre-CardDAV-UserAddressBooks Initializes a new instance of the UserAddressBooks class. ```APIDOC ## __construct ### Description Initializes a new instance of the UserAddressBooks class. ### Method __construct ### Arguments * $carddavBackend **[Sabre\CardDAV\Backend\BackendInterface](Sabre-CardDAV-Backend-BackendInterface)** - The backend interface for CardDAV operations. * $principalUri **string** - The principal URI associated with the user. ``` -------------------------------- ### Inject Properties Before Get Source: https://github.com/sabre-io/dav/wiki/Sabre-CalDAV-SharingPlugin Injects properties early when they are requested for a node. ```php void Sabre\CalDAV\SharingPlugin::beforeGetProperties(string $path, \Sabre\DAV\INode $node, array $requestedProperties, array $returnedProperties) ``` -------------------------------- ### initialize Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-ServerPlugin Initializes the plugin. This method is called by Sabre\DAV\Server after addPlugin is called and should be used to set up required event subscriptions. ```APIDOC ## initialize ### Description Initializes the plugin. This method is called by Sabre\DAV\Server, after addPlugin is called. This method should set up the required event subscriptions. ### Method `void Sabre\DAV\ServerPlugin::initialize(Sabre\DAV\Server $server)` ### Arguments * $server (Sabre\DAV\Server) - The server instance. ``` -------------------------------- ### Get Node Name Source: https://github.com/sabre-io/dav/wiki/Sabre-CalDAV-Notifications-Node Retrieves the path name for the notification node. ```php \Sabre\CalDAV\Notifications\id Sabre\CalDAV\Notifications\Node::getName() ``` -------------------------------- ### Node Constructor Source: https://github.com/sabre-io/dav/wiki/Sabre-CalDAV-Notifications-Node Initializes a new Node instance with the CalDAV backend, principal URI, and notification type. ```php mixed Sabre\CalDAV\Notifications\Node::__construct(\Sabre\CalDAV\Backend\NotificationSupport $caldavBackend, string $principalUri, \Sabre\CalDAV\Notifications\INotificationType $notification) ``` -------------------------------- ### Principal Get Type Method Source: https://github.com/sabre-io/dav/wiki/Sabre-DAVACL-Property-Principal Returns the principal type of the Principal object. ```php int Sabre\DAVACL\Property\Principal::getType() ``` -------------------------------- ### Initialize SabreDAV Locks Plugin Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-Locks-Plugin Instantiate the File backend and the Locks plugin, then add the plugin to the server. This is the basic setup for enabling locking. ```php $lockBackend = new Sabre\DAV\Locks\Backend\File('./mylockdb'); $lockPlugin = new Sabre\DAV\Locks\Plugin($lockBackend); $server->addPlugin($lockPlugin); ``` -------------------------------- ### Get Quota Information Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-FSExt-Directory Retrieves information about the available disk space for the directory. ```php array Sabre\DAV\FSExt\Directory::getQuotaInfo() ``` -------------------------------- ### Sabre\DAV\FS\Node Constructor Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-FS-Node Initializes a new Node object. Expects the full path to the node as an argument. ```php mixed Sabre\DAV\FS\Node::__construct(string $path) ``` -------------------------------- ### Sabre\DAV\File::getSize() - Get File Size Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-File Returns the size of the file in bytes. ```php int Sabre\DAV\File::getSize() ``` -------------------------------- ### Initialize ACL Plugin Source: https://github.com/sabre-io/dav/wiki/Sabre-DAVACL-Plugin Sets up the ACL plugin by integrating it with the SabreDAV server instance. This method is automatically invoked by the server. ```php void Sabre\DAVACL\Plugin::initialize(\Sabre\DAV\Server $server) ``` -------------------------------- ### httpGetInterceptor Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-Browser-Plugin Intercepts GET requests to collection resources and generates an HTML index. ```APIDOC ## httpGetInterceptor ### Description This method intercepts GET requests to collections and returns the html. ### Method httpGetInterceptor ### Arguments * $method **string** * $uri **string** ### Returns **bool** ``` -------------------------------- ### Plugin Initialization Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-Locks-Plugin Demonstrates how to initialize and add the Locks plugin to a SabreDAV server. ```APIDOC ## Plugin Initialization ### Description This snippet shows the basic setup for integrating the SabreDAV Locks plugin into your server. ### Code ```php $lockBackend = new Sabre\DAV\Locks\Backend\File('./mylockdb'); $lockPlugin = new Sabre\DAV\Locks\Plugin($lockBackend); $server->addPlugin($lockPlugin); ``` ``` -------------------------------- ### Get Plugin Name Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-Auth-Plugin Returns the name of the plugin, which can be used by other plugins to access it. ```APIDOC ## getPluginName ### Description Returns a plugin name. Using this name other plugins will be able to access other plugins using DAV\Server::getPlugin. ### Method public ### Signature string Sabre\DAV\Auth\Plugin::getPluginName() ``` -------------------------------- ### Before Get Properties Hook Source: https://github.com/sabre-io/dav/wiki/Sabre-CardDAV-Plugin Adds CardDAV-specific properties before properties are retrieved for a node. ```php void Sabre\CardDAV\Plugin::beforeGetProperties(string $path, \Sabre\DAV\INode $node, array $requestedProperties, array $returnedProperties) ``` -------------------------------- ### __construct Source: https://github.com/sabre-io/dav/wiki/Sabre-DAVACL-AbstractPrincipalCollection Initializes the AbstractPrincipalCollection with a principal backend and an optional principal prefix. ```APIDOC ## __construct AbstractPrincipalCollection ### Description Creates the object. This object must be passed the principal backend. This object will filter all principals from a specified prefix ($principalPrefix). The default is 'principals', if your principals are stored in a different collection, override $principalPrefix. ### Method public ### Signature __construct(\Sabre\DAVACL\PrincipalBackend\BackendInterface $principalBackend, string $principalPrefix) ### Arguments * $principalBackend **[Sabre\DAVACL\PrincipalBackend\BackendInterface](Sabre-DAVACL-PrincipalBackend-BackendInterface)** - The principal backend to use. * $principalPrefix **string** - The prefix for principal collections. ``` -------------------------------- ### Get Content Type Source: https://github.com/sabre-io/dav/wiki/Sabre-CardDAV-Card Returns the MIME content-type of the card, typically 'text/vcard'. ```php string Sabre\CardDAV\Card::getContentType() ``` -------------------------------- ### __construct Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-FS-File Initializes the file node with a full path name. This is inherited from the parent Sabre\DAV\FS\Node class. ```APIDOC ## __construct ### Description Sets up the node, expects a full path name. ### Method public ### Signature Mixed Sabre\DAV\FS\Node::__construct(string $path) ### Arguments #### $path - **path** (string) - The full path name for the node. ``` -------------------------------- ### Get All Cards Source: https://github.com/sabre-io/dav/wiki/Sabre-CardDAV-AddressBook Retrieves a list of all cards contained within the address book. ```php array Sabre\CardDAV\AddressBook::getChildren() ``` -------------------------------- ### __construct Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-Auth-Backend-File Creates the backend object. If the filename argument is passed in, it will parse out the specified file first. ```APIDOC ## __construct ``` mixed Sabre\DAV\Auth\Backend\File::__construct(string|null $filename) ``` ### Description Creates the backend object. If the filename argument is passed in, it will parse out the specified file fist. ### Arguments * $filename **string|null** ``` -------------------------------- ### Get Principals by Prefix - BackendInterface Source: https://github.com/sabre-io/dav/wiki/Sabre-DAVACL-PrincipalBackend-BackendInterface Implement this method to retrieve a list of principals that fall under a given base path. The prefix often corresponds to a 'principals' directory. Each principal should at least have a 'uri', and can optionally include properties like '{DAV:}displayname' or '{http://sabredav.org/ns}email-address'. ```php array Sabre\DAVACL\PrincipalBackend\BackendInterface::getPrincipalsByPrefix(string $prefixPath) ``` -------------------------------- ### Get Specific Card Source: https://github.com/sabre-io/dav/wiki/Sabre-CardDAV-AddressBook Retrieves a specific card from the address book by its name. ```php \ICard Sabre\CardDAV\AddressBook::getChild(string $name) ``` -------------------------------- ### Get Children Source: https://github.com/sabre-io/dav/wiki/Sabre-CalDAV-Principal-User Returns an array containing all the child nodes within this collection. ```php \Sabre\DAV\INode[] Sabre\CalDAV\Principal\User::getChildren() ``` -------------------------------- ### __construct Source: https://github.com/sabre-io/dav/wiki/Sabre-CardDAV-AddressBookRoot Constructor for the AddressBookRoot class. It initializes the object with principal and CardDAV backends, and an optional principal prefix. ```APIDOC ## __construct ### Description Constructor for the AddressBookRoot class. It initializes the object with principal and CardDAV backends, and an optional principal prefix. ### Method __construct ### Arguments * $principalBackend **[Sabre\DAVACL\PrincipalBackend\BackendInterface](Sabre-DAVACL-PrincipalBackend-BackendInterface)** * $carddavBackend **[Sabre\CardDAV\Backend\BackendInterface](Sabre-CardDAV-Backend-BackendInterface)** * $principalPrefix **string** ``` -------------------------------- ### AddressBookRoot Constructor Source: https://github.com/sabre-io/dav/wiki/Sabre-CardDAV-AddressBookRoot Initializes the AddressBookRoot with principal and CardDAV backends. Optionally overrides the default principal path. ```php mixed Sabre\CardDAV\AddressBookRoot::__construct( \Sabre\DAVACL\PrincipalBackend\BackendInterface $principalBackend, \Sabre\CardDAV\Backend\BackendInterface $carddavBackend, string $principalPrefix ) ``` -------------------------------- ### Get Child Nodes Source: https://github.com/sabre-io/dav/wiki/Sabre-CalDAV-Schedule-Outbox Retrieves an array of all child nodes within the collection. ```php \Sabre\DAV\INode[] Sabre\CalDAV\Schedule\Outbox::getChildren() ``` -------------------------------- ### Get Node Name Source: https://github.com/sabre-io/dav/wiki/Sabre-CalDAV-ICalendar Returns the name of the node, which is used for generating its URL. ```php string Sabre\DAV\INode::getName() ``` -------------------------------- ### Sabre\CardDAV\AddressBook::__construct Source: https://github.com/sabre-io/dav/wiki/Sabre-CardDAV-AddressBook Initializes a new instance of the AddressBook class. ```APIDOC ## __construct ### Description Constructor for the AddressBook class. ### Arguments * $carddavBackend - An instance of Sabre\CardDAV\Backend\BackendInterface. * $addressBookInfo - An array containing information about the addressbook. ``` -------------------------------- ### Getting the Query String Source: https://github.com/sabre-io/dav/wiki/Sabre-HTTP-Request Extract and return the portion of the URL that appears after the question mark (?). ```php string Sabre\HTTP\Request::getQueryString() ``` -------------------------------- ### Initialize GuessContentType Plugin Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-Browser-GuessContentType Initializes the GuessContentType plugin by hooking into the Sabre DAV Server. ```php void Sabre\DAV\Browser\GuessContentType::initialize(\Sabre\DAV\Server $server) ``` -------------------------------- ### Create Directory Source: https://github.com/sabre-io/dav/wiki/Sabre-CalDAV-Principal-User Creates a new subdirectory with the specified name. ```php void Sabre\CalDAV\Principal\User::createDirectory(string $name) ``` -------------------------------- ### Principal Get Href Method Source: https://github.com/sabre-io/dav/wiki/Sabre-DAVACL-Property-Principal Returns the principal URI for HREF type principals. ```php string Sabre\DAVACL\Property\Principal::getHref() ``` -------------------------------- ### Serve Asset via HTTP Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-Browser-Plugin Reads an asset from disk and generates a complete HTTP response to serve it. ```php void Sabre\DAV\Browser\Plugin::serveAsset(string $assetName) ``` -------------------------------- ### Get All Child Nodes Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-FSExt-Directory Returns an array containing all child nodes within the directory. ```php \Sabre\DAV\INode[] Sabre\DAV\FSExt\Directory::getChildren() ``` -------------------------------- ### Sabre\CalDAV\Backend\PDO::__construct Source: https://github.com/sabre-io/dav/wiki/Sabre-CalDAV-Backend-PDO Creates a new instance of the PDO CalDAV backend. ```APIDOC ## __construct PDO ### Description Creates the backend. ### Method __construct ### Arguments * $pdo **PDO** - The PDO database connection. * $calendarTableName **string** - The name of the table used for calendars. * $calendarObjectTableName **string** - The name of the table used for calendar objects. ``` -------------------------------- ### PDO CardDAV Backend Constructor Source: https://github.com/sabre-io/dav/wiki/Sabre-CardDAV-Backend-PDO Initializes the PDO CardDAV backend with a PDO connection and table names for addressbooks and cards. ```APIDOC ## __construct Sabre\CardDAV\Backend\PDO ### Description Sets up the PDO CardDAV backend object. ### Method __construct ### Arguments * $pdo (PDO) - The PDO database connection instance. * $addressBooksTableName (string) - The name of the PDO table used for storing addressbooks. * $cardsTableName (string) - The name of the PDO table used for storing cards. ``` -------------------------------- ### beforeMethod Source: https://github.com/sabre-io/dav/wiki/Sabre-CardDAV-VCFExportPlugin Intercepts GET requests ending with '?export' to handle VCF export operations. ```APIDOC ## beforeMethod ### Description 'beforeMethod' event handles. This event intercepts GET requests ending with '?export'. ### Method public ### Signature `bool beforeMethod(string $method, string $uri)` ### Arguments * $method (string) - The HTTP method. * $uri (string) - The requested URI. ``` -------------------------------- ### Get Last Modified Time Source: https://github.com/sabre-io/dav/wiki/Sabre-CalDAV-UserCalendars Returns the last modification timestamp of the UserCalendars object. ```php int Sabre\CalDAV\UserCalendars::getLastModified() ``` -------------------------------- ### Get Address Books for User (PHP) Source: https://github.com/sabre-io/dav/wiki/Sabre-CardDAV-Backend-AbstractBackend Implement this method to return a list of address books for a given user. Each address book must include 'id', 'uri', and 'principaluri'. Additional properties like 'displayname' and 'addressbook-description' are recommended. ```php array Sabre\CardDAV\Backend\BackendInterface::getAddressBooksForUser(string $principalUri) ``` -------------------------------- ### SystemStatus Constructor Source: https://github.com/sabre-io/dav/wiki/Sabre-CalDAV-Notifications-Notification-SystemStatus Initializes a new SystemStatus notification. A unique ID is required for generating a URL. ```php mixed Sabre\CalDAV\Notifications\Notification\SystemStatus::__construct(string $id, string $etag, int $type, string $description, string $href) ``` -------------------------------- ### Get Child Node Source: https://github.com/sabre-io/dav/wiki/Sabre-CalDAV-Principal-User Retrieves a specific child node from the collection, referenced by its name. ```php \Sabre\DAV\INode Sabre\CalDAV\Principal\User::getChild(string $name) ``` -------------------------------- ### Get Features Source: https://github.com/sabre-io/dav/wiki/Sabre-CalDAV-Plugin Returns a list of features supported by this plugin for the DAV: HTTP header. ```php array Sabre\CalDAV\Plugin::getFeatures() ``` -------------------------------- ### AWSAuth Initialization Source: https://github.com/sabre-io/dav/wiki/Sabre-HTTP-AWSAuth Call this method to gather all necessary information from the HTTP headers before performing any other operations. ```php bool Sabre\HTTP\AWSAuth::init() ``` -------------------------------- ### Tag a Release Source: https://github.com/sabre-io/dav/blob/master/CONTRIBUTING.md Tag a specific version for a release. Replace '3.0.1' with the desired version number. ```bash git tag 3.0.1 ``` -------------------------------- ### Outbox Constructor Source: https://github.com/sabre-io/dav/wiki/Sabre-CalDAV-Schedule-Outbox Initializes the Outbox object with the principal URI. ```php mixed Sabre\CalDAV\Schedule\Outbox::__construct(string $principalUri) ``` -------------------------------- ### Get Principal URL Source: https://github.com/sabre-io/dav/wiki/Sabre-CalDAV-Principal-IProxyRead Returns the full principal URL. This method is inherited from Sabre\DAVACL\IPrincipal. ```php string Sabre\DAVACL\IPrincipal::getPrincipalUrl() ``` -------------------------------- ### Initialize TemporaryFileFilterPlugin Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-TemporaryFileFilterPlugin This method is automatically called by the Server class after the plugin is added. It initializes the plugin's connection to the server. ```php void Sabre\DAV\TemporaryFileFilterPlugin::initialize( \Sabre\DAV\Server $server ) ``` -------------------------------- ### Get Calendar Owner Source: https://github.com/sabre-io/dav/wiki/Sabre-CalDAV-Calendar Returns the URL of the principal who owns the calendar, or null if there is no owner. ```php string|null Sabre\CalDAV\Calendar::getOwner() ``` -------------------------------- ### File Lock Backend Constructor Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-Locks-Backend-File Initializes the File lock backend with the path to the file where lock data will be stored. ```php public function __construct(string $locksFile) ``` -------------------------------- ### Get Calendar Object Source: https://github.com/sabre-io/dav/wiki/Sabre-CalDAV-Calendar Retrieves a specific calendar object (Event or Todo) by its name. ```php \Sabre\CalDAV\ICalendarObject Sabre\CalDAV\Calendar::getChild(string $name) ``` -------------------------------- ### Handle PROPFIND Method for Temporary Files Source: https://github.com/sabre-io/dav/wiki/Sabre-DAV-TemporaryFileFilterPlugin Processes PROPFIND requests for temporary files. This method is simplified and sends back a default set of properties without inspecting the request body. ```php bool Sabre\DAV\TemporaryFileFilterPlugin::httpPropfind(string $tempLocation, string $uri) ``` -------------------------------- ### Get All Child Nodes Source: https://github.com/sabre-io/dav/wiki/Sabre-CalDAV-ICalendar Returns an array containing all child nodes within the collection. ```php \Sabre\DAV\DAV\INode[] Sabre\DAV\ICollection::getChildren() ``` -------------------------------- ### Create Directory (Not Supported) Source: https://github.com/sabre-io/dav/wiki/Sabre-CardDAV-AddressBook Attempts to create a subdirectory within the address book. This operation is blocked as subdirectories are not allowed. ```php void Sabre\CardDAV\AddressBook::createDirectory(string $name) ``` -------------------------------- ### getFeatures Method Source: https://github.com/sabre-io/dav/wiki/Sabre-CalDAV-ICSExportPlugin Returns a list of server-features supported by the plugin, such as 'versioning'. ```php array Sabre\DAV\ServerPlugin::getFeatures() ``` -------------------------------- ### Getting the Request Body Source: https://github.com/sabre-io/dav/wiki/Sabre-HTTP-Request Retrieve the HTTP request body. Can be returned as a stream resource or a string. ```php resource Sabre\HTTP\Request::getBody(bool $asString) ``` -------------------------------- ### initialize Source: https://github.com/sabre-io/dav/wiki/Sabre-CardDAV-VCFExportPlugin Initializes the plugin and registers event handlers. This method is called by the Sabre DAV Server. ```APIDOC ## initialize ### Description Initializes the plugin and registers event handlers. ### Method public ### Signature `void initialize(Sabre\DAV\Server $server)` ### Arguments * $server (Sabre\DAV\Server) - Reference to the Server class. ```