Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. ClassConst.php

class ClassConst

Same name in this branch
  1. 11.1.x vendor/nikic/php-parser/lib/PhpParser/Node/Stmt/ClassConst.php \PhpParser\Node\Stmt\ClassConst

Hierarchy

  • class \PhpParser\Builder\ClassConst implements \PhpParser\Builder

Expanded class hierarchy of ClassConst

File

vendor/nikic/php-parser/lib/PhpParser/Builder/ClassConst.php, line 15

Namespace

PhpParser\Builder
View source
class ClassConst implements PhpParser\Builder {
    protected int $flags = 0;
    
    /** @var array<string, mixed> */
    protected array $attributes = [];
    
    /** @var list<Const_> */
    protected array $constants = [];
    
    /** @var list<Node\AttributeGroup> */
    protected array $attributeGroups = [];
    
    /** @var Identifier|Node\Name|Node\ComplexType|null */
    protected ?Node $type = null;
    
    /**
     * Creates a class constant builder
     *
     * @param string|Identifier $name Name
     * @param Node\Expr|bool|null|int|float|string|array|\UnitEnum $value Value
     */
    public function __construct($name, $value) {
        $this->constants = [
            new Const_($name, BuilderHelpers::normalizeValue($value)),
        ];
    }
    
    /**
     * Add another constant to const group
     *
     * @param string|Identifier $name Name
     * @param Node\Expr|bool|null|int|float|string|array|\UnitEnum $value Value
     *
     * @return $this The builder instance (for fluid interface)
     */
    public function addConst($name, $value) {
        $this->constants[] = new Const_($name, BuilderHelpers::normalizeValue($value));
        return $this;
    }
    
    /**
     * Makes the constant public.
     *
     * @return $this The builder instance (for fluid interface)
     */
    public function makePublic() {
        $this->flags = BuilderHelpers::addModifier($this->flags, Modifiers::PUBLIC);
        return $this;
    }
    
    /**
     * Makes the constant protected.
     *
     * @return $this The builder instance (for fluid interface)
     */
    public function makeProtected() {
        $this->flags = BuilderHelpers::addModifier($this->flags, Modifiers::PROTECTED);
        return $this;
    }
    
    /**
     * Makes the constant private.
     *
     * @return $this The builder instance (for fluid interface)
     */
    public function makePrivate() {
        $this->flags = BuilderHelpers::addModifier($this->flags, Modifiers::PRIVATE);
        return $this;
    }
    
    /**
     * Makes the constant final.
     *
     * @return $this The builder instance (for fluid interface)
     */
    public function makeFinal() {
        $this->flags = BuilderHelpers::addModifier($this->flags, Modifiers::FINAL);
        return $this;
    }
    
    /**
     * Sets doc comment for the constant.
     *
     * @param PhpParser\Comment\Doc|string $docComment Doc comment to set
     *
     * @return $this The builder instance (for fluid interface)
     */
    public function setDocComment($docComment) {
        $this->attributes = [
            'comments' => [
                BuilderHelpers::normalizeDocComment($docComment),
            ],
        ];
        return $this;
    }
    
    /**
     * Adds an attribute group.
     *
     * @param Node\Attribute|Node\AttributeGroup $attribute
     *
     * @return $this The builder instance (for fluid interface)
     */
    public function addAttribute($attribute) {
        $this->attributeGroups[] = BuilderHelpers::normalizeAttribute($attribute);
        return $this;
    }
    
    /**
     * Sets the constant type.
     *
     * @param string|Node\Name|Identifier|Node\ComplexType $type
     *
     * @return $this
     */
    public function setType($type) {
        $this->type = BuilderHelpers::normalizeType($type);
        return $this;
    }
    
    /**
     * Returns the built class node.
     *
     * @return Stmt\ClassConst The built constant node
     */
    public function getNode() : PhpParser\Node {
        return new Stmt\ClassConst($this->constants, $this->flags, $this->attributes, $this->attributeGroups, $this->type);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
ClassConst::$attributeGroups protected property @var list&lt;Node\AttributeGroup&gt;
ClassConst::$attributes protected property @var array&lt;string, mixed&gt;
ClassConst::$constants protected property @var list&lt;Const_&gt;
ClassConst::$flags protected property
ClassConst::$type protected property @var Identifier|Node\Name|Node\ComplexType|null
ClassConst::addAttribute public function Adds an attribute group.
ClassConst::addConst public function Add another constant to const group
ClassConst::getNode public function Returns the built class node. Overrides Builder::getNode
ClassConst::makeFinal public function Makes the constant final.
ClassConst::makePrivate public function Makes the constant private.
ClassConst::makeProtected public function Makes the constant protected.
ClassConst::makePublic public function Makes the constant public.
ClassConst::setDocComment public function Sets doc comment for the constant.
ClassConst::setType public function Sets the constant type.
ClassConst::__construct public function Creates a class constant builder

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal