PHPdocs keywords

List of keywords used in phpdoc attributes.

Keyword Value Count
@TODO This isn't a unit test and I'm not sure we need this file. 1
@dataProvider parseURLsProvider 1
@deprecated Use \Idno\Core\Idno::site() 1
MongoDB support is being phased out, please use MySQL. 1
* @return array 1
* @param string $path_info The path, including the initial /, or the URL 1
* @return mixed 1
Use Entity::getID() if you want a canonical ID of an entity 1
Mongo can no longer handle sessions. 1
This needs to be moved into the front end js to handle proxies etc 1
* @param string $pattern The pattern to match 2
* @param $class 2
*/ 3
@package Idno\Files 1
@param type $expected 1
$subject 1
$email The email address of the account 1
$name The name of the account 1
string $email The email address of the recipient 1
string $name The name of the recipient (optional) 1
$template_name 1
array $vars 1
$body The formatted HTML body text of the message 1
bool $shell Should the message be placed inside the pageshell? Default: true 1
array $shellVars Variables to pass to the page shell template 1
type $template_name 1
type $vars 1
string $body The body of the message 1
type $language Which language is this for? Default 'en_US' 1
Entity $object 1
bool $value True to ignore 1
array $row 1
int $limit 1
int $offset 1
mixed $variable 1
string $service The name of the service. 1
callable $checker A function that will return true if the current user has the service enabled; false otherwise 1
array $content_types An array of content types that the service supports syndication for 1
string $service The name of the service. 1
string $username The username or user identifier on the service. 1
string $display_name A human-readable name for this account. 1
array $other_properties An optional list of additional properties to include in the account record 1
string $timezone E.g as returned by $user->getTimezone() 1
type $timestamp Optionally, an epoch timestamp. Defaults to the current time. 1
int $offset 1
type $timezone1 1
type $timezone2 1
type $diff 1
string $label The text of the link 1
array $data Array of name:value pairs that will be submitted to $pageurl 1
array $options Array of options for future use (optional) 1
string $body The body for the form 1
string $pageurl The URL of the page we're signing for 1
$server 1
$callback 1
\Idno\Entities\AsynchronousQueuedEvent $event 1
type $url Endpoint URL you're calling 1
type $endpoint 1
type $func 1
string $path_info The path, including the initial /, or the URL 1
string $hookName Name of hook 1
callable $callable 1
array $message 1
boolean $is_api_request 1
The configuration setting value to retrieve (optional) 1
string $className Class name of component, either partial or full namespace 1
string $expectedBaseClass Class type to verify newly created component against 1
string $defaultClassNameBase If a full namespace is not provided in $configValue, use this value as base class namespace 1
string $defaultClass If class could not be constructed, return a new instance of this class name 1
string $verb The verb to send the request with; one of POST, GET, DELETE, PUT 1
string $endpoint The URI to send the request to 1
string $endpoint The URI to send the POST request to 1
$ch 1
null $maxredirect 1
string $endpoint The URI to send the HEAD request to 1
string $endpoint The URI to send the PUT request to 1
string $endpoint The URI to send the DELETE request to 1
string $endpoint The URI to send the GET request to 1
string $url The endpoint url 1
string|array $headers 1
string $plugin Plugin name 1
string $plugin The plugin 1
$basic_html Should the purifier strip out inline styles and similar attributes? Defaults to false. 1
$mf2_content 1
$rss_content 1
$update Set to true in order to refresh saved feed details. False by default. 1
type $domain 'known' for core, 'mypluginname' for plugins 1
type $path Full path to where to find the translations. 1
string $eventName 1
\Idno\Core\Event $event 1
$latitude 1
$longitude 1
string $address 1
$report string Named report to gather, or empty for all. 1
$pageURL Page URL 1
string $text The text to mine for links 1
$sourceURL 1
$targetURL 1
$pageURL 1
bool $sourceBody 1
array $inreplyto 1
array $response (optional) response from fetching $url 1
$content HTML to parse 1
$url Optionally, the source URL of the content, so relative URLs can be parsed into absolute ones 1
array $mf2 parsed mf2 document 1
string $url the source url of the document 1
array or string $types the type or types of an item to consider 1
array $mf2 the full parsed mf2 document 1
string $url the url of the document 1
array $item the mf2 item in question 1
string $source_content the fetched HTML content 1
string $source url for the source 1
$content The content of the page 1
$url The URL of the page 1
string $queueName the named queue to put this event on (currently unused) 1
string $eventName the name of the event, e.g. "webmention/send" 1
array $eventData the data sent to the event when it is triggered. 1
array $args 1
string $str 1
string $field 1
int $length Length in bytes 1
type $length Length in bytes 1
string $token 1
\Idno\Core\Translation $translation 1
bool $full if true, the full locale is returned, e.g. en_GB 1
type $file 1
type $upload_path 1
type $ini_file 1
array $params Name => Value array of configuration values, e.g. "dbname" => "known" 1
type $host 1
type $dbname 1
type $user 1
type $pass 1
type $schema 1
type $limit 1
type $offset 1
$url the URL of the page to check 1
$page optionally, the contents of the page at $url 1
\Idno\Common\Entity $object 1
$elements 1
string $default Value to default to if the cache does not exist 1
$save_path 1
$dir Path to export 1
bool|true $hide_private Should we hide private posts? Default: true. 1
string $user_uuid User UUID to export for. Default: all users. 1
type $loglevel_filter Log levels to show 0 - off, 1 - errors, 2 - errors & warnings, 3 - errors, warnings and info, 4 - 3 + debug 1
type $identifier Identify this site in the log (defaults to current domain) 1
$loglevel 1
type $message 1
type $title 1
type $html 1
type $name Name of the control 1
type $values Array of form value. Common are 'type', 'description', 'id' 1
$vars 1
$html_text 1
int $paras Number of paragraphs to return; defaults to 1 1
type $chars 1
$variable_name 1
string $variable_value 1
$match_host If set to true (default), only changes the URI if the host matches the site's host 1
url $url 1
int Maximum dimensions of proxied image 1
string Transformations. Currently only 'square' is supported. 1
string $text 1
string $code Optionally, code to inject into the anchor tag (eg to add classes). '%URL%' is replaced with the URL. Default: blank. 1
bool $wbr Optionally, inject tag. Default: true. 1
type $text The text to parse 1
type $in_reply_to If specified, the function will make a (hopefully) sensible guess as to where the user is located 1
$label 1
$objectType 1
type $file The file, relative to the known path. 1
$name Name of variable to set 1
$value Value 1
$name Name of variable to retrieve 1
$vars array Variables to add to the template (eg array('name1' => 'value1', 'name2' => 'value2')) 1
string $templateName Name of the template element to draw 1
boolean $returnBlank If true, returns a blank string on failure; otherwise false 1
$items An array of PHP objects 1
$item PHP object 1
$content Some content 1
$processor Optionally, the processor you want to use (default: text) 1
$echo If set to true (by default), echoes the page; otherwise returns it 1
string Name of the template type 1
string $path A full path 1
string $targetURL URL for the form to point to 1
string $targetURL The URL of the form action we're using. 1
int $time The current timestamp. 1
type $field 1
string|bool $user (By default this isn't set) 1
Traversable $iterator 1
callable $func 1
$slugs 1
$class The string name of a class that extends Idno\Common\ContentType. 1
int $width The width of the icon to be returned. (Returned icon may not be the exact width.) 1
string $location Location to forward to (eg "/foo/bar") 1
bool $exit If set to true (which it is by default), execution finishes once the header is sent. 1
string $fwd 1
bool $string If set to true, will return a string instead of forwarding 1
string $source The source URL (i.e., third-party site URL) 1
string $target The target URL (i.e., this page) 1
array $source_response The Webservice response from fetching the source page 1
array $source_mf2 The full, parsed Microformats 2 content of the source URL 1
object $entity 1
bool $status Is this a permalink? Defaults to 'true' 1
object $entity Optionally, an entity this page is associated with 1
$tokenise bool If true then an exploded tokenised version is returned. 1
type $path Path, relative to the Known base 1
array $url 1
string $contentType The MIME content type. 1
bool $ignore_priority If true, the 'q' parameter is ignored and the method returns true if 1
type $name Name of the asset (e.g. 'idno', 'jquery') 1
type $class Class of asset (e.g. 'javascript', 'css') 1
type $value A URL or other value 1
type $class 1
int $timestamp Unix timestamp. 1
type $timestamp Timestamp to check 1
type $regex_string URL string in the same format as the page handler definition. 1
User $owner 1
array $search 1
array|string $class Class(es) to search (blank for all) 1
string|url $identifier 1
string|array $class Class name(s) to check in (blank string, null or false for all) 1
int $offset Number of items to skip (default: 0) 1
array $readGroups Which ACL groups should we check? (default: everything the user can see) 1
bool $cached Retrieve a cached version if one exists. 1
string $title 1
string $status The status, default "published". Other values may be "draft" or "scheduled". 1
false $overrideAccess Set this to true to avoid checking write permissions before saving 1
$file_wrapper 1
$embeddable Will the file be embedded in a page? 1
type $id 1
mixed $access The ID of the access group or an AccessGroup object 1
string $description 1
string $body 1
int $total 1
string $media_url 1
string $service The name of the service 1
string $url The URL of the post 1
string $identifier A human-readable account identifier 1
string $item_id A Known-readable item identifier 1
string $account_id A Known-readable account identifier 1
array $other_properties (optional) additional properties to store with the link 1
bool $complete 1
boolean $idOnly Should we return the ID only? (Default: false) 1
array $array 1
$feed_view If set to true, draws a version of the entity suitable for including in a feed, eg 1
$prefix If set, adds a suffix to the template name. eg entity/Entry becomes entity/Entry/suffix. 1
$new If set to true, doesn't attempt to generate a URL from a presaved uuid 1
$arr An array of URL strings 1
bool $filter_urls If true (default), will remove URL parameters and anchors 1
string $source The source URL 1
string $target The target URL (i.e., the page on this site that was pinged) 1
array $source_response The Webservice response from fetching the source page 1
array $source_mf2 Parsed Microformats 2 content from $source 1
string $annotation_url Annotation URL to remove 1
array $item h-entry to interpret 1
array $author h-card for the author of $item 1
array $mentions 1
string $subtype Annotation subtype. 'comment' etc. 1
string $owner_name Name of the annotation's owner 1
string $owner_url Annotation owner's URL 1
string $owner_image Annotation owner's image, if one exists (include a blank string otherwise) 1
string $content Content of the annotation 1
string|null $annotation_url If included, the existing URL of this annotation 1
int $time The UNIX timestamp associated with this annotation (if set to 0, as is default, will be current time) 1
string $title The title associated with this annotation (blank by default) 1
array $extra_fields Any extra fields and values that should be stored on the annotation object 1
bool $send_notification Should this call trigger a notifiation? (Default: yes) 1
$subtype 1
bool $owner_url 1
array|string $annotation 1
string $subtype The type of annotation. eg, 'comment' 1
string $subtype Annotation type (eg 'comments') 1
$annotations_sub_array 1
$annotations_array 1
bool $local If set to true, only returns UUIDs of users who belong to this Known site 1
mixed $value 1
$_id 1
$bytes 1
AbstractAdapter $adapter 1
$key Key to retrieve 1
$key string Identifier for this value 1
$value mixed Value to store 1
The key 1
$where 1
$variables 1
$metadata_joins 1
$non_md_variables 1
string $clause Defaults to 'and' 1
array $mf2 1
array $out 1
array $hcards 1
string $stat The metric(s) to set. 1
float $time The elapsed time (ms) to log 1
string $stat The metric(s) to set. 1
string $stat The metric to set. 1
string $stat The metric to increment. 1
string $stat The metric to decrement. 1
string $counter 1
int $value 1
type $data 1
string $file_path Path to the file. 1
string $filename Filename that the file should have on download. 1
int $max_dimension The maximum number of pixels the thumbnail image should be along its longest side. 1
bool $square If this is set to true, the thumbnail will be made square. 1
string $file_path Full local path to the file 1
string $filename Filename to store 1
string $mime_type MIME type associated with the file 1
bool $return_object Return the file object? If set to false (as is default), will return the ID 1
bool $destroy_exif When true, if an image is uploaded the exif data will be destroyed. 1
string $file_path The path to a file 1
$file_name? Optionally, the file name 1
$attachment 1
string $url 1
bool $admin 1
string $permission The type of permission 1
string $permission Permission type 1
type $permission 1
type $restrict 1
\Idno\Entities\Notification $notification 1
\Idno\Common\Entity|null $object 1
type $user_id 1
mixed $access_group 1
type $search 1
type $fields 1
type $limit 1
type $offset 1
array $params 1
string $template 1
string $actor URL (or UUID if local) of the 1
string $verb 1
array|false $object 1
bool $user Optionally, a user to check for; otherwise checks current user 1
$from_email If set, sets a reply to 1
string $targetClass The class name and namespace 1
$author_name 1
$syndication 1
$Url 1
$pageId 1
$categories 1
$new_category 1
$force_refresh If set to true, never gets the cached version 1
array $account_strings flat list of syndication 1
array $account_data list of complex account data 1
int $statusCode HTTP status code 1
string $error Micropub error code 1
string $description Human-readable error description 1
string $type "photo", "audio" or "video" 1
string $url File URL 1
float $location 1
type $text 2
type $language 2
$account_string 2
string $targetURL The URL of the form action that brought us here. 2
boolean $haltExecutionOnBadRequest If set to true, the function halts all execution if the form doesn't validate. (True by default.) 2
string $pageurl URL of the page to point to 2
$token 2
$secret 2
$endpoint 2
$contents 2
type $fileuploadstring 2
string $pattern The pattern to match 2
string $message The text of the message 2
string $message_type This type of message; this will be added to the displayed message class, or returned as data 2
string $message_type 2
string $message 2
\Idno\Common\Page $page 2
$params 2
type $string 2
$plugin 2
string $plugin 2
string $event 2
callable $listener 2
int $priority 2
string $eventName The name of the event to trigger 2
array $data Data to pass to the event 2
mixed $default Default response (if not forwarding) 2
string $jobId the ID of the job returned from enqueue() 2
type $string String to translate 2
array $subs List of substitution variables to be used in the translated string 2
bool|true $failover 2
string $name Name of the input variable 2
mixed $default A default return value if no value specified (default: null) 2
boolean $filter Whether or not to filter the variable for safety (default: null), you can pass 2
type $name 2
type $path_root Url base, e.g. 'settings' 2
type $shell The shell, e.g. 'settings-shell' 2
bool $echo 2
$posse_links containing Entity::getPosseLinks() 2
int $count Number of items in total (across all pages) 2
int $items_per_page Number of items you're displaying per page 2
array $vars Additional template variables 2
bool $to_front If set, this will add the template to the beginning of the template queue 2
string $prependTemplateName 2
bool $to_front If set, this will add the template to the beginning of the template queue 2
$templateName 2
string $template The name of the template you wish to use 2
string $context 2
$context 2
string $level 2
$text 2
int $words 2
$objectType An activity streams object type ('article', 'note', 'photo', etc) 2
array $params Optional params 2
bool $convert_slashes If set to true, converts \ slashes to / (false by default) 2
$friendly_name 2
$type 2
int $code 2
int $offset Number of items to skip (default: 0 2
string $uuid 2
string $slug 2
int $max_chars The maximum number of characters in the slug (default: 255) 2
string $slug_extension a value to append on the end of the slug, in case of a prior duplicate 2
$words Number of words to limit to, if we're generating a short description on the fly (default: 25) 2
type $uuid 2
mixed $obj an array, scalar value, or null 2
type $content 2
float $value The value for the stats. 2
type $datatype 2
string $email 2
string $handle 2
string $permission 2
string $user_id The user UUID 2
$code 2
$time 2
$photo 2
$author_photo 2
$item 2
array $array 3
string $collection The collection to retrieve from (default: entities) 3
string $entities The collection name to retrieve from (default: 'entities') 3
array $fields An array of fieldnames to return (leave empty for all; default: all) 3
int $limit Maximum number of records to return (default: 10) 3
int $offset Number of records to skip (default: 0) 3
array $readGroups Which ACL groups should we check? (default: everything the user can see) 3
array $parameters Query parameters in MongoDB format 3
int $limit Maximum number of records to return 3
int $offset Number of records to skip 3
array $parameters 3
$query 3
$timestamp 3
$service 3
$value 3
$class 3
mixed $value 3
mixed $params Optionally, an array of parameters to send (keys are the parameter names), or the raw body text (depending on Content-Type) 3
array $params Optionally, an array of parameters to send (keys are the parameter names) 3
$html 3
$path 3
$user 3
bool $returnBlank Should we return a blank string if the template doesn't exist? (Defaults to true) 3
book $replacements Should we honor template replacements? (Defaults to true) 3
$shell Optional override of the page shell template to be used 3
$xml 3
string $variable_name 3
$slug 3
int $limit Number of items to return (default: 10) 3
$uuid 3
int $max_pieces The maximum number of words in the slug (default: 10) 3
$metadata 3
$options 3
string $path 3
type $counter 3
string $password 3
\Idno\Entities\User|string $user 3
string $user_id The user ID (optional) 3
\Idno\Entities\User $user 4
$content_type 4
string $handler The name of the Page class that will serve this route 4
bool $public If set to true, this page is always public, even on non-public sites 4
$name 4
string $extensionTemplateName 4
mixed $offset 4
$file_path 4
type $timer 4
$category 4
$id 5
bool $user 5
array $fields List of fields to return (default: all) 5
string $name 6
string|array $subtypes String or array of subtypes we're allowed to see 6
array $search Any extra search terms in array format (eg array('foo' => 'bar')) (default: empty) 6
string $collection Collection to query; default: entities 6
string $collection The collection to interrogate (default: 'entities') 6
string $user_id 6
array $headers Optionally, an array of headers to send with the request (keys are the header names) 6
$string 6
$content 7
array $search List of filter terms (default: none) 7
type $url 9
string $templateName 9
array $context 9
$email 10
$message 11
string $id 13
string $collection 13
$url 25
@return \Mongo 1
bool The previous value 1
id | false 1
\MongoId 1
bool|filesystem 1
string Contents of $collection stripped of invalid characters. 1
bool|int|string 1
int Offset in seconds 1
bool True on success 1
\CURLFile|string 1
WebserviceFile|false 1
true 1
\Idno\Entities\User|false The logged-in user, or false otherwise 1
\Idno\Core\EventDispatcher 1
\Idno\Core\EventQueue 1
\Idno\Files\FileSystem 1
\Idno\Core\Hub 1
\Idno\Core\Logging 1
\Idno\Caching\PersistentCache 1
\Idno\Stats\StatisticsCollector 1
\Idno\Core\PageHandler 1
\Idno\Core\Config|array 1
\Idno\Core\Syndication 1
\Idno\Core\Session 1
\Idno\Core\Plugins 1
\Idno\Core\Themes 1
\Idno\Core\Template 1
\Idno\Core\Language 1
\Idno\Core\Actions 1
\Idno\Core\Reader 1
CURLFile|false 1
bool|\Idno\Common\Plugin 1
string Purified HTML 1
array|false 1
bool|false|\Idno\Common\Entity|Feed 1
\Idno\Core\MentionClient 1
int The number of pings that were sent out 1
the parsed mf2 item, or false 1
array|false an h-card representing the author of this document 1
string title of the document or its url if no title is found 1
$icon_url 1
string an ID that can be used to query the job status 1
bytes 1
retacted token 1
string The built ini file 1
'ok','fail','warn' 1
mixed|bool 1
bool|false|MongoID|null 1
resource a file pointer resource on success, false on error 1
boolean true if messages at this level should be logged 1
\false|string 1
\Idno\Core\Bonita\Templates 1
array|string 1
URL 1
mixed Variable value or null on failure 1
\Bonita\Templates this template object 1
string|false Rendered template element or false, depending on $returnBlank 1
string Formatted content (or the input content if the processor doesn't exist) 1
string Name of the current template ('default' by default) 1
true|false Depending on success 1
string The site secret 1
string A string describing the device OS, or "default" by default 1
bool True if the session was handled 1
\DOMElement 1
$string 1
\Idno\Common\ContentType 1
string The public URL to the content type. 1
bool true if this page accepts webmentions 1
url|array 1
string|null 1
bool|User 1
\Idno\Common\Entity|false 1
DateTime::RFC3339 1
bool: True if this object is in your ACLS, false if not (and by deduction, you're seeing this because you're an admin) 1
string | false 1
bool|null 1
AccessGroup | string 1
array|mixed 1
bool Success 1
array the modified mentions array 1
bool Depending on success 1
AbstractAdapter 1
MongoID | false 1
\MongoDB\BSON\ObjectID 1
bool|\MongoGridFS 1
int | false 1
bool|id 1
bool|\id Depending on success 1
bool|\Idno\Common\Entity 1
bool|mixed|string 1
true|false True or false depending on success 1
User|false 1
string The new recovery code, suitable for sending in an email 1
integer 1
bool|\Idno\Common\false|\Idno\Common\true|\Idno\Core\false|\Idno\Core\MongoID|null 1
true if the notification key represents a 1
\Idno\Entities\Invitation|false 1
bool|int 1
bool|false|Entity|Feed 1
$this|bool|false|Entity 1
'bookmark' 1
false|\Idno\Common\Entity 1
\Idno\Entities\User user on success 1
void 1
Status|Reply 1
float 1
'image' 1
'media' 1
WebInstaller 1
\Idno\Core\Idno $site 2
\Idno\Core\DataConcierge 2
string|bool 2
bool|ContentType 2
\Idno\Common\Entity 2
\Idno\Common\Entity|null 2
Entity|false 2
Entity 2
unix timestamp 2
false|\Idno\Core\id 2
null|string 2
string The rendered entity. 2
mixed|void 2
mixed|resource 2
string; 2
\PDO 2
string|false 2
\Idno\Common\Entity|\MongoGridFSFile|null 2
object 2
User|false Depending on success 2
array|null 2
'note' 2
\Idno\Common\Entity | false 3
array|false Array of elements or false, depending on success 3
iterator|false Iterator or false, depending on success 3
bool|\Idno\Common\Page 3
boolean|string 3
false|string 3
id of file 3
'article' 3
\Idno\Core\Bonita\false|string 4
bool|Entity 4
bool|mixed 5
\Idno\Entities\User 6
mixed|string 6
null 8
array|bool 12
bool|string 14
boolean 14
type 15
int 20
true|false 32
mixed 52
bool 72
array 87
string 120
@returns array An associative array of various icons => url 1
@see ToroHook 1
Idno\Core\Session::isLoggedIn() 1
http://php.net/manual/en/features.file-upload.errors.php 1
https://techblog.bozho.net/gdpr-practical-guide-developers/ 1
@throws \Exception if the session is invalid. 1
\Exception If cryptographic functions are not strong enough. 1
\Idno\Exceptions\ConfigurationException 2
\RuntimeException 7
@todo Handle includeSubDomains 1
Further sanitization tasks 1
Necessary? 1
Handle nginx & Apache 2.4? 1
replace this with xpath. 1
complete this 1
@user links into active users. 1
@var type 3