8 | {% for item in node.items %} 9 |8 | -------------------------------------------------------------------------------- /incubator/guides/src/NodeRenderers/FullDocumentNodeRenderer.php: -------------------------------------------------------------------------------- 1 | name = $name; 23 | } 24 | 25 | public function getName(): string 26 | { 27 | return $this->name; 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /src/phpDocumentor/Descriptor/Interfaces/TracksErrors.php: -------------------------------------------------------------------------------- 1 | 23 | */ 24 | public function getErrors(): Collection; 25 | } 26 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: docker 4 | directory: "/" 5 | schedule: 6 | interval: weekly 7 | open-pull-requests-limit: 10 8 | - package-ecosystem: npm 9 | directory: "/" 10 | schedule: 11 | interval: weekly 12 | open-pull-requests-limit: 10 13 | - package-ecosystem: composer 14 | directory: "/" 15 | schedule: 16 | interval: weekly 17 | open-pull-requests-limit: 10 18 | ignore: 19 | - dependency-name: twig/twig 20 | versions: 21 | - ">= 3.a, < 4" 22 | - package-ecosystem: github-actions 23 | directory: "/" 24 | schedule: 25 | interval: weekly 26 | open-pull-requests-limit: 10 27 | -------------------------------------------------------------------------------- /data/templates/default/css/template.css.twig: -------------------------------------------------------------------------------- 1 | {% set breakpoints = {'sm': '400px', 'md': '550px', 'lg': '750px', 'xl': '1000px', 'xxl': '1200px', 'menu': '1000px'} %} 2 | 3 | {% include 'components/content.css.twig' %} 4 | {% include 'components/summary.css.twig' %} 5 | {% include 'components/description.css.twig' %} 6 | {% include 'components/element.css.twig' %} 7 | {% include 'components/signature.css.twig' %} 8 | {% include 'components/table-of-contents.css.twig' %} 9 | {% include 'components/element-found-in.css.twig' %} 10 | {% include 'components/class-graph.css.twig' %} 11 | {% include 'components/tag-list.css.twig' %} 12 | {% include 'css/custom.css.twig' %} 13 | -------------------------------------------------------------------------------- /incubator/guides/src/NodeRenderers/NodeRenderer.php: -------------------------------------------------------------------------------- 1 | title = $title; 23 | } 24 | 25 | public function getTitle(): string 26 | { 27 | return $this->title; 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /data/templates/default/css/macros/colours.macro.twig: -------------------------------------------------------------------------------- 1 | {%- macro hue(name = "phpdocumentor-green") -%} 2 | {% set hues = { 3 | 'red': 4, 4 | 'pink': 340, 5 | 'purple': 291, 6 | 'deep-purple': 262, 7 | 'indigo': 231, 8 | 'blue': 207, 9 | 'light-blue': 199, 10 | 'cyan': 187, 11 | 'teal': 174, 12 | 'green': 122, 13 | 'phpdocumentor-green': 96, 14 | 'light-green': 88, 15 | 'lime': 66, 16 | 'yellow': 54, 17 | 'amber': 45, 18 | 'orange': 36, 19 | 'deep-orange': 14, 20 | 'brown': 16 21 | } %} 22 | {{ hues[name] }} 23 | {%- endmacro -%} 24 | -------------------------------------------------------------------------------- /.github/workflows/broken-link-check.yml: -------------------------------------------------------------------------------- 1 | on: 2 | schedule: 3 | - cron: 0 0 1 * * # run monthly 4 | repository_dispatch: # run manually 5 | types: [check-link] 6 | # Allow manually triggering the workflow. 7 | workflow_dispatch: 8 | 9 | name: Broken Link Check 10 | jobs: 11 | check: 12 | name: Broken Link Check 13 | runs-on: ubuntu-latest 14 | if: github.repository == 'phpDocumentor/phpDocumentor' 15 | steps: 16 | - name: Broken Link Check 17 | uses: technote-space/broken-link-checker-action@v2.3 18 | with: 19 | TARGET: 'https://docs.phpdoc.org/3.0/' 20 | RECURSIVE: true 21 | LABELS: 'documentation' 22 | -------------------------------------------------------------------------------- /data/examples/MariosPizzeria/src/Product.php: -------------------------------------------------------------------------------- 1 | 2 |10 | {% for content in item.contents %} 11 | {{ renderNode(content) }} 12 | {% endfor %} 13 | 14 | {% endfor %} 15 | 16 | -------------------------------------------------------------------------------- /incubator/guides/resources/template/guides/uml.html.twig: -------------------------------------------------------------------------------- 1 | {% apply spaceless %} 2 |6 | {{ uml(node.value) }} 7 | {% if node.caption %} 9 | {% endapply %} 10 | -------------------------------------------------------------------------------- /incubator/guides/src/Nodes/UmlNode.php: -------------------------------------------------------------------------------- 1 | caption = $caption; 15 | } 16 | 17 | public function getCaption(): string 18 | { 19 | return $this->caption; 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /phive.xml: -------------------------------------------------------------------------------- 1 | 2 |{{ node.caption }} {% endif %} 8 |3 | 7 | -------------------------------------------------------------------------------- /data/templates/xml/template.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 |4 | 5 | 6 | xml 4 |Jaap van Otterdijk 5 |mike@phpdoc.org 6 |1.0.0 7 |8 | 10 |9 | 11 | 13 | 14 | -------------------------------------------------------------------------------- /incubator/guides/src/Formats/OutputFormat.php: -------------------------------------------------------------------------------- 1 | assertSame('name', $invalidLink->getName()); 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /src/phpDocumentor/Descriptor/Interfaces/TypeInterface.php: -------------------------------------------------------------------------------- 1 | 9 | -------------------------------------------------------------------------------- /src/phpDocumentor/Descriptor/Interfaces/InheritsFromElement.php: -------------------------------------------------------------------------------- 1 | Return values 3 | {{ node.response.type|route('class:short')|join('|')|raw }} 4 | {% if node.response %} 5 | — 6 | {{ include('components/description.html.twig', {'node': node.response}) }} 7 | {% endif %} 8 | {% endif %} 9 | -------------------------------------------------------------------------------- /incubator/guides-restructured-text/src/RestructuredText/Directives/Code.php: -------------------------------------------------------------------------------- 1 | value = $value; 14 | parent::__construct(SpanToken::TYPE_LITERAL, $id, []); 15 | } 16 | 17 | public function getValue(): string 18 | { 19 | return $this->value; 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /data/examples/MariosPizzeria/src/SharedTrait.php: -------------------------------------------------------------------------------- 1 | 4 |true 12 |5 | Cases 6 | 7 |
8 | {% for case in cases %} 9 | {% include 'components/enum-case.html.twig' %} 10 | {% endfor %} 11 | 12 | {% endif %} 13 | -------------------------------------------------------------------------------- /data/templates/default/components/functions.html.twig: -------------------------------------------------------------------------------- 1 | {% if node.functions is not empty %} 2 |3 | 11 | {% endif %} 12 | -------------------------------------------------------------------------------- /data/templates/default/components/header.html.twig: -------------------------------------------------------------------------------- 1 |4 | Functions 5 | 6 |
7 | {% for function in node.functions %} 8 | {% include 'components/function.html.twig' %} 9 | {% endfor %} 10 |2 | {% include 'components/header-title.html.twig' %} 3 | 4 | 7 | {{ include('components/search.html.twig') }} 8 | {% include 'components/topnav.html.twig' %} 9 | 10 | -------------------------------------------------------------------------------- /data/templates/default/js/searchIndex.js.twig: -------------------------------------------------------------------------------- 1 | {% set baseUrl = renderBaseUrlHeader() %} 2 | Search.appendIndex( 3 | [ 4 | {% for element in project.indexes.elements %} 5 | { 6 | "fqsen": "{{ element.fullyQualifiedStructuralElementName|e('js') }}", 7 | "name": "{{ element.name|e('js') }}", 8 | "summary": "{{ element.summary|e('js') }}", 9 | "url": "{{ link(element) }}" 10 | }{% if not loop.last %},{% endif %} 11 | {% endfor %} 12 | ] 13 | ); 14 | -------------------------------------------------------------------------------- /.env: -------------------------------------------------------------------------------- 1 | # This file is a "template" of which env vars need to be defined for your application 2 | # Copy this file to .env file for development, create environment variables when deploying to production 3 | # https://symfony.com/doc/current/best_practices/configuration.html#infrastructure-related-configuration 4 | 5 | ###> symfony/framework-bundle ### 6 | APP_ENV=dev 7 | APP_SECRET=3f48b02b6f8e6ad6e8c07d0b03762d31 8 | #TRUSTED_PROXIES=127.0.0.1,127.0.0.2 9 | #TRUSTED_HOSTS=localhost,example.com 10 | ###< symfony/framework-bundle ### 11 | -------------------------------------------------------------------------------- /incubator/guides-restructured-text/src/RestructuredText/Nodes/ContainerNode.php: -------------------------------------------------------------------------------- 1 | symfony/framework-bundle ### 6 | APP_ENV=dev 7 | APP_SECRET=3f48b02b6f8e6ad6e8c07d0b03762d31 8 | #TRUSTED_PROXIES=127.0.0.1,127.0.0.2 9 | #TRUSTED_HOSTS=localhost,example.com 10 | ###< symfony/framework-bundle ### 11 | -------------------------------------------------------------------------------- /incubator/guides/docs/references.rst: -------------------------------------------------------------------------------- 1 | ########## 2 | References 3 | ########## 4 | 5 | Domain 6 | ====== 7 | 8 | The domain of a reference, specializes the context to search for a specific reference 9 | 10 | .. code::rst 11 | :php:class:`classname` 12 | 13 | Will search the php domain for a class. 14 | 15 | Role 16 | ====== 17 | 18 | Roles are defining the way a litural text should be interpreted. 19 | 20 | .. code::rst 21 | `literal` 22 | 23 | Literal with a role 24 | 25 | .. code::rst 26 | doc:`literal` 27 | 28 | 29 | -------------------------------------------------------------------------------- /data/templates/xml/constant.xml.twig: -------------------------------------------------------------------------------- 1 | {# @var constant phpDocumentor\Descriptor\ConstantDescriptor #} 2 |3 | 9 | -------------------------------------------------------------------------------- /src/phpDocumentor/Configuration/Exception/InvalidConfigPathException.php: -------------------------------------------------------------------------------- 1 | 0 %} 3 |{{ constant.name }} 4 |{{ constant.fullyQualifiedStructuralElementName }} 5 |{{ constant.value }} 6 | {% if inherited_from %}{{ inherited_from }} {% endif %} 7 | {{ include('docblock.xml.twig', {descriptor: constant}) }} 8 |4 | {% for child in namespace.children %} 5 | {{ include('namespace_tree.xml.twig', {namespace: child}) }} 6 | {% endfor %} 7 | 8 | {% else %} 9 |10 | {% endif %} 11 | -------------------------------------------------------------------------------- /incubator/guides-markdown/src/Markdown/ParserInterface.php: -------------------------------------------------------------------------------- 1 | 4 | 5 | Methods 6 | 7 |
8 | {% for method in methods %} 9 | {% include 'components/method.html.twig' %} 10 | {% endfor %} 11 | 12 | {% endif %} 13 | -------------------------------------------------------------------------------- /data/templates/xml/property.xml.twig: -------------------------------------------------------------------------------- 1 | {# @var property phpDocumentor\Descriptor\PropertyDescriptor #} 2 |3 | 9 | -------------------------------------------------------------------------------- /incubator/guides/src/NodeRenderers/NodeRendererFactory.php: -------------------------------------------------------------------------------- 1 | { 3 | const el = document.querySelector('.phpdocumentor-on-this-page__content') 4 | if (!el) { 5 | return; 6 | } 7 | 8 | const observer = new IntersectionObserver( 9 | ([e]) => { 10 | e.target.classList.toggle("-stuck", e.intersectionRatio < 1); 11 | }, 12 | {threshold: [1]} 13 | ); 14 | 15 | observer.observe(el); 16 | }) 17 | })(); 18 | -------------------------------------------------------------------------------- /data/templates/default/components/signature.css.twig: -------------------------------------------------------------------------------- 1 | .phpdocumentor .phpdocumentor-signature { 2 | display: block; 3 | font-size: var(--text-sm); 4 | border: 1px solid #f0f0f0; 5 | } 6 | 7 | .phpdocumentor .phpdocumentor-signature.-deprecated .phpdocumentor-signature__name { 8 | text-decoration: line-through; 9 | } 10 | 11 | @media (min-width: {{ breakpoints['md'] }}) { 12 | .phpdocumentor .phpdocumentor-signature { 13 | margin-left: calc(var(--spacing-xl) * -1); 14 | width: calc(100% + var(--spacing-xl)); 15 | } 16 | } 17 | -------------------------------------------------------------------------------- /incubator/guides/src/NodeRenderers/NodeRendererFactoryAware.php: -------------------------------------------------------------------------------- 1 | 5 |{{ property.name }} 4 |{{ property.fullyQualifiedStructuralElementName }} 5 |{{ property.default }} 6 | {% if inherited_from %}{{ inherited_from }} {% endif %} 7 | {{ include('docblock.xml.twig', {descriptor: property}) }} 8 |6 | Constants 7 | 8 |
9 | {% for constant in constants %} 10 | {% include 'components/constant.html.twig' %} 11 | {% endfor %} 12 | 13 | {% endif %} 14 | -------------------------------------------------------------------------------- /data/templates/responsive-twig/js/prettify/lang-wiki.js: -------------------------------------------------------------------------------- 1 | PR.registerLangHandler(PR.createSimpleLexer([["pln",/^[\d\t a-gi-z\xa0]+/,null,"\t �\xa0abcdefgijklmnopqrstuvwxyz0123456789"],["pun",/^[*=[\]^~]+/,null,"=*~^[]"]],[["lang-wiki.meta",/(?:^^|\r\n?|\n)(#[a-z]+)\b/],["lit",/^[A-Z][a-z][\da-z]+[A-Z][a-z][^\W_]+\b/],["lang-",/^{{{([\S\s]+?)}}}/],["lang-",/^`([^\n\r`]+)`/],["str",/^https?:\/\/[^\s#/?]*(?:\/[^\s#?]*)?(?:\?[^\s#]*)?(?:#\S*)?/i],["pln",/^(?:\r\n|[\S\s])[^\n\r#*=A-[^`h{~]*/]]),["wiki"]); 2 | PR.registerLangHandler(PR.createSimpleLexer([["kwd",/^#[a-z]+/i,null,"#"]],[]),["wiki.meta"]); 3 | -------------------------------------------------------------------------------- /src/phpDocumentor/Transformer/Writer/Graph/Generator.php: -------------------------------------------------------------------------------- 1 | 5 |6 | Properties 7 | 8 |
9 | {% for property in properties %} 10 | {% include 'components/property.html.twig' %} 11 | {% endfor %} 12 | 13 | {% endif %} 14 | -------------------------------------------------------------------------------- /src/phpDocumentor/Descriptor/ValueObjects/Equals.php: -------------------------------------------------------------------------------- 1 | 2 |3 | 19 | -------------------------------------------------------------------------------- /data/templates/responsive-twig/js/prettify/lang-lua.js: -------------------------------------------------------------------------------- 1 | PR.registerLangHandler(PR.createSimpleLexer([["pln",/^[\t\n\r \xa0]+/,null,"\t\n\r �\xa0"],["str",/^(?:"(?:[^"\\]|\\[\S\s])*(?:"|$)|'(?:[^'\\]|\\[\S\s])*(?:'|$))/,null,"\"'"]],[["com",/^--(?:\[(=*)\[[\S\s]*?(?:]\1]|$)|[^\n\r]*)/],["str",/^\[(=*)\[[\S\s]*?(?:]\1]|$)/],["kwd",/^(?:and|break|do|else|elseif|end|false|for|function|if|in|local|nil|not|or|repeat|return|then|true|until|while)\b/,null],["lit",/^[+-]?(?:0x[\da-f]+|(?:\.\d+|\d+(?:\.\d*)?)(?:e[+-]?\d+)?)/i], 2 | ["pln",/^[_a-z]\w*/i],["pun",/^[^\w\t\n\r \xa0][^\w\t\n\r "'+=\xa0-]*/]]),["lua"]); 3 | -------------------------------------------------------------------------------- /incubator/guides-restructured-text/src/RestructuredText/Directives/RoleDirective.php: -------------------------------------------------------------------------------- 1 | Unfortunately, life did not pan out as I had expected. I will have to do with 11 | * > making examples that don't make sense? 12 | * 13 | * Just like this one, though I managed to sneak a blockquote in. 14 | */ 15 | final class Base 16 | { 17 | public function __construct(?Sauce $sauce) 18 | { 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /incubator/guides-restructured-text/src/RestructuredText/Directives/IndexDirective.php: -------------------------------------------------------------------------------- 1 | li { 14 | display: inline-block; 15 | margin: 0; 16 | } 17 | 18 | .phpdocumentor ul.phpdocumentor-breadcrumbs > li + li:before { 19 | color: var(--dark-gray); 20 | content: "\\\A0"; 21 | padding: 0; 22 | } 23 | -------------------------------------------------------------------------------- /src/phpDocumentor/Descriptor/Tag/ReturnDescriptor.php: -------------------------------------------------------------------------------- 1 | fileExtension = $fileExtension; 17 | } 18 | 19 | public function getFileExtension(): string 20 | { 21 | return $this->fileExtension; 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /src/phpDocumentor/Descriptor/Exception/MissingDependencyException.php: -------------------------------------------------------------------------------- 1 | 2 | {{ node.file|route('file:short') }} 3 | : 4 | {{ node.line }} 5 | 6 | {% if node.file.source %} 7 | 8 | {% endif %} 9 | 10 | -------------------------------------------------------------------------------- /incubator/guides/src/Nodes/BlockNode.php: -------------------------------------------------------------------------------- 1 | normalizeLines($lines)); 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /src/phpDocumentor/Descriptor/Tag/ParamDescriptor.php: -------------------------------------------------------------------------------- 1 | ", 22 | "license": "MIT" 23 | } 24 | -------------------------------------------------------------------------------- /incubator/guides-markdown/composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "phpdocumentor/guides-markdown", 3 | "type": "library", 4 | "license": "MIT", 5 | "homepage": "https://www.phpdoc.org", 6 | "autoload": { 7 | "psr-4": { 8 | "phpDocumentor\\Guides\\": "src/" 9 | } 10 | }, 11 | "autoload-dev": { 12 | "psr-4": { 13 | "phpDocumentor\\Guides\\": [ 14 | "tests/unit/" 15 | ] 16 | } 17 | }, 18 | "minimum-stability": "stable", 19 | "require": { 20 | "php": "^7.4.0||^8.0", 21 | "league/commonmark": "^2.1" 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /incubator/guides/resources/template/guides/document.tex.twig: -------------------------------------------------------------------------------- 1 | {% if isMain %} 2 | \documentclass[11pt]{report} 3 | \usepackage[utf8]{inputenc} 4 | \usepackage[T1]{fontenc} 5 | \usepackage[french]{babel} 6 | \usepackage{cite} 7 | \usepackage{amssymb} 8 | \usepackage{amsmath} 9 | \usepackage{mathrsfs} 10 | \usepackage{graphicx} 11 | \usepackage{hyperref} 12 | \usepackage{listings} 13 | {% for node in document.headerNodes %} 14 | {{ renderNode(node) }} 15 | {% endfor %} 16 | \begin{document} 17 | {% endif %} 18 | \label{{ '{' }}{{ document.environment.url}}{{ '}' }} 19 | {{ body|raw }} 20 | {% if isMain %} 21 | \end{document} 22 | {% endif %} 23 | -------------------------------------------------------------------------------- /incubator/guides/resources/template/guides/figure.html.twig: -------------------------------------------------------------------------------- 1 | {% spaceless %} 2 |4 | 7 |Marios 5 |build/api-cache 6 |8 | 10 |build/api 9 |11 | 15 |. 12 |tests/**/* 13 |build/**/* 14 |16 | 17 | 18 |6 | {{ renderNode(node.image) }} 7 | 8 | {% if node.document %} 9 | {% set caption = renderNode(node.document) %} 10 | 11 | {% if caption %} 12 | 16 | {% endspaceless %} 17 | -------------------------------------------------------------------------------- /incubator/json-path/src/AST/Expression.php: -------------------------------------------------------------------------------- 1 | 2 | {{ node.visibility }} 3 | {% if node.final %}final{% endif %} 4 | {{ not node.type ? "mixed" : node.type|route('class:short')|join('|')|raw }} 5 | {{ node.name }} 6 | = {{ node.value | default('""') }} 7 |{{ caption|raw }} 13 | {% endif %} 14 | {% endif %} 15 |3 | 11 | 12 | -------------------------------------------------------------------------------- /src/phpDocumentor/Configuration/Exception/UpgradeFailedException.php: -------------------------------------------------------------------------------- 1 | getValue()); 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /data/templates/default/components/search.html.twig: -------------------------------------------------------------------------------- 1 |4 | 7 |Search results
5 | 6 |8 | 10 |9 |
2 | 10 | 11 | -------------------------------------------------------------------------------- /incubator/guides/src/Nodes/Links/InvalidLink.php: -------------------------------------------------------------------------------- 1 | name = $name; 24 | } 25 | 26 | public function getName(): string 27 | { 28 | return $this->name; 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /data/templates/responsive-twig/css/prettify.css: -------------------------------------------------------------------------------- 1 | .pln{color:#000}@media screen{.str{color:#080}.kwd{color:#008}.com{color:#800}.typ{color:#606}.lit{color:#066}.pun,.opn,.clo{color:#660}.tag{color:#008}.atn{color:#606}.atv{color:#080}.dec,.var{color:#606}.fun{color:red}}@media print,projection{.str{color:#060}.kwd{color:#006;font-weight:bold}.com{color:#600;font-style:italic}.typ{color:#404;font-weight:bold}.lit{color:#044}.pun,.opn,.clo{color:#440}.tag{color:#006;font-weight:bold}.atn{color:#404}.atv{color:#060}}pre.prettyprint{padding:2px;border:1px solid #888}ol.linenums{margin-top:0;margin-bottom:0}li.L0,li.L1,li.L2,li.L3,li.L5,li.L6,li.L7,li.L8{list-style-type:none}li.L1,li.L3,li.L5,li.L7,li.L9{background:#eee} 2 | -------------------------------------------------------------------------------- /incubator/guides/src/Twig/EnvironmentBuilder.php: -------------------------------------------------------------------------------- 1 | environment = $factory(); 17 | } 18 | 19 | public function setContext(RenderContext $context): void 20 | { 21 | $this->environment->addGlobal('env', $context); 22 | } 23 | 24 | public function getTwigEnvironment(): Environment 25 | { 26 | return $this->environment; 27 | } 28 | } 29 | -------------------------------------------------------------------------------- /src/phpDocumentor/Parser/FileSystemFactory.php: -------------------------------------------------------------------------------- 1 | getConfig(), $payload->getBuilder()); 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /src/phpDocumentor/Transformer/Writer/Twig/CommonMarkFactory.php: -------------------------------------------------------------------------------- 1 | $extensions */ 13 | public function createConverter(iterable $extensions): CommonMarkConverter 14 | { 15 | $converter = new CommonMarkConverter([]); 16 | foreach ($extensions as $extension) { 17 | $converter->getEnvironment()->addExtension($extension); 18 | } 19 | 20 | return $converter; 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /src/phpDocumentor/Descriptor/Interfaces/VisibilityInterface.php: -------------------------------------------------------------------------------- 1 | 2 | {{ node.visibility }} 3 | {% if node.static %}static{% endif %} 4 | {{ not node.type ? "mixed" : node.type|route('class:short')|join('|')|raw }} 5 | ${{ node.name }} 6 | {% if node.default is not null %} = {{ node.default is not null ? node.default : '""' }}{% endif %} 7 | 8 | -------------------------------------------------------------------------------- /incubator/guides-restructured-text/src/RestructuredText/Directives/TipDirective.php: -------------------------------------------------------------------------------- 1 | =7.2.5||^8.0", 21 | "doctrine/event-manager": "^1.1", 22 | "doctrine/lexer": "^1.2", 23 | "webmozart/assert": "^1.3" 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /incubator/guides/src/Nodes/SeparatorNode.php: -------------------------------------------------------------------------------- 1 | level = $level; 26 | } 27 | 28 | public function getLevel(): int 29 | { 30 | return $this->level; 31 | } 32 | } 33 | -------------------------------------------------------------------------------- /src/phpDocumentor/Descriptor/Traits/HasVisibility.php: -------------------------------------------------------------------------------- 1 | visibility = $visibility; 23 | } 24 | 25 | public function getVisibility(): string 26 | { 27 | return $this->visibility; 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /incubator/guides-restructured-text/src/RestructuredText/Directives/CautionDirective.php: -------------------------------------------------------------------------------- 1 | getValue()); 25 | self::assertSame('id', $node->getValueString()); 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /data/templates/default/components/menu.html.twig: -------------------------------------------------------------------------------- 1 | {% if depth == 1 %} 2 |3 | {{ entry.title | shortFQSEN }} 4 |
5 | {% endif %} 6 | {% if entry.children.count > 0 %} 7 |
-
8 | {% for child in entry.children %}
9 |
- 10 | {{ child.title | shortFQSEN }} 11 | {{ toc(child, 'components/menu.html.twig', maxDepth, depth) }} 12 | 13 | {% endfor %} 14 |
13 | 
14 |
15 |
23 | {% endblock %}
24 |
--------------------------------------------------------------------------------
/data/templates/default/objects/code.css.twig:
--------------------------------------------------------------------------------
1 | .phpdocumentor pre {
2 | margin-bottom: var(--spacing-md);
3 | }
4 |
5 | .phpdocumentor-code {
6 | font-family: var(--font-monospace);
7 | background: var(--code-background-color);
8 | border: 1px solid var(--code-border-color);
9 | border-radius: var(--border-radius-base-size);
10 | font-size: var(--text-sm);
11 | padding: var(--spacing-sm) var(--spacing-md);
12 | width: 100%;
13 | box-sizing: border-box;
14 | }
15 |
16 | .phpdocumentor-code.-dark {
17 | background: var(--primary-color-darkest);
18 | color: var(--light-gray);
19 | box-shadow: 0 2px 3px var(--dark-gray);
20 | }
21 |
22 | pre > .phpdocumentor-code {
23 | display: block;
24 | white-space: pre;
25 | }
26 |
--------------------------------------------------------------------------------
/src/phpDocumentor/Descriptor/Query/Engine.php:
--------------------------------------------------------------------------------
1 | executor = $executor;
19 | $this->parser = $parser;
20 | }
21 |
22 | /** @return mixed */
23 | public function perform(Descriptor $descriptor, string $query)
24 | {
25 | return $this->executor->evaluate($this->parser->parse($query), $descriptor);
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/incubator/guides/src/Nodes/Metadata/MetaNode.php:
--------------------------------------------------------------------------------
1 | key = $key;
24 |
25 | parent::__construct($value);
26 | }
27 |
28 | public function getKey(): string
29 | {
30 | return $this->key;
31 | }
32 | }
33 |
--------------------------------------------------------------------------------
/config/packages/framework.yaml:
--------------------------------------------------------------------------------
1 | framework:
2 | secret: '%env(APP_SECRET)%'
3 |
4 | # needs to be disabled because we currently use a different translator with the same service name
5 | translator:
6 | enabled: false
7 |
8 | php_errors:
9 | log: true
10 |
11 | cache:
12 | app: cache.adapter.filesystem
13 | system: cache.adapter.filesystem
14 |
15 | pools:
16 | files:
17 | adapter: app.projectcache.provider
18 | descriptors:
19 | adapter: app.projectcache.provider
20 |
21 | services:
22 | app.projectcache.provider:
23 | abstract: true
24 | class: phpDocumentor\Parser\Cache\FilesystemAdapter
25 | arguments:
26 | - 'phpdoc'
27 |
--------------------------------------------------------------------------------
/incubator/guides/tests/unit/Nodes/Metadata/MetaNodeTest.php:
--------------------------------------------------------------------------------
1 | getKey());
25 | self::assertSame('value', $node->getValue());
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/incubator/guides/tests/unit/Nodes/ParagraphNodeTest.php:
--------------------------------------------------------------------------------
1 | getValue());
27 | }
28 | }
29 |
--------------------------------------------------------------------------------
/src/phpDocumentor/Descriptor/Filter/StripIgnoredTags.php:
--------------------------------------------------------------------------------
1 | getFilterable() instanceof TagDescriptor) {
16 | return $payload;
17 | }
18 |
19 | if (in_array($payload->getFilterable()->getName(), $payload->getApiSpecification()->getIgnoredTags())) {
20 | return new FilterPayload(null, $payload->getApiSpecification());
21 | }
22 |
23 | return $payload;
24 | }
25 | }
26 |
--------------------------------------------------------------------------------
/incubator/guides/src/Nodes/SectionEndNode.php:
--------------------------------------------------------------------------------
1 | titleNode = $titleNode;
26 | }
27 |
28 | public function getTitleNode(): TitleNode
29 | {
30 | return $this->titleNode;
31 | }
32 | }
33 |
--------------------------------------------------------------------------------
/incubator/guides/src/Nodes/SectionBeginNode.php:
--------------------------------------------------------------------------------
1 | titleNode = $titleNode;
26 | }
27 |
28 | public function getTitleNode(): TitleNode
29 | {
30 | return $this->titleNode;
31 | }
32 | }
33 |
--------------------------------------------------------------------------------
/src/phpDocumentor/Descriptor/Interfaces/NamespaceInterface.php:
--------------------------------------------------------------------------------
1 |
25 | */
26 | public function getChildren(): Collection;
27 | }
28 |
--------------------------------------------------------------------------------
/src/phpDocumentor/Descriptor/ProjectDescriptor/WithCustomSettings.php:
--------------------------------------------------------------------------------
1 |
25 | */
26 | public function getDefaultSettings(): array;
27 | }
28 |
--------------------------------------------------------------------------------
/data/templates/responsive-twig/js/prettify/lang-lisp.js:
--------------------------------------------------------------------------------
1 | var a=null;
2 | PR.registerLangHandler(PR.createSimpleLexer([["opn",/^\(+/,a,"("],["clo",/^\)+/,a,")"],["com",/^;[^\n\r]*/,a,";"],["pln",/^[\t\n\r \xa0]+/,a,"\t\n\r \xa0"],["str",/^"(?:[^"\\]|\\[\S\s])*(?:"|$)/,a,'"']],[["kwd",/^(?:block|c[ad]+r|catch|con[ds]|def(?:ine|un)|do|eq|eql|equal|equalp|eval-when|flet|format|go|if|labels|lambda|let|load-time-value|locally|macrolet|multiple-value-call|nil|progn|progv|quote|require|return-from|setq|symbol-macrolet|t|tagbody|the|throw|unwind)\b/,a],
3 | ["lit",/^[+-]?(?:[#0]x[\da-f]+|\d+\/\d+|(?:\.\d+|\d+(?:\.\d*)?)(?:[de][+-]?\d+)?)/i],["lit",/^'(?:-*(?:\w|\\[!-~])(?:[\w-]*|\\[!-~])[!=?]?)?/],["pln",/^-*(?:[_a-z]|\\[!-~])(?:[\w-]*|\\[!-~])[!=?]?/i],["pun",/^[^\w\t\n\r "'-);\\\xa0]+/]]),["cl","el","lisp","scm"]);
4 |
--------------------------------------------------------------------------------
/incubator/guides-restructured-text/src/RestructuredText/Parser/DirectiveOption.php:
--------------------------------------------------------------------------------
1 | name = $name;
21 | $this->value = $value;
22 | }
23 |
24 | public function getName(): string
25 | {
26 | return $this->name;
27 | }
28 |
29 | /**
30 | * @return mixed
31 | */
32 | public function getValue()
33 | {
34 | return $this->value;
35 | }
36 | }
37 |
--------------------------------------------------------------------------------
/incubator/guides/src/NodeRenderers/LazyNodeRendererFactory.php:
--------------------------------------------------------------------------------
1 | factory = $factory;
19 | }
20 |
21 | public function get(Node $node): NodeRenderer
22 | {
23 | if ($this->innerFactory === null) {
24 | $this->innerFactory = ($this->factory)();
25 | }
26 |
27 | return $this->innerFactory->get($node);
28 | }
29 | }
30 |
--------------------------------------------------------------------------------
/data/templates/default/index.html.twig:
--------------------------------------------------------------------------------
1 | {% extends 'base.html.twig' %}
2 |
3 | {% block content %}
4 |
14 | Documentation
6 | 7 | {% set node = project.namespace %} 8 | 9 | {{ 10 | include( 11 | 'components/table-of-contents.html.twig', 12 | { 13 | 'node': project.namespace, 14 | 'namespaces': usesNamespaces or not usesPackages ? node.children : [], 15 | 'packages': usesPackages ? project.package.children : [] 16 | } 17 | ) 18 | }} 19 | {{ include('components/constants.html.twig', {'node': project.namespace}) }} 20 | {{ include('components/functions.html.twig', {'node': project.namespace}) }} 21 |Files
8 | {% for letter in range('a', 'z') %} 9 | {% set filesStartingWith = orderedFiles|filter(v => v.name|first|lower == letter) %} 10 | {% if filesStartingWith is not empty %} 11 |{{ letter|upper }}
12 |-
13 | {% for file in filesStartingWith %}
14 |
- {{ file|route('file:short') }} 15 | {% endfor %} 16 |
2 | {{ node.name }}
3 | {% if node.parent is not empty %}
4 |
5 | extends
6 | {% for interface in node.parent %}
7 | {{ interface|route('class:short') }}{% if not loop.last %}, {% endif %}
8 | {% endfor %}
9 |
10 | {% endif %}
11 | {% if usesPackages %}
12 |
13 | in
14 |
19 |
20 | {% endif %}
21 |
22 |
--------------------------------------------------------------------------------
/src/phpDocumentor/Descriptor/Filter/FilterPayload.php:
--------------------------------------------------------------------------------
1 | filterable = $filterable;
20 | $this->apiSpecification = $apiSpecification;
21 | }
22 |
23 | public function getFilterable(): ?Filterable
24 | {
25 | return $this->filterable;
26 | }
27 |
28 | public function getApiSpecification(): ApiSpecification
29 | {
30 | return $this->apiSpecification;
31 | }
32 | }
33 |
--------------------------------------------------------------------------------
/incubator/guides-markdown/src/Markdown/Parsers/ThematicBreak.php:
--------------------------------------------------------------------------------
1 | isEntering() && $event->getNode() instanceof CommonMark;
24 | }
25 | }
26 |
--------------------------------------------------------------------------------
/incubator/guides/src/Nodes/DefinitionLists/DefinitionList.php:
--------------------------------------------------------------------------------
1 | terms = $terms;
27 | }
28 |
29 | /**
30 | * @return DefinitionListTerm[]
31 | */
32 | public function getTerms(): array
33 | {
34 | return $this->terms;
35 | }
36 | }
37 |
--------------------------------------------------------------------------------
/src/phpDocumentor/Descriptor/Builder/Reflector/Tags/GenericTagAssembler.php:
--------------------------------------------------------------------------------
1 |
21 | */
22 | class GenericTagAssembler extends BaseTagAssembler
23 | {
24 | /**
25 | * @param Tag $data
26 | */
27 | protected function buildDescriptor(object $data): TagDescriptor
28 | {
29 | return new TagDescriptor($data->getName());
30 | }
31 | }
32 |
--------------------------------------------------------------------------------
/src/phpDocumentor/Descriptor/Traits/CanBeFinal.php:
--------------------------------------------------------------------------------
1 | final = $final;
27 | }
28 |
29 | public function isFinal(): bool
30 | {
31 | return $this->final;
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/src/phpDocumentor/Descriptor/Traits/CanBeAbstract.php:
--------------------------------------------------------------------------------
1 | abstract = $abstract;
27 | }
28 |
29 | public function isAbstract(): bool
30 | {
31 | return $this->abstract;
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/data/templates/responsive-twig/js/prettify/lang-css.js:
--------------------------------------------------------------------------------
1 | PR.registerLangHandler(PR.createSimpleLexer([["pln",/^[\t\n\f\r ]+/,null," \t\r\n "]],[["str",/^"(?:[^\n\f\r"\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*"/,null],["str",/^'(?:[^\n\f\r'\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*'/,null],["lang-css-str",/^url\(([^"')]*)\)/i],["kwd",/^(?:url|rgb|!important|@import|@page|@media|@charset|inherit)(?=[^\w-]|$)/i,null],["lang-css-kw",/^(-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*)\s*:/i],["com",/^\/\*[^*]*\*+(?:[^*/][^*]*\*+)*\//],["com",
2 | /^(?:<\!--|--\>)/],["lit",/^(?:\d+|\d*\.\d+)(?:%|[a-z]+)?/i],["lit",/^#[\da-f]{3,6}/i],["pln",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i],["pun",/^[^\s\w"']+/]]),["css"]);PR.registerLangHandler(PR.createSimpleLexer([],[["kwd",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i]]),["css-kw"]);PR.registerLangHandler(PR.createSimpleLexer([],[["str",/^[^"')]+/]]),["css-str"]);
3 |
--------------------------------------------------------------------------------
/data/templates/default/components/constant.html.twig:
--------------------------------------------------------------------------------
1 | 3 | {{ constant.name }} 4 | 5 |
6 | 7 | {{ include('components/element-found-in.html.twig', {'node': constant}) }} 8 | {{ include('components/summary.html.twig', {'node': constant}) }} 9 | {{ include('components/constant-signature.html.twig', {'node': constant}) }} 10 | 11 | {{ include('components/description.html.twig', {'node': constant}) }} 12 | {{ include('components/description.html.twig', {'node': constant.var[0]}) }} 13 | {{ include ('components/tags.html.twig', {'node': constant}) }} 14 |
6 |
10 |
11 |
12 |
13 |
25 | {% endblock %}
26 |
--------------------------------------------------------------------------------
/src/phpDocumentor/Descriptor/Builder/Reflector/Tags/BaseTagAssembler.php:
--------------------------------------------------------------------------------
1 |
17 | */
18 | abstract class BaseTagAssembler extends AssemblerAbstract
19 | {
20 | public function __construct(AssemblerReducer ...$reducers)
21 | {
22 | $reducers[] = new DescriptionAssemblerReducer();
23 | parent::__construct(...$reducers);
24 | }
25 | }
26 |
--------------------------------------------------------------------------------
/incubator/guides/src/Nodes/Links/Link.php:
--------------------------------------------------------------------------------
1 | name = $name;
24 | $this->url = $url;
25 | $this->type = $type;
26 | }
27 |
28 | public function getName(): string
29 | {
30 | return $this->name;
31 | }
32 |
33 | public function getUrl(): string
34 | {
35 | return $this->url;
36 | }
37 |
38 | public function getType(): string
39 | {
40 | return $this->type;
41 | }
42 | }
43 |
--------------------------------------------------------------------------------
/incubator/json-path/src/AST/Value.php:
--------------------------------------------------------------------------------
1 | value = $value;
27 | }
28 |
29 | /**
30 | * @param mixed $currentObject
31 | * @param mixed $root
32 | *
33 | * @return mixed
34 | */
35 | public function visit(Executor $param, $currentObject, $root)
36 | {
37 | return $this->value;
38 | }
39 | }
40 |
--------------------------------------------------------------------------------
/src/phpDocumentor/Descriptor/Filter/Filterable.php:
--------------------------------------------------------------------------------
1 | $errors
29 | */
30 | public function setErrors(Collection $errors): void;
31 | }
32 |
--------------------------------------------------------------------------------
/src/phpDocumentor/Parser/FileCollector.php:
--------------------------------------------------------------------------------
1 | $paths
25 | * @param array
7 |
8 |
9 |