Php5ClientGenerator.php in Kaltura 6.2

File

kaltura_client/Php5ClientGenerator.php

<?php

class Php5ClientGenerator extends ClientGeneratorBase {
  public function generate() {
    $this
      ->writeHeader();
    $this
      ->writeBeforeTypes();

    // types
    foreach ($this->_types as $typeReflector) {
      $this
        ->writeType($typeReflector);
    }
    $this
      ->writeAfterTypes();

    // services
    foreach ($this->_services as $serviceReflector) {
      $this
        ->writeBeforeService($serviceReflector);
      $serviceName = $serviceReflector
        ->getServiceName();
      $actions = $serviceReflector
        ->getActions();
      $actions = array_keys($actions);
      foreach ($actions as $action) {
        $actionInfo = $serviceReflector
          ->getActionInfo($action);
        if (strpos($actionInfo->clientgenerator, "ignore") !== false) {
          continue;
        }
        $outputTypeReflector = $serviceReflector
          ->getActionOutputType($action);
        $actionParams = $serviceReflector
          ->getActionParams($action);
        $this
          ->writeServiceAction($serviceName, $action, $actionParams, $outputTypeReflector);
      }
      $this
        ->writeAfterService($serviceReflector);
    }
    $this
      ->writeMainClassDeclaration();
    foreach ($this->_services as $serviceReflector) {
      $this
        ->writeMainClassServiceDeclaration($serviceReflector);
    }
    $this
      ->writeMainClassConstructorDeclaration();
    foreach ($this->_services as $serviceReflector) {
      $this
        ->writeMainClassServiceInitialization($serviceReflector);
    }
    $this
      ->writeMainClassConstructorClosure();
    $this
      ->writeMainClassClosure();
    $this
      ->writeFooter();
  }
  protected function writeHeader() {
    $this
      ->echoLine('<?php');
    $this
      ->echoLine('require_once("KalturaClientBase.php");');
    $this
      ->echoLine('');
  }
  protected function writeFooter() {
  }
  protected function writeBeforeTypes() {
  }
  protected function writeType(KalturaTypeReflector $typeReflector) {
    $type = $typeReflector
      ->getType();
    if ($typeReflector
      ->isEnum()) {
      $contants = $typeReflector
        ->getConstants();
      $this
        ->echoLine("class {$type}");
      $this
        ->echoLine("{");
      foreach ($contants as $contant) {
        $name = $contant
          ->getName();
        $value = $contant
          ->getDefaultValue();
        $this
          ->echoLine("\tconst {$name} = {$value};");
      }
      $this
        ->echoLine("}");
      $this
        ->echoLine();
    }
    else {
      if (!$typeReflector
        ->isArray()) {

        // class definition
        $properties = $typeReflector
          ->getProperties();
        $this
          ->echoLine("class {$type} extends KalturaObjectBase");
        $this
          ->echoLine("{");

        // class properties
        foreach ($properties as $property) {
          $propType = $property
            ->getType();
          $propName = $property
            ->getName();
          $this
            ->echoLine("\t/**");
          $description = str_replace("\n", "\n\t * ", $property
            ->getDescription());

          // to format multiline descriptions
          $this
            ->echoLine("\t * " . $description);
          $this
            ->echoLine("\t *");
          $this
            ->echoLine("\t * @var {$propType}");
          if ($property
            ->isReadOnly()) {
            $this
              ->echoLine("\t * @readonly");
          }
          if ($property
            ->isInsertOnly()) {
            $this
              ->echoLine("\t * @insertonly");
          }
          $this
            ->echoLine("\t */");
          $propertyLine = "public \${$propName}";
          if ($property
            ->isSimpleType() || $property
            ->isEnum()) {
            $propertyLine .= " = null";
          }
          $this
            ->echoLine("\t{$propertyLine};");
          $this
            ->echoLine("");
        }
        $this
          ->echoLine();
        $this
          ->echoLine("\tpublic function toParams()");
        $this
          ->echoLine("\t{");
        $this
          ->echoLine("\t\t\$kparams = array();");
        foreach ($properties as $property) {
          $propType = $property
            ->getType();
          $propName = $property
            ->getName();
          if ($property
            ->isSimpleType() || $property
            ->isEnum()) {
            $this
              ->echoLine("\t\t\$this->addIfNotNull(\$kparams, \"{$propName}\", \$this->{$propName});");
          }
          else {
            continue;

            // ignore sub objects and arrays
          }
        }
        $this
          ->echoLine("\t\treturn \$kparams;");
        $this
          ->echoLine("\t}");

        // close class
        $this
          ->echoLine("}");
        $this
          ->echoLine();
      }
    }
  }
  protected function writeAfterTypes() {
  }
  protected function writeBeforeServices() {
  }
  protected function writeBeforeService(KalturaServiceReflector $serviceReflector) {
    $serviceName = $serviceReflector
      ->getServiceName();
    $serviceClassName = "Kaltura" . $this
      ->upperCaseFirstLetter($serviceName) . "Service";
    $this
      ->echoLine();
    $this
      ->echoLine("class {$serviceClassName} extends KalturaServiceBase");
    $this
      ->echoLine("{");
    $this
      ->echoLine("\tfunction __construct(KalturaClient \$client)");
    $this
      ->echoLine("\t{");
    $this
      ->echoLine("\t\tparent::__construct(\$client);");
    $this
      ->echoLine("\t}");
  }
  protected function writeServiceAction($serviceName, $action, $actionParams, $outputTypeReflector) {
    $outputType = null;
    if ($outputTypeReflector) {
      $outputType = $outputTypeReflector
        ->getType();
    }

    // method signature
    $signature = "";
    if (in_array($action, array(
      "list",
      "clone",
    ))) {

      // because list & clone are preserved in PHP
      $signature .= "function " . $action . "Action(";
    }
    else {
      $signature .= "function " . $action . "(";
    }
    foreach ($actionParams as $actionParam) {
      $paramName = $actionParam
        ->getName();
      if ($actionParam
        ->isSimpleType() || $actionParam
        ->isEnum()) {
        $signature .= "\$" . $paramName;
      }
      else {
        if ($actionParam
          ->isArray()) {
          $signature .= "array \$" . $paramName;
        }
        else {
          if ($actionParam
            ->isComplexType()) {
            $signature .= $actionParam
              ->getType() . " \$" . $paramName;
          }
        }
      }
      if ($actionParam
        ->isOptional()) {
        if ($actionParam
          ->isSimpleType() || $actionParam
          ->isEnum()) {
          $defaultValue = $actionParam
            ->getDefaultValue();
          if ($defaultValue === false) {
            $signature .= " = false";
          }
          else {
            if ($defaultValue === true) {
              $signature .= " = true";
            }
            else {
              if ($defaultValue === null) {
                $signature .= " = null";
              }
              else {
                if (is_string($defaultValue)) {
                  $signature .= " = \"{$defaultValue}\"";
                }
                else {
                  if (is_numeric($defaultValue)) {
                    $signature .= " = {$defaultValue}";
                  }
                }
              }
            }
          }
        }
        else {
          $signature .= " = null";
        }
      }
      $signature .= ", ";
    }
    if ($this
      ->endsWith($signature, ", ")) {
      $signature = substr($signature, 0, strlen($signature) - 2);
    }
    $signature .= ")";
    $this
      ->echoLine();
    $this
      ->echoLine("\t{$signature}");
    $this
      ->echoLine("\t{");
    $this
      ->echoLine("\t\t\$kparams = array();");
    foreach ($actionParams as $actionParam) {
      $paramName = $actionParam
        ->getName();
      if ($actionParam
        ->isComplexType()) {
        if ($actionParam
          ->isEnum()) {
          $this
            ->echoLine("\t\t\$this->client->addParam(\$kparams, \"{$paramName}\", \${$paramName});");
        }
        else {
          if ($actionParam
            ->isArray()) {
            $extraTab = "";
            if ($actionParam
              ->isOptional()) {
              $this
                ->echoLine("\t\tif (\${$paramName} !== null)");
              $extraTab = "\t";
            }
            $this
              ->echoLine("{$extraTab}\t\tforeach({$paramName} as \$obj)");
            $this
              ->echoLine("{$extraTab}\t\t{");
            $this
              ->echoLine("{$extraTab}\t\t\t\$this->client->addParam(\$kparams, \"{$paramName}\", \$obj->toParams());");
            $this
              ->echoLine("{$extraTab}\t\t}");
          }
          else {
            $extraTab = "";
            if ($actionParam
              ->isOptional()) {
              $this
                ->echoLine("\t\tif (\${$paramName} !== null)");
              $extraTab = "\t";
            }
            $this
              ->echoLine("{$extraTab}\t\t\$this->client->addParam(\$kparams, \"{$paramName}\", \${$paramName}" . "->toParams());");
          }
        }
      }
      else {
        $this
          ->echoLine("\t\t\$this->client->addParam(\$kparams, \"{$paramName}\", \${$paramName});");
      }
    }
    $this
      ->echoLine("\t\t\$resultObject = \$this->client->callService(\"{$serviceName}\", \"{$action}\", \$kparams);");
    $this
      ->echoLine("\t\t\$this->client->throwExceptionIfError(\$resultObject);");
    if (!$outputTypeReflector) {
      $outputType = "null";
    }
    if ($outputTypeReflector && $outputTypeReflector
      ->isArray()) {
      $outputType = "array";
    }
    $this
      ->echoLine("\t\t\$this->client->validateObjectType(\$resultObject, \"{$outputType}\");");
    $this
      ->echoLine("\t\treturn \$resultObject;");
    $this
      ->echoLine("\t}");
  }
  protected function writeAfterService(KalturaServiceReflector $serviceReflector) {
    $this
      ->echoLine("}");
  }
  protected function writeAfterServices() {
    $this
      ->echoLine('		}');
    $this
      ->echoLine("\t}");
  }
  private function writeMainClassDeclaration() {
    $this
      ->echoLine("");
    $this
      ->echoLine("class KalturaClient extends KalturaClientBase");
    $this
      ->echoLine("{");
  }
  private function writeMainClassServiceDeclaration(KalturaServiceReflector $serviceReflector) {
    $docComment = $serviceReflector
      ->getServiceInfo();
    $serviceName = $serviceReflector
      ->getServiceName();
    $serviceClassName = "Kaltura" . $this
      ->upperCaseFirstLetter($serviceName) . "Service";
    $this
      ->echoLine("\t/**");
    $description = str_replace("\n", "\n\t * ", $docComment->description);

    // to format multiline descriptions
    $this
      ->echoLine("\t * " . $description);
    $this
      ->echoLine("\t *");
    $this
      ->echoLine("\t * @var {$serviceClassName}");
    $this
      ->echoLine("\t */");
    $this
      ->echoLine("\tpublic \${$serviceName} = null;");
    $this
      ->echoLine("");
  }
  private function writeMainClassConstructorDeclaration() {
    $this
      ->echoLine("");
    $this
      ->echoLine("\tpublic function __construct()");
    $this
      ->echoLine("\t{");
    $this
      ->echoLine("\t\tparent::__construct();");
  }
  private function writeMainClassServiceInitialization(KalturaServiceReflector $serviceReflector) {
    $serviceName = $serviceReflector
      ->getServiceName();
    $serviceClassName = "Kaltura" . $this
      ->upperCaseFirstLetter($serviceName) . "Service";
    $this
      ->echoLine("\t\t\$this->{$serviceName} = new {$serviceClassName}(\$this);");
  }
  private function writeMainClassConstructorClosure() {
    $this
      ->echoLine("\t}");
  }
  private function writeMainClassClosure() {
    $this
      ->echoLine("}");
  }
  private function echoLine($text = "") {
    echo $text . "\n";
  }
  private function upperCaseFirstLetter($text) {
    if (strlen($text) > 0) {
      $text[0] = strtoupper($text[0]);
    }
    return $text;
  }

}

Classes

Name	Description
Php5ClientGenerator