php2cpg
API
Generated with
php2cpg/io.joern.php2cpg/io.joern.php2cpg.passes/SymbolSummaryPass

SymbolSummaryPass

io.joern.php2cpg.passes.SymbolSummaryPass
See theSymbolSummaryPass companion object
class SymbolSummaryPass(config: Config, cpg: Cpg, parser: PhpParser, captureSummary: Map[String, Seq[SymbolSummary]] => Unit) extends ForkJoinParallelCpgPass[BatchOfPhpScripts], AstParsingPass

Gathers all the symbols from namespaces, types, and methods one can import from each PHP script and namespace. Class constants cannot be imported directly, thus we do not handle them.

Value parameters

captureSummary

when the pass has finished summarizing all files, this method captures the result. This is thread safe.

Attributes

Companion
object
Graph
Supertypes
class ForkJoinParallelCpgPass[BatchOfPhpScripts]
trait CpgPassBase
class Object
trait Matchable
class Any
Show all

Members list

Type members

Inherited types

type DiffGraphBuilder = DiffGraphBuilder

Attributes

Inherited from:
ForkJoinParallelCpgPass

Value members

Concrete methods

override def finish(): Unit

Attributes

Definition Classes
ForkJoinParallelCpgPass
override def processPart(builder: DiffGraphBuilder, fileName: String, result: PhpFile): Unit

Attributes

Definition Classes

Inherited methods

protected def baseLogger: Logger

Attributes

Inherited from:
CpgPassBase
override def createAndApply(): Unit

Attributes

Definition Classes
ForkJoinParallelCpgPass -> CpgPassBase
Inherited from:
ForkJoinParallelCpgPass
protected def generateOutFileName(prefix: String, outName: String, index: Int): String

Attributes

Inherited from:
CpgPassBase
override def generateParts(): Array[BatchOfPhpScripts]

Attributes

Definition Classes
Inherited from:
AstParsingPass
def init(): Unit

Attributes

Inherited from:
ForkJoinParallelCpgPass
def isParallel: Boolean

Attributes

Inherited from:
ForkJoinParallelCpgPass
def name: String

Name of the pass. By default it is inferred from the name of the class, override if needed.

Name of the pass. By default it is inferred from the name of the class, override if needed.

Attributes

Inherited from:
CpgPassBase
override def runOnPart(builder: DiffGraphBuilder, part: BatchOfPhpScripts): Unit

Attributes

Definition Classes
Inherited from:
AstParsingPass
override def runWithBuilder(externalBuilder: DiffGraphBuilder): Int

Runs the cpg pass, adding changes to the passed builder. Use with caution -- API is unstable. Returns max(nParts, 1), where nParts is either the number of parallel parts, or the number of iterarator elements in case of legacy passes. Includes init() and finish() logic.

Runs the cpg pass, adding changes to the passed builder. Use with caution -- API is unstable. Returns max(nParts, 1), where nParts is either the number of parallel parts, or the number of iterarator elements in case of legacy passes. Includes init() and finish() logic.

Attributes

Definition Classes
ForkJoinParallelCpgPass -> CpgPassBase
Inherited from:
ForkJoinParallelCpgPass
def runWithBuilderLogged(builder: DiffGraphBuilder): Int

Wraps runWithBuilder with logging, and swallows raised exceptions. Use with caution -- API is unstable. A return value of -1 indicates failure, otherwise the return value of runWithBuilder is passed through.

Wraps runWithBuilder with logging, and swallows raised exceptions. Use with caution -- API is unstable. A return value of -1 indicates failure, otherwise the return value of runWithBuilder is passed through.

Attributes

Inherited from:
CpgPassBase
protected def withStartEndTimesLogged[A](fun: => A): A

Attributes

Inherited from:
CpgPassBase

Deprecated and Inherited methods

override def createApplySerializeAndStore(serializedCpg: SerializedCpg, prefix: String): Unit

Attributes

Deprecated
true
Definition Classes
ForkJoinParallelCpgPass -> CpgPassBase
Inherited from:
ForkJoinParallelCpgPass
protected def store(overlay: GeneratedMessageV3, name: String, serializedCpg: SerializedCpg): Unit

Attributes

Deprecated
true
Inherited from:
CpgPassBase

Inherited fields

protected val logger: Logger

Attributes

Inherited from:
AstParsingPass
Generated with