Add doc comments listing the array parameters for User::register() and Notice::saveNew()
This commit is contained in:
@@ -175,6 +175,35 @@ class Notice extends Memcached_DataObject
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Save a new notice and push it out to subscribers' inboxes.
|
||||
* Poster's permissions are checked before sending.
|
||||
*
|
||||
* @param int $profile_id Profile ID of the poster
|
||||
* @param string $content source message text; links may be shortened
|
||||
* per current user's preference
|
||||
* @param string $source source key ('web', 'api', etc)
|
||||
* @param array $options Associative array of optional properties:
|
||||
* string 'created' timestamp of notice; defaults to now
|
||||
* int 'is_local' source/gateway ID, one of:
|
||||
* Notice::LOCAL_PUBLIC - Local, ok to appear in public timeline
|
||||
* Notice::REMOTE_OMB - Sent from a remote OMB service;
|
||||
* hide from public timeline but show in
|
||||
* local "and friends" timelines
|
||||
* Notice::LOCAL_NONPUBLIC - Local, but hide from public timeline
|
||||
* Notice::GATEWAY - From another non-OMB service;
|
||||
* will not appear in public views
|
||||
* float 'lat' decimal latitude for geolocation
|
||||
* float 'lon' decimal longitude for geolocation
|
||||
* int 'location_id' geoname identifier
|
||||
* int 'location_ns' geoname namespace to interpret location_id
|
||||
* int 'reply_to'; notice ID this is a reply to
|
||||
* int 'repeat_of'; notice ID this is a repeat of
|
||||
* string 'uri' permalink to notice; defaults to local notice URL
|
||||
*
|
||||
* @return Notice
|
||||
* @throws ClientException
|
||||
*/
|
||||
static function saveNew($profile_id, $content, $source, $options=null) {
|
||||
$defaults = array('uri' => null,
|
||||
'reply_to' => null,
|
||||
|
||||
Reference in New Issue
Block a user