Skip to content
GitLab
Menu
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
die_coolen_jungs
our_own_cloud_project
Commits
b5bc37d2
Commit
b5bc37d2
authored
May 11, 2014
by
Robin McCorkell
Browse files
Fix @return array PHPDocs, in /lib
parent
b653ad16
Changes
38
Hide whitespace changes
Inline
Side-by-side
lib/private/app.php
View file @
b5bc37d2
...
...
@@ -307,7 +307,7 @@ class OC_App{
/**
* @brief Get the navigation entries for the $app
* @param string $app app
* @return array of the $data added with addNavigationEntry
* @return array
an array
of the $data added with addNavigationEntry
*
* Warning: destroys the existing entries
*/
...
...
@@ -660,7 +660,7 @@ class OC_App{
/**
* @brief: get a list of all apps in the apps folder
* @return array
or
app names (string IDs)
* @return array
an array of
app names (string IDs)
* @todo: change the name of this method to getInstalledApps, which is more accurate
*/
public
static
function
getAllApps
()
{
...
...
lib/private/appconfig.php
View file @
b5bc37d2
...
...
@@ -90,7 +90,7 @@ class AppConfig implements \OCP\IAppConfig {
/**
* @brief Get all apps using the config
* @return array
with
app ids
* @return array
an array of
app ids
*
* This function returns a list of all apps that have at least one
* entry in the appconfig table.
...
...
@@ -109,7 +109,7 @@ class AppConfig implements \OCP\IAppConfig {
/**
* @brief Get the available keys for an app
* @param string $app the app we are looking for
* @return array
with
key names
* @return array
an array of
key names
*
* This function gets all keys of an app. Please note that the values are
* not returned.
...
...
lib/private/config.php
View file @
b5bc37d2
...
...
@@ -65,7 +65,7 @@ class Config {
/**
* @brief Lists all available config keys
* @return array
with
key names
* @return array
an array of
key names
*
* This function returns all keys saved in config.php. Please note that it
* does not return the values.
...
...
lib/private/contactsmanager.php
View file @
b5bc37d2
...
...
@@ -31,7 +31,7 @@ namespace OC {
* @param string $pattern which should match within the $searchProperties
* @param array $searchProperties defines the properties within the query pattern should match
* @param array $options - for future use. One should always have options!
* @return array of contacts which are arrays of key-value-pairs
* @return array
an array
of contacts which are arrays of key-value-pairs
*/
public
function
search
(
$pattern
,
$searchProperties
=
array
(),
$options
=
array
())
{
$result
=
array
();
...
...
@@ -72,7 +72,7 @@ namespace OC {
*
* @param array $properties this array if key-value-pairs defines a contact
* @param string $address_book_key identifier of the address book in which the contact shall be created or updated
* @return array representing the contact just created or updated
* @return array
an array
representing the contact just created or updated
*/
public
function
createOrUpdate
(
$properties
,
$address_book_key
)
{
...
...
lib/private/files/cache/cache.php
View file @
b5bc37d2
...
...
@@ -450,7 +450,7 @@ class Cache {
* search for files matching $pattern
*
* @param string $pattern
* @return array of file data
* @return array
an array
of file data
*/
public
function
search
(
$pattern
)
{
...
...
lib/private/files/cache/scanner.php
View file @
b5bc37d2
...
...
@@ -61,7 +61,7 @@ class Scanner extends BasicEmitter {
* *
*
* @param string $path
* @return array
with
metadata of the file
* @return array
an array of
metadata of the file
*/
public
function
getData
(
$path
)
{
if
(
!
$this
->
storage
->
isReadable
(
$path
))
{
...
...
@@ -88,7 +88,7 @@ class Scanner extends BasicEmitter {
* @param string $file
* @param int $reuseExisting
* @param bool $parentExistsInCache
* @return array
with
metadata of the scanned file
* @return array
an array of
metadata of the scanned file
*/
public
function
scanFile
(
$file
,
$reuseExisting
=
0
,
$parentExistsInCache
=
false
)
{
if
(
!
self
::
isPartialFile
(
$file
)
...
...
@@ -174,7 +174,7 @@ class Scanner extends BasicEmitter {
* @param string $path
* @param bool $recursive
* @param int $reuse
* @return array
with
the meta data of the scanned file or folder
* @return array
an array of
the meta data of the scanned file or folder
*/
public
function
scan
(
$path
,
$recursive
=
self
::
SCAN_RECURSIVE
,
$reuse
=
-
1
)
{
if
(
$reuse
===
-
1
)
{
...
...
lib/private/files/cache/updater.php
View file @
b5bc37d2
...
...
@@ -17,7 +17,7 @@ class Updater {
* resolve a path to a storage and internal path
*
* @param string $path the relative path
* @return array consisting of the storage and the internal path
* @return array
an array
consisting of the storage and the internal path
*/
static
public
function
resolvePath
(
$path
)
{
$view
=
\
OC\Files\Filesystem
::
getView
();
...
...
lib/private/files/filesystem.php
View file @
b5bc37d2
...
...
@@ -270,7 +270,7 @@ class Filesystem {
* resolve a path to a storage and internal path
*
* @param string $path
* @return array consisting of the storage and the internal path
* @return array
an array
consisting of the storage and the internal path
*/
static
public
function
resolvePath
(
$path
)
{
if
(
!
self
::
$mounts
)
{
...
...
lib/private/files/view.php
View file @
b5bc37d2
...
...
@@ -109,7 +109,7 @@ class View {
* resolve a path to a storage and internal path
*
* @param string $path
* @return array consisting of the storage and the internal path
* @return array
an array
consisting of the storage and the internal path
*/
public
function
resolvePath
(
$path
)
{
$a
=
$this
->
getAbsolutePath
(
$path
);
...
...
lib/private/group.php
View file @
b5bc37d2
...
...
@@ -179,7 +179,7 @@ class OC_Group {
/**
* @brief Get all groups a user belongs to
* @param string $uid Name of the user
* @return array
with
group names
* @return array
an array of
group names
*
* This function fetches all groups a user belongs to. It does not check
* if the user exists at all.
...
...
@@ -203,7 +203,7 @@ class OC_Group {
* @param string $search
* @param int|null $limit
* @param int|null $offset
* @return array
with
group names
* @return array
an array of
group names
*
* Returns a list with all groups
*/
...
...
@@ -232,7 +232,7 @@ class OC_Group {
* @param string $search
* @param int $limit
* @param int $offset
* @return array
with
user ids
* @return array
an array of
user ids
*/
public
static
function
usersInGroup
(
$gid
,
$search
=
''
,
$limit
=
-
1
,
$offset
=
0
)
{
$group
=
self
::
getManager
()
->
get
(
$gid
);
...
...
@@ -254,7 +254,7 @@ class OC_Group {
* @param string $search
* @param int $limit
* @param int $offset
* @return array
with
user ids
* @return array
an array of
user ids
*/
public
static
function
usersInGroups
(
$gids
,
$search
=
''
,
$limit
=
-
1
,
$offset
=
0
)
{
$users
=
array
();
...
...
@@ -271,7 +271,7 @@ class OC_Group {
* @param string $search
* @param int $limit
* @param int $offset
* @return array
with
display names (value) and user ids(key)
* @return array
an array of
display names (value) and user ids(key)
*/
public
static
function
displayNamesInGroup
(
$gid
,
$search
=
''
,
$limit
=
-
1
,
$offset
=
0
)
{
return
self
::
getManager
()
->
displayNamesInGroup
(
$gid
,
$search
,
$limit
,
$offset
);
...
...
@@ -283,7 +283,7 @@ class OC_Group {
* @param string $search
* @param int $limit
* @param int $offset
* @return array
with
display names (Key) user ids (value)
* @return array
an array of
display names (Key) user ids (value)
*/
public
static
function
displayNamesInGroups
(
$gids
,
$search
=
''
,
$limit
=
-
1
,
$offset
=
0
)
{
$displayNames
=
array
();
...
...
lib/private/group/backend.php
View file @
b5bc37d2
...
...
@@ -93,7 +93,7 @@ abstract class OC_Group_Backend implements OC_Group_Interface {
/**
* @brief Get all groups a user belongs to
* @param string $uid Name of the user
* @return array
with
group names
* @return array
an array of
group names
*
* This function fetches all groups a user belongs to. It does not check
* if the user exists at all.
...
...
@@ -107,7 +107,7 @@ abstract class OC_Group_Backend implements OC_Group_Interface {
* @param string $search
* @param int $limit
* @param int $offset
* @return array
with
group names
* @return array
an array of
group names
*
* Returns a list with all groups
*/
...
...
@@ -131,7 +131,7 @@ abstract class OC_Group_Backend implements OC_Group_Interface {
* @param string $search
* @param int $limit
* @param int $offset
* @return array
with
user ids
* @return array
an array of
user ids
*/
public
function
usersInGroup
(
$gid
,
$search
=
''
,
$limit
=
-
1
,
$offset
=
0
)
{
return
array
();
...
...
lib/private/group/database.php
View file @
b5bc37d2
...
...
@@ -140,7 +140,7 @@ class OC_Group_Database extends OC_Group_Backend {
/**
* @brief Get all groups a user belongs to
* @param string $uid Name of the user
* @return array
with
group names
* @return array
an array of
group names
*
* This function fetches all groups a user belongs to. It does not check
* if the user exists at all.
...
...
@@ -163,7 +163,7 @@ class OC_Group_Database extends OC_Group_Backend {
* @param string $search
* @param int $limit
* @param int $offset
* @return array
with
group names
* @return array
an array of
group names
*
* Returns a list with all groups
*/
...
...
@@ -197,7 +197,7 @@ class OC_Group_Database extends OC_Group_Backend {
* @param string $search
* @param int $limit
* @param int $offset
* @return array
with
user ids
* @return array
an array of
user ids
*/
public
function
usersInGroup
(
$gid
,
$search
=
''
,
$limit
=
null
,
$offset
=
null
)
{
$stmt
=
OC_DB
::
prepare
(
'SELECT `uid` FROM `*PREFIX*group_user` WHERE `gid` = ? AND `uid` LIKE ?'
,
...
...
lib/private/group/dummy.php
View file @
b5bc37d2
...
...
@@ -119,7 +119,7 @@ class OC_Group_Dummy extends OC_Group_Backend {
/**
* @brief Get all groups a user belongs to
* @param $uid Name of the user
* @return array
with
group names
* @return array
an array of
group names
*
* This function fetches all groups a user belongs to. It does not check
* if the user exists at all.
...
...
@@ -137,7 +137,7 @@ class OC_Group_Dummy extends OC_Group_Backend {
/**
* @brief get a list of all groups
* @return array
with
group names
* @return array
an array of
group names
*
* Returns a list with all groups
*/
...
...
@@ -147,7 +147,7 @@ class OC_Group_Dummy extends OC_Group_Backend {
/**
* @brief get a list of all users in a group
* @return array
with
user ids
* @return array
an array of
user ids
*/
public
function
usersInGroup
(
$gid
,
$search
=
''
,
$limit
=
-
1
,
$offset
=
0
)
{
if
(
isset
(
$this
->
groups
[
$gid
]))
{
...
...
lib/private/group/example.php
View file @
b5bc37d2
...
...
@@ -78,7 +78,7 @@ abstract class OC_Group_Example {
/**
* @brief Get all groups a user belongs to
* @param $uid Name of the user
* @return array
with
group names
* @return array
an array of
group names
*
* This function fetches all groups a user belongs to. It does not check
* if the user exists at all.
...
...
@@ -87,7 +87,7 @@ abstract class OC_Group_Example {
/**
* @brief get a list of all groups
* @return array
with
group names
* @return array
an array of
group names
*
* Returns a list with all groups
*/
...
...
@@ -102,7 +102,7 @@ abstract class OC_Group_Example {
/**
* @brief get a list of all users in a group
* @return array
with
user ids
* @return array
an array of
user ids
*/
abstract
public
static
function
usersInGroup
(
$gid
,
$search
=
''
,
$limit
=
-
1
,
$offset
=
0
);
...
...
lib/private/group/interface.php
View file @
b5bc37d2
...
...
@@ -45,7 +45,7 @@ interface OC_Group_Interface {
/**
* @brief Get all groups a user belongs to
* @param string $uid Name of the user
* @return array
with
group names
* @return array
an array of
group names
*
* This function fetches all groups a user belongs to. It does not check
* if the user exists at all.
...
...
@@ -57,7 +57,7 @@ interface OC_Group_Interface {
* @param string $search
* @param int $limit
* @param int $offset
* @return array
with
group names
* @return array
an array of
group names
*
* Returns a list with all groups
*/
...
...
@@ -76,7 +76,7 @@ interface OC_Group_Interface {
* @param string $search
* @param int $limit
* @param int $offset
* @return array
with
user ids
* @return array
an array of
user ids
*/
public
function
usersInGroup
(
$gid
,
$search
=
''
,
$limit
=
-
1
,
$offset
=
0
);
...
...
lib/private/group/manager.php
View file @
b5bc37d2
...
...
@@ -165,7 +165,7 @@ class Manager extends PublicEmitter {
* @param string $search
* @param int $limit
* @param int $offset
* @return array
with
display names (value) and user ids (key)
* @return array
an array of
display names (value) and user ids (key)
*/
public
function
displayNamesInGroup
(
$gid
,
$search
=
''
,
$limit
=
-
1
,
$offset
=
0
)
{
$group
=
$this
->
get
(
$gid
);
...
...
lib/private/legacy/appconfig.php
View file @
b5bc37d2
...
...
@@ -35,7 +35,7 @@ class OC_Appconfig {
/**
* @brief Get all apps using the config
* @return array
with
app ids
* @return array
an array of
app ids
*
* This function returns a list of all apps that have at least one
* entry in the appconfig table.
...
...
@@ -47,7 +47,7 @@ class OC_Appconfig {
/**
* @brief Get the available keys for an app
* @param string $app the app we are looking for
* @return array
with
key names
* @return array
an array of
key names
*
* This function gets all keys of an app. Please note that the values are
* not returned.
...
...
lib/private/legacy/config.php
View file @
b5bc37d2
...
...
@@ -51,7 +51,7 @@ class OC_Config {
/**
* @brief Lists all available config keys
* @return array
with
key names
* @return array
an array of
key names
*
* This function returns all keys saved in config.php. Please note that it
* does not return the values.
...
...
lib/private/legacy/preferences.php
View file @
b5bc37d2
...
...
@@ -29,7 +29,7 @@ class OC_Preferences{
public
static
$object
;
/**
* @brief Get all users using the preferences
* @return array
with
user ids
* @return array
an array of
user ids
*
* This function returns a list of all users that have at least one entry
* in the preferences table.
...
...
@@ -54,7 +54,7 @@ class OC_Preferences{
* @brief Get the available keys for an app
* @param string $user user
* @param string $app the app we are looking for
* @return array
with
key names
* @return array
an array of
key names
*
* This function gets all keys of an app of an user. Please note that the
* values are not returned.
...
...
lib/private/migrate.php
View file @
b5bc37d2
...
...
@@ -538,7 +538,7 @@ class OC_Migrate{
* @param string $db string path to migration.db
* @param $info object of migration info
* @param string|null|int $uid uid to use
* @return array of apps with import statuses, or false on failure.
* @return array
an array
of apps with import statuses, or false on failure.
*/
public
static
function
importAppData
(
$db
,
$info
,
$uid
=
null
)
{
// Check if the db exists
...
...
Prev
1
2
Next
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment