Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add @link to App docblocks and missing _packageFormat docblock

  • Loading branch information...
commit dba4d21492edcee165249c032acb403829b2b97b 1 parent 9347ca2
@shama shama authored
Showing with 14 additions and 0 deletions.
  1. +14 −0 lib/Cake/Core/App.php
View
14 lib/Cake/Core/App.php
@@ -205,6 +205,7 @@ class App {
* @param string $type type of path
* @param string $plugin name of plugin
* @return string array
+ * @link http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#App::path
*/
public static function path($type, $plugin = null) {
if (!empty(self::$legacy[$type])) {
@@ -236,6 +237,7 @@ public static function path($type, $plugin = null) {
* use App::path()
*
* @return array An array of packages and their associated paths.
+ * @link http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#App::paths
*/
public static function paths() {
return self::$_packages;
@@ -259,6 +261,7 @@ public static function paths() {
* @param array $paths associative array with package names as keys and a list of directories for new search paths
* @param mixed $mode App::RESET will set paths, App::APPEND with append paths, App::PREPEND will prepend paths, [default] App::PREPEND
* @return void
+ * @link http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#App::build
*/
public static function build($paths = array(), $mode = App::PREPEND) {
//Provides Backwards compatibility for old-style package names
@@ -323,6 +326,7 @@ public static function build($paths = array(), $mode = App::PREPEND) {
*
* @param string $plugin CamelCased/lower_cased plugin name to find the path of.
* @return string full path to the plugin.
+ * @link http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#App::pluginPath
*/
public static function pluginPath($plugin) {
return CakePlugin::path($plugin);
@@ -337,6 +341,7 @@ public static function pluginPath($plugin) {
*
* @param string $theme theme name to find the path of.
* @return string full path to the theme.
+ * @link http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#App::themePath
*/
public static function themePath($theme) {
$themeDir = 'Themed' . DS . Inflector::camelize($theme);
@@ -357,6 +362,7 @@ public static function themePath($theme) {
*
* @param string $type
* @return string full path to package
+ * @link http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#App::core
*/
public static function core($type) {
return array(CAKE . str_replace('/', DS, $type) . DS);
@@ -383,6 +389,7 @@ public static function core($type) {
* @param mixed $path Optional Scan only the path given. If null, paths for the chosen type will be used.
* @param boolean $cache Set to false to rescan objects of the chosen type. Defaults to true.
* @return mixed Either false on incorrect / miss. Or an array of found objects.
+ * @link http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#App::objects
*/
public static function objects($type, $path = null, $cache = true) {
$extension = '/\.php$/';
@@ -474,6 +481,7 @@ public static function objects($type, $path = null, $cache = true) {
* @param string $className the name of the class to configure package for
* @param string $location the package name
* @return void
+ * @link http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#App::uses
*/
public static function uses($className, $location) {
self::$_classMap[$className] = $location;
@@ -540,6 +548,7 @@ public static function load($className) {
*
* @param string $className name of the class to obtain the package name from
* @return string package name or null if not declared
+ * @link http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#App::location
*/
public static function location($className) {
if (!empty(self::$_classMap[$className])) {
@@ -781,6 +790,11 @@ protected static function _mapped($name, $plugin = null) {
return false;
}
+/**
+ * Sets then returns the templates for each customizable package path
+ *
+ * @return array templates for each customizable package path
+ */
protected static function _packageFormat() {
if (empty(self::$_packageFormat)) {
self::$_packageFormat = array(
Please sign in to comment.
Something went wrong with that request. Please try again.