+++ /dev/null
-<?php\r
-/**\r
- * Linking to element documentation is performed by the classes in this file.\r
- *\r
- * abstractLink descendants contain enough information to differentiate every\r
- * documentable element, and so can be converted to a link string by\r
- * {@link Converter::returnSee()}\r
- * \r
- * phpDocumentor :: automatic documentation generator\r
- * \r
- * PHP versions 4 and 5\r
- *\r
- * Copyright (c) 2002-2006 Gregory Beaver\r
- * \r
- * LICENSE:\r
- * \r
- * This library is free software; you can redistribute it\r
- * and/or modify it under the terms of the GNU Lesser General\r
- * Public License as published by the Free Software Foundation;\r
- * either version 2.1 of the License, or (at your option) any\r
- * later version.\r
- * \r
- * This library is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\r
- * Lesser General Public License for more details.\r
- * \r
- * You should have received a copy of the GNU Lesser General Public\r
- * License along with this library; if not, write to the Free Software\r
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA\r
- *\r
- * @package phpDocumentor\r
- * @subpackage Links\r
- * @author Gregory Beaver <cellog@php.net>\r
- * @copyright 2002-2006 Gregory Beaver\r
- * @license http://www.opensource.org/licenses/lgpl-license.php LGPL\r
- * @version CVS: $Id: LinkClasses.inc,v 1.3 2006/04/30 22:18:13 cellog Exp $\r
- * @filesource\r
- * @link http://www.phpdoc.org\r
- * @link http://pear.php.net/PhpDocumentor\r
- * @since 1.2.0\r
- */\r
-\r
-/**\r
- * linking classes parent\r
- * @package phpDocumentor\r
- * @subpackage Links\r
- */\r
-class abstractLink\r
-{\r
- /**#@+ @var string */\r
- var $path;\r
- /**\r
- * phpdoc alias _phpdoc_inc for phpdoc.inc\r
- */\r
- var $fileAlias = '';\r
- /**\r
- * element type linked to.\r
- * can only be a documentable element\r
- */\r
- var $type = '';\r
- var $name = '';\r
- var $category = '';\r
- var $package = '';\r
- var $subpackage = '';\r
- /**#@-*/\r
-\r
- /**\r
- * @param string full path to file containing element\r
- * @param string page name, as configured by {@link Parser::parse}\r
- * @param string element name\r
- * @param string package element is in\r
- * @param string subpackage element is in\r
- * @param string optional category that documentation is in\r
- */\r
- function addLink($path, $fileAlias, $name, $package, $subpackage, $category = false)\r
- {\r
- $this->path = $path;\r
- $this->fileAlias = $fileAlias;\r
- $this->name = $name;\r
- $this->category = $category;\r
- $this->package = $package;\r
- $this->subpackage = $subpackage;\r
- }\r
-}\r
-\r
-/**\r
- * procedural page link\r
- * @package phpDocumentor\r
- * @subpackage Links\r
- */\r
-class pageLink extends abstractLink\r
-{\r
- /** @var string */\r
- var $type = 'page';\r
-}\r
-\r
-/**\r
- * function link\r
- * @package phpDocumentor\r
- * @subpackage Links\r
- */\r
-class functionLink extends abstractLink\r
-{\r
- /** @var string */\r
- var $type = 'function';\r
-}\r
-\r
-/**\r
- * define link\r
- * @package phpDocumentor\r
- * @subpackage Links\r
- */\r
-class defineLink extends abstractLink\r
-{\r
- /** @var string */\r
- var $type = 'define';\r
-}\r
-\r
-/**\r
- * global variable link\r
- * @package phpDocumentor\r
- * @subpackage Links\r
- */\r
-class globalLink extends abstractLink\r
-{\r
- /** @var string */\r
- var $type = 'global';\r
-}\r
-\r
-/**\r
- * class link\r
- * @package phpDocumentor\r
- * @subpackage Links\r
- */\r
-class classLink extends abstractLink\r
-{\r
- /** @var string */\r
- var $type = 'class';\r
-}\r
-\r
-/**\r
- * method link\r
- * @package phpDocumentor\r
- * @subpackage Links\r
- */\r
-class methodLink extends abstractLink\r
-{\r
- /** @var string */\r
- var $type = 'method';\r
- /** @var string */\r
- var $class = '';\r
- \r
- /**\r
- * @param string class name\r
- * @param string full path to file containing element\r
- * @param string page name, as configured by {@link Parser::parse}\r
- * @param string element name\r
- * @param string package element is in\r
- * @param string subpackage element is in\r
- */\r
- function addLink($class, $path ,$fileAlias,$name,$package,$subpackage, $category = false)\r
- {\r
- $this->class = $class;\r
- abstractLink::addLink($path, $fileAlias,$name,$package,$subpackage, $category);\r
- }\r
-}\r
-\r
-/**\r
- * class variable link\r
- * @package phpDocumentor\r
- * @subpackage Links\r
- */\r
-class varLink extends methodLink\r
-{\r
- /** @var string */\r
- var $type = 'var';\r
-}\r
-\r
-/**\r
- * class constant link\r
- * @package phpDocumentor\r
- * @subpackage Links\r
- */\r
-class constLink extends methodLink\r
-{\r
- /** @var string */\r
- var $type = 'const';\r
-}\r
-\r
-/**\r
- * tutorial link\r
- * @package phpDocumentor\r
- * @subpackage Links\r
- */\r
-class tutorialLink extends abstractLink\r
-{\r
- /**#@+ @var string */\r
- var $type = 'tutorial';\r
- var $section = '';\r
- var $title = false;\r
- /**#@-*/\r
- \r
- /**\r
- * @param string section/subsection name\r
- * @param string full path to file containing element\r
- * @param string page name, as configured by {@link Parser::parse}\r
- * @param string element name\r
- * @param string package element is in\r
- * @param string subpackage element is in\r
- * @param string title of tutorial\r
- */\r
- function addLink($section,$path,$name,$package,$subpackage,$title = false, $category = false)\r
- {\r
- $this->section = $section;\r
- $this->title = $title;\r
- parent::addLink($path,'',$name,$package,$subpackage, $category);\r
- }\r
-}\r
-?>
\ No newline at end of file
projects / atutor.git / blobdiff