PHP Command_API Examples

Example #1

File: class_summary_element.php Project: Debenson/openwan

    // echo $this->renderSubclasses($class);
    ?>
</td>
  </tr>
  <?php 
}
?>

  <?php 
if (!empty($class->version)) {
    ?>
  <tr>
    <th nowrap="nowrap">版本</th>
    <td><?php 
    echo $class->version;
    ?>
</td>
  </tr>
  <?php 
}
?>

</table>

<div class="formatted">
  <?php 
echo Command_API::formatting($class->description);
?>
</div>

Example #2

File: property_summary_element.php Project: Debenson/openwan

    ?>
</td>
      <td><?php 
    echo $property->type_hint;
    ?>
</td>
      <td><?php 
    echo h($property->summary);
    ?>
</td>
      <td>
        <?php 
    if ($property->is_inherited) {
        ?>
        <a href="<?php 
        echo Command_API::classUrl($property->declaring_class, $class_url);
        ?>
"><?php 
        echo h($property->declaring_class->name);
        ?>
</a>
        <?php 
    } else {
        ?>
        <?php 
        echo h($property->declaring_class->name);
        ?>
        <?php 
    }
    ?>

Example #3

File: index.php Project: Debenson/openwan

            echo count($package->classes);
            ?>
" valign="top" class="formatted package-description">
          <?php 
            echo Command_API::formatting($package->description);
            ?>
        </td>

        <?php 
        }
        ?>

        <td valign="top">
          <p class="class-name">
            <a href="<?php 
        echo Command_API::classUrl($class, $class_url);
        ?>
"><?php 
        echo h($class->name);
        ?>
</a>
          </p>
          <p class="class-summary">
            <?php 
        echo h($class->summary);
        ?>
          </p>
        </td>
      </tr>
      <?php 
    }

Example #4

File: classes_view.php Project: Debenson/openwan

    echo h($package);
    ?>
</h3>

<ul>
  <?php 
    foreach ($package->classes as $class) {
        ?>
  <li>
    <a href="<?php 
        echo Command_API::classUrl($class, $class_url);
        ?>
" title="<?php 
        echo h($class->name);
        ?>
"><?php 
        echo Command_API::className($class->name, 30);
        ?>
</a>
  </li>
  <?php 
    }
    ?>

</ul>

<?php 
}
?>

Example #5

File: method_summary_element.php Project: Debenson/openwan

"><?php 
    echo h($method->name . '()');
    ?>
</a>
      </td>

      <td><?php 
    echo h($method->summary);
    ?>
</td>
      <td>
        <?php 
    if ($method->is_inherited) {
        ?>
        <a href="<?php 
        echo Command_API::classUrl($method->declaring_class, $class_url);
        ?>
"><?php 
        echo h($method->declaring_class->name);
        ?>
</a>
        <?php 
    } else {
        ?>
        <?php 
        echo h($method->declaring_class->name);
        ?>
        <?php 
    }
    ?>

Example #6

File: method_details_element.php Project: Debenson/openwan

        echo '{return}';
        ?>
</td>
      <td class="param_type"><?php 
        echo h($method->return_type);
        ?>
</td>
      <td class="param_desc"><?php 
        echo h($method->return_comment);
        ?>
</td>
    </tr>
    <?php 
    }
    ?>

  </table>

  <div class="formatted">
    <?php 
    echo Command_API::formatting($method->description);
    ?>
  </div>

  <?php 
}
?>

</div>

Example #7

File: property_details_element.php Project: Debenson/openwan

    echo h($property->name);
    ?>
"></a>

  <div class="name property">
    $<?php 
    echo h($property->name);
    ?>

    <span class="tags">属性</span>
  </div>

  <div class="signature">
    <?php 
    // echo $this->renderPropertySignature($property);
    ?>
  </div>

  <div class="formatted">
    <?php 
    echo Command_API::formatting($property->description);
    ?>
  </div>

  <?php 
}
?>

</div>

Example #8

File: gen_apidoc.php Project: Debenson/openwan

<?php

/**
 * 创建 API 文档
 */
require dirname(__FILE__) . '/../library/q.php';
Q::import(dirname(__FILE__));
Q::import(dirname(__FILE__) . '/command');
Q::import(dirname(__FILE__) . '/command/api');
Q::changeIni('vendor_dir', dirname(__FILE__) . DS . '_vendor');
$source_dir = Q_DIR;
$docs_dir = dirname(__FILE__) . '/source/api';
$output_dir = dirname(__FILE__) . '/output/api';
$excludes = array('_config', '_resources', '_vendor');
if (isset($argv[1])) {
    $output_dir = $argv[1];
}
if (isset($argv[2])) {
    $mode = strtolower(trim($argv[2]));
} else {
    $mode = 'online';
}
Command_API::create()->sourceDir($source_dir)->docsDir($docs_dir)->outputDir($output_dir)->excludes($excludes)->docmode($mode)->execute();