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

Breadcrumb

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

class ClassLike

Hierarchy

  • class \PhpParser\Node\Stmt\ClassLike extends \Node\Stmt

Expanded class hierarchy of ClassLike

File

vendor/nikic/php-parser/lib/PhpParser/Node/Stmt/ClassLike.php, line 8

Namespace

PhpParser\Node\Stmt
View source
abstract class ClassLike extends Node\Stmt {
    
    /** @var Node\Identifier|null Name */
    public ?Node\Identifier $name;
    
    /** @var Node\Stmt[] Statements */
    public array $stmts;
    
    /** @var Node\AttributeGroup[] PHP attribute groups */
    public array $attrGroups;
    
    /** @var Node\Name|null Namespaced name (if using NameResolver) */
    public ?Node\Name $namespacedName;
    
    /**
     * @return TraitUse[]
     */
    public function getTraitUses() : array {
        $traitUses = [];
        foreach ($this->stmts as $stmt) {
            if ($stmt instanceof TraitUse) {
                $traitUses[] = $stmt;
            }
        }
        return $traitUses;
    }
    
    /**
     * @return ClassConst[]
     */
    public function getConstants() : array {
        $constants = [];
        foreach ($this->stmts as $stmt) {
            if ($stmt instanceof ClassConst) {
                $constants[] = $stmt;
            }
        }
        return $constants;
    }
    
    /**
     * @return Property[]
     */
    public function getProperties() : array {
        $properties = [];
        foreach ($this->stmts as $stmt) {
            if ($stmt instanceof Property) {
                $properties[] = $stmt;
            }
        }
        return $properties;
    }
    
    /**
     * Gets property with the given name defined directly in this class/interface/trait.
     *
     * @param string $name Name of the property
     *
     * @return Property|null Property node or null if the property does not exist
     */
    public function getProperty(string $name) : ?Property {
        foreach ($this->stmts as $stmt) {
            if ($stmt instanceof Property) {
                foreach ($stmt->props as $prop) {
                    if ($prop instanceof PropertyItem && $name === $prop->name
                        ->toString()) {
                        return $stmt;
                    }
                }
            }
        }
        return null;
    }
    
    /**
     * Gets all methods defined directly in this class/interface/trait
     *
     * @return ClassMethod[]
     */
    public function getMethods() : array {
        $methods = [];
        foreach ($this->stmts as $stmt) {
            if ($stmt instanceof ClassMethod) {
                $methods[] = $stmt;
            }
        }
        return $methods;
    }
    
    /**
     * Gets method with the given name defined directly in this class/interface/trait.
     *
     * @param string $name Name of the method (compared case-insensitively)
     *
     * @return ClassMethod|null Method node or null if the method does not exist
     */
    public function getMethod(string $name) : ?ClassMethod {
        $lowerName = strtolower($name);
        foreach ($this->stmts as $stmt) {
            if ($stmt instanceof ClassMethod && $lowerName === $stmt->name
                ->toLowerString()) {
                return $stmt;
            }
        }
        return null;
    }

}

Members

Title Sort descending Modifiers Object type Summary
ClassLike::$attrGroups public property @var Node\AttributeGroup[] PHP attribute groups
ClassLike::$name public property @var Node\Identifier|null Name
ClassLike::$namespacedName public property @var Node\Name|null Namespaced name (if using NameResolver)
ClassLike::$stmts public property @var Node\Stmt[] Statements
ClassLike::getConstants public function
ClassLike::getMethod public function Gets method with the given name defined directly in this class/interface/trait.
ClassLike::getMethods public function Gets all methods defined directly in this class/interface/trait
ClassLike::getProperties public function
ClassLike::getProperty public function Gets property with the given name defined directly in this class/interface/trait.
ClassLike::getTraitUses public function

API Navigation

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