Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
O
our_own_cloud_project
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Model registry
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
die_coolen_jungs
our_own_cloud_project
Commits
c692dfc1
Commit
c692dfc1
authored
12 years ago
by
Georg Ehrke
Browse files
Options
Downloads
Patches
Plain Diff
style fixes for public app api
parent
d5d2e896
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
lib/public/app.php
+105
-116
105 additions, 116 deletions
lib/public/app.php
with
105 additions
and
116 deletions
lib/public/app.php
+
105
−
116
View file @
c692dfc1
...
...
@@ -34,120 +34,109 @@ namespace OCP;
* This class provides functions to manage apps in ownCloud
*/
class
App
{
/**
* @brief Makes owncloud aware of this app
* @brief This call is deprecated and not necessary to use.
* @param $data array with all information
* @returns true/false
*
* @deprecated this method is deprecated
* Do not call it anymore
* It'll remain in our public API for compatibility reasons
*
*/
public
static
function
register
(
$data
)
{
return
true
;
// don't do anything
}
/**
* @brief adds an entry to the navigation
* @param $data array containing the data
* @returns true/false
*
* This function adds a new entry to the navigation visible to users. $data
* is an associative array.
* The following keys are required:
* - id: unique id for this entry ('addressbook_index')
* - href: link to the page
* - name: Human readable name ('Addressbook')
*
* The following keys are optional:
* - icon: path to the icon of the app
* - order: integer, that influences the position of your application in
* the navigation. Lower values come first.
*/
public
static
function
addNavigationEntry
(
$data
)
{
return
\OC_App
::
addNavigationEntry
(
$data
);
}
/**
* @brief marks a navigation entry as active
* @param $id id of the entry
* @returns true/false
*
* This function sets a navigation entry as active and removes the 'active'
* property from all other entries. The templates can use this for
* highlighting the current position of the user.
*/
public
static
function
setActiveNavigationEntry
(
$id
)
{
return
\OC_App
::
setActiveNavigationEntry
(
$id
);
}
/**
* @brief Register a Configuration Screen that should appear in the personal settings section.
* @param $app string appid
* @param $page string page to be included
*/
public
static
function
registerPersonal
(
$app
,
$page
)
{
return
\OC_App
::
registerPersonal
(
$app
,
$page
);
}
/**
* @brief Register a Configuration Screen that should appear in the Admin section.
* @param $app string appid
* @param $page string page to be included
*/
public
static
function
registerAdmin
(
$app
,
$page
)
{
return
\OC_App
::
registerAdmin
(
$app
,
$page
);
}
/**
* @brief Read app metadata from the info.xml file
* @param string $app id of the app or the path of the info.xml file
* @param boolean path (optional)
* @returns array
*/
public
static
function
getAppInfo
(
$app
,
$path
=
false
)
{
return
\OC_App
::
getAppInfo
(
$app
,
$path
);
}
/**
* @brief checks whether or not an app is enabled
* @param $app app
* @returns true/false
*
* This function checks whether or not an app is enabled.
*/
public
static
function
isEnabled
(
$app
)
{
return
\OC_App
::
isEnabled
(
$app
);
}
/**
* @brief Check if the app is enabled, redirects to home if not
* @param $app app
* @returns true/false
*/
public
static
function
checkAppEnabled
(
$app
)
{
return
\OC_Util
::
checkAppEnabled
(
$app
);
}
/**
* @brief Get the last version of the app, either from appinfo/version or from appinfo/info.xml
* @param $app app
* @returns true/false
*/
public
static
function
getAppVersion
(
$app
)
{
return
\OC_App
::
getAppVersion
(
$app
);
}
/**
* @brief Makes owncloud aware of this app
* @brief This call is deprecated and not necessary to use.
* @param $data array with all information
* @returns true/false
*
* @deprecated this method is deprecated
* Do not call it anymore
* It'll remain in our public API for compatibility reasons
*
*/
public
static
function
register
(
$data
)
{
return
true
;
// don't do anything
}
/**
* @brief adds an entry to the navigation
* @param $data array containing the data
* @returns true/false
*
* This function adds a new entry to the navigation visible to users. $data
* is an associative array.
* The following keys are required:
* - id: unique id for this entry ('addressbook_index')
* - href: link to the page
* - name: Human readable name ('Addressbook')
*
* The following keys are optional:
* - icon: path to the icon of the app
* - order: integer, that influences the position of your application in
* the navigation. Lower values come first.
*/
public
static
function
addNavigationEntry
(
$data
)
{
return
\OC_App
::
addNavigationEntry
(
$data
);
}
/**
* @brief marks a navigation entry as active
* @param $id id of the entry
* @returns true/false
*
* This function sets a navigation entry as active and removes the 'active'
* property from all other entries. The templates can use this for
* highlighting the current position of the user.
*/
public
static
function
setActiveNavigationEntry
(
$id
)
{
return
\OC_App
::
setActiveNavigationEntry
(
$id
);
}
/**
* @brief Register a Configuration Screen that should appear in the personal settings section.
* @param $app string appid
* @param $page string page to be included
*/
public
static
function
registerPersonal
(
$app
,
$page
)
{
return
\OC_App
::
registerPersonal
(
$app
,
$page
);
}
/**
* @brief Register a Configuration Screen that should appear in the Admin section.
* @param $app string appid
* @param $page string page to be included
*/
public
static
function
registerAdmin
(
$app
,
$page
)
{
return
\OC_App
::
registerAdmin
(
$app
,
$page
);
}
/**
* @brief Read app metadata from the info.xml file
* @param string $app id of the app or the path of the info.xml file
* @param boolean path (optional)
* @returns array
*/
public
static
function
getAppInfo
(
$app
,
$path
=
false
)
{
return
\OC_App
::
getAppInfo
(
$app
,
$path
);
}
/**
* @brief checks whether or not an app is enabled
* @param $app app
* @returns true/false
*
* This function checks whether or not an app is enabled.
*/
public
static
function
isEnabled
(
$app
)
{
return
\OC_App
::
isEnabled
(
$app
);
}
/**
* @brief Check if the app is enabled, redirects to home if not
* @param $app app
* @returns true/false
*/
public
static
function
checkAppEnabled
(
$app
)
{
return
\OC_Util
::
checkAppEnabled
(
$app
);
}
/**
* @brief Get the last version of the app, either from appinfo/version or from appinfo/info.xml
* @param $app app
* @returns true/false
*/
public
static
function
getAppVersion
(
$app
)
{
return
\OC_App
::
getAppVersion
(
$app
);
}
}
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment