[ Index ]

PHP Cross Reference of DokuWiki

title

Body

[close]

/inc/ -> deprecated.php (summary)

These classes and functions are deprecated and will be removed in future releases

File Size: 565 lines (17 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 0 files

Defines 18 classes

RemoteAccessDeniedException:: (1 method):
  __construct()

RemoteException:: (2 methods):
  __construct()
  Doku_Lexer_Escape()

setting:: (1 method):
  __construct()

setting_authtype:: (1 method):
  __construct()

setting_string:: (1 method):
  __construct()

PageChangelog:: (1 method):
  __construct()

MediaChangelog:: (1 method):
  __construct()

JSON:: (5 methods):
  __construct()
  encode()
  enc()
  decode()
  dec()

Input:: (1 method):
  __construct()

PostInput:: (1 method):
  __construct()

GetInput:: (1 method):
  __construct()

ServerInput:: (1 method):
  __construct()

PassHash:: (1 method):
  __construct()

HTTPClientException:: (1 method):
  __construct()

HTTPClient:: (1 method):
  __construct()

DokuHTTPClient:: (2 methods):
  __construct()
  trigger_event()

Doku_Plugin_Controller:: (1 method):
  __construct()

Subscription:: (10 methods):
  isenabled()
  subscribers()
  add()
  remove()
  user_subscription()
  send_bulk()
  send_diff()
  send_media_diff()
  send_register()
  notifyaddresses()


Class: RemoteAccessDeniedException  - X-Ref


__construct($message = "", $code = 0, Throwable $previous = null)   X-Ref
No description

Class: RemoteException  - X-Ref


__construct($message = "", $code = 0, Throwable $previous = null)   X-Ref
No description

Doku_Lexer_Escape($str)   X-Ref
Escapes regex characters other than (, ) and /

return: string
param: string $str

Class: setting  - X-Ref


__construct($key, array $params = null)   X-Ref
No description

Class: setting_authtype  - X-Ref


__construct($key, array $params = null)   X-Ref
No description

Class: setting_string  - X-Ref


__construct($key, array $params = null)   X-Ref
No description

Class: PageChangelog  - X-Ref


__construct($id, $chunk_size = 8192)   X-Ref
No description

Class: MediaChangelog  - X-Ref


__construct($id, $chunk_size = 8192)   X-Ref
No description

Class: JSON  - X-Ref

Encode/Decode JSON

__construct($use = JSON_STRICT_TYPE)   X-Ref

param: int $use JSON_*_TYPE flag

encode($var)   X-Ref
Encode given structure to JSON

return: string
param: mixed $var

enc($var)   X-Ref
Alias for encode()

return: string
param: $var

decode($str)   X-Ref
Decode given string from JSON

return: mixed
param: string $str

dec($str)   X-Ref
Alias for decode

return: mixed
param: $str

Class: Input  - X-Ref


Class: PostInput  - X-Ref


Class: GetInput  - X-Ref


Class: ServerInput  - X-Ref


Class: PassHash  - X-Ref


Class: HTTPClientException  - X-Ref


__construct($message = '', $code = 0, $previous = null)   X-Ref


Class: HTTPClient  - X-Ref


Class: DokuHTTPClient  - X-Ref


__construct()   X-Ref


trigger_event($name, &$data, $action=null, $canPreventDefault=true)   X-Ref
function wrapper to process (create, trigger and destroy) an event

return: mixed                        the event results value after all event processing is complete
param: string   $name               name for the event
param: mixed    $data               event data
param: callback $action             (optional, default=NULL) default action, a php callback function
param: bool     $canPreventDefault  (optional, default=true) can hooks prevent the default action

Class: Doku_Plugin_Controller  - X-Ref


__construct()   X-Ref
No description

Class: Subscription  - X-Ref

Class for handling (email) subscriptions

isenabled()   X-Ref
Check if subscription system is enabled

return: bool

subscribers($page, $user = null, $style = null, $data = null)   X-Ref
Recursively search for matching subscriptions

This function searches all relevant subscription files for a page or
namespace.

author: Adrian Lang <lang@cosmocode.de>
return: array
param: string         $page The target object’s (namespace or page) id
param: string|array   $user
param: string|array   $style
param: string|array   $data

add($id, $user, $style, $data = '')   X-Ref
Adds a new subscription for the given page or namespace

This will automatically overwrite any existent subscription for the given user on this
*exact* page or namespace. It will *not* modify any subscription that may exist in higher namespaces.

return: bool
param: string $id The target page or namespace, specified by id; Namespaces
param: string $user
param: string $style
param: string $data

remove($id, $user = null, $style = null, $data = null)   X-Ref
Removes a subscription for the given page or namespace

This removes all subscriptions matching the given criteria on the given page or
namespace. It will *not* modify any subscriptions that may exist in higher
namespaces.

return: bool
param: string         $id   The target object’s (namespace or page) id
param: string|array   $user
param: string|array   $style
param: string|array   $data

user_subscription($id = '', $user = '')   X-Ref
Get data for $INFO['subscribed']

$INFO['subscribed'] is either false if no subscription for the current page
and user is in effect. Else it contains an array of arrays with the fields
“target”, “style”, and optionally “data”.

author: Adrian Lang <lang@cosmocode.de>
return: array|false
param: string $id  Page ID, defaults to global $ID
param: string $user User, defaults to $_SERVER['REMOTE_USER']

send_bulk($page)   X-Ref
Send digest and list subscriptions

This sends mails to all subscribers that have a subscription for namespaces above
the given page if the needed $conf['subscribe_time'] has passed already.

This function is called form lib/exe/indexer.php

return: int number of sent mails
param: string $page

send_diff($subscriber_mail, $template, $id, $rev = null, $summary = '')   X-Ref
Send the diff for some page change

return: bool                     true if successfully sent
param: string   $subscriber_mail The target mail address
param: string   $template        Mail template ('subscr_digest', 'subscr_single', 'mailtext', ...)
param: string   $id              Page for which the notification is
param: int|null $rev             Old revision if any
param: string   $summary         Change summary if any

send_media_diff($subscriber_mail, $template, $id, $rev = false)   X-Ref
Send the diff for some media change

param: string   $subscriber_mail The target mail address
param: string   $template        Mail template ('uploadmail', ...)
param: string   $id              Media file for which the notification is
param: int|bool $rev             Old revision if any

send_register($login, $fullname, $email)   X-Ref
Send a notify mail on new registration

author: Andreas Gohr <andi@splitbrain.org>
return: bool true if a mail was sent
param: string $login    login name of the new user
param: string $fullname full name of the new user
param: string $email    email address of the new user

notifyaddresses(&$data)   X-Ref
Default callback for COMMON_NOTIFY_ADDRESSLIST

Aggregates all email addresses of user who have subscribed the given page with 'every' style

author: Steven Danz <steven-danz@kc.rr.com>
author: Adrian Lang <lang@cosmocode.de>
param: array &$data Containing the entries: