olcaytaner/xmlparser

Simple Xml Parser

1.0.1 2025-01-01 10:31 UTC

Requires (Dev)

• phpunit/phpunit: 11.4.0

GPL-3.0-or-later

• y

README

You can also see C++, C, Js, or Java repository.

Requirements

• Php 8.0 or higher
• Git

Php

To check if you have a compatible version of Php installed, use the following command:

php -V

You can find the latest version of Php here.

Git

Install the latest version of Git.

Download Code

In order to work on code, create a fork from GitHub page. Use Git for cloning the code to your local or below line for Ubuntu:

git clone <your-fork-git-link>

A directory called XmlParser will be created. Or you can use below link for exploring the code:

git clone https://github.com/starlangsoftware/XmlParser-Php.git

Open project with PhpStorm IDE

Steps for opening the cloned project:

• Start IDE
• Select File | Open from main menu
• Choose XmlParser-Php file
• Select open as project option
• Couple of seconds, dependencies will be downloaded.

Detailed Description

In order to load an xml document, we use the constructor

$doc = new XmlDocument($fileName)

and parse with the parse method

$doc->parse()

Root node of the document can be obtained via the getFirstChild method:

$rootNode = $doc->getFirstChild()

For example, to iterate over the first level tags in the xml file one can use

$rootNode = $doc->getFirstChild()
$childNode = $rootNode->getFirstChild()
while ($childNode){
  ...
  $childNode = $childNode->getNextSibling()
}

Tag name can be obtained via getName, pcData via getPcData methods.

For Contibutors

composer.json file

1. autoload is important when this package will be imported.

  "autoload": {
    "psr-4": {
      "olcaytaner\\WordNet\\": "src/"
    }
  },

1. Dependencies should be maximum (not only direct but also indirect references should also be given), everything directly in the code should be given here.

  "require-dev": {
    "phpunit/phpunit": "11.4.0",
    "olcaytaner/dictionary": "1.0.0",
    "olcaytaner/xmlparser": "1.0.1",
    "olcaytaner/morphologicalanalysis": "1.0.0"
  }

Data files

1. Add data files to the project folder. Subprojects should include all data files of the parent projects.

Php files

1. Do not forget to comment each function.

    /**
     * Returns true if specified semantic relation type presents in the relations list.
     *
     * @param SemanticRelationType $relationType element whose presence in the list is to be tested
     * @return bool true if specified semantic relation type presents in the relations list
     */
    public function containsRelationType(SemanticRelationType $relationType): bool{
        foreach ($this->relations as $relation){
            if ($relation instanceof SematicRelation && $relation->getRelationType() == $relationType){
                return true;
            }
        }
        return false;
    }

1. Function names should follow caml case.

    public function getRelation(int $index): Relation{

1. Write getter and setter methods.

    public function getOrigin(): ?string
    public function setName(string $name): void

1. Use standard javascript test style by extending the TestCase class. Use setup when necessary.

class WordNetTest extends TestCase
{
    private WordNet $turkish;

    protected function setUp(): void
    {
        ini_set('memory_limit', '450M');
        $this->turkish = new WordNet();
    }

    public function testSize()
    {
        $this->assertEquals(78327, $this->turkish->size());
    }

1. Enumerated types should be declared with enum.

enum CategoryType
{
    case MATHEMATICS;
    case SPORT;
    case MUSIC;
    case SLANG;
    case BOTANIC;

1. If there are multiple constructors for a class, define them as constructor1, constructor2, ..., then from the original constructor call these methods.

    public function constructor1(string $path, string $fileName): void
    public function constructor2(string $path, string $extension, int $index): void
    public function __construct(string $path, string $extension, ?int $index = null)

1. Use __toString method if necessary to create strings from objects.

    public function __toString(): string

1. Use xmlparser package for parsing xml files.

  $doc = new XmlDocument("../test.xml");
  $doc->parse();
  $root = $doc->getFirstChild();
  $firstChild = $root->getFirstChild();