NetCommons3開発ドキュメント

このWikiはNetCommons3のプラグイン開発、ソースコード修正、拡張をするためのドキュメントです。

NetCommons3の概要

• ページ構造
• ルーム
• グループ
• スペース
• ユーザー（会員）
• 権限

開発環境

• インフラ
  • Vagrant
  • Chef、Cookbook
  • Apache
  • PHP
  • Mysql
• フレームワーク
  • CakePHP2.x
  • AngularJS1.x
  • Bootstrap3.x　　　...デザインテンプレート

上記をふまえてシステム要件にまとめました

開発ツール

依存管理ツール	概要
composer	PHPの依存管理ツール
bower	JavaScript等の依存管理ツール

チェッカ等	概要
PHPUnit	テストコードによるユニットテスト
PHP_CodeSniffer	phpコーディング規約チェッカ
PHPMD	一般的なコーディング作法のチェッカ
PHPCPD	コピペディテクタ
phpDocumentor2	ソースコードからドキュメント生成
Closure Linter	JavaScriptコーディング規約チェッカ

開発ツール	概要
MySQL Workbench	DB参照, ERD参照

外部サービス

外部サービス	概要
Packagist（外部リンク）	composerのメインリポジトリ
TravisCI（外部リンク）	Githubと連動したテスト実行
Coverall（外部リンク）	TravisCIと連動したカバレッジ表示
VersionEye	Githubと連動した古い利用ライブラリのチェック

開発ルール

• 開発ルール
  • Issuesの利用
  • レビュールール
  • DB定義の決め

単体テスト

• 単体テスト

リファレンス

DB設計

• ERD.png
• ERD.mwb
  • ERD.mwbの参照手順
• テーブル一覧

補足説明

• 多言語対応について
• バリデーションについて
• デバッグについて
• ページ制御
• URL：BlockIdが付くとかをまとめる
• DB
  • DBの日時
  • DefaultRolePermission
• 連続Submitの制御
• プラグイン一覧

共通プラグイン

• ブロック処理（Blocksプラグイン）
  • phpdoc
  • blockSetting組み込み
• 日時処理(Utility.NetCommonsTime)
• 画像認証(VisualCaptchaプラグイン)
  • phpdoc
• 認証キー(AuthorizationKeysプラグイン)
  • phpdoc
• カテゴリー(Categoriesプラグイン)
  • phpdoc
• イイネ！ヤダネ！(Likesプラグイン)
  • phpdoc
• 権限判定（NetCommons.PermissionComponent）
• ファイル処理（Filesプラグイン）
  • phpdoc
• メール処理（Mailsプラグイン）
  • phpdoc
  • メール組み込み
  • 自動セットする埋め込みタグ一覧
  • メールのcron設定
  • メール通知タイミング（外部リンク）
• コンテンツコメント（ContentCommentsプラグイン）
  • phpdoc
  • コンテンツコメント組み込み

共通プラグイン詳細

• モデル

  • スーパークラス(NetCommons.NetCommonsAppModel)

• ビヘイビア

  • Blocks.BlockBehavior
  • Workflow.WorkflowCommentBehavior （Wiki）
  • Workflow.WorkflowBehavior （Wiki）
  • Blocks.BlockRolePermissionBehavior
  • Likes.LikeBehavior
  • NetCommons.OriginalKeyBehavior （ソース）

• コントローラー

• コンポーネント

  • Workflow.WorkflowComponent （Wiki）
  • NetCommons.NetCommonsComponent

• ビュー

• ヘルパー

  • Blocks.BlockTabsHelper （Wiki）
  • Blocks.BlockRolePermissionFormHelper
  • Blocks.BlockFormHelper
  • Workflow.WorkflowHelper
  • NetCommons.DisplayNumberHelper
  • NetCommons.BackToHelper
  • NetCommons.ButtonHelper
  • NetCommons.NetCommonsFormHelper （Wiki）
  • NetCommons.NetCommonsHtmlHelper
  • NetCommons.DateHelper 日時フォーマット用

• エレメント

  • pager

• ライブラリ

  • Utility.Current （Wiki）
  • Utility.CurrentFrame
  • Utility.CurrentPage
  • Utility.NetCommonsUrl

Tips

• コーディングTips
• NetCommonsプラグイン開発Tips
• デザインTips
• 既存のプラグインをコピーして新しいプラグインを作成する
• Let's Encrypt対応
• 拡張プラグインのインストール・アンインストール
• NetCommonsで静的ページを追加
• NetCommons3のサーバー環境php7.2対応策
• NetCommons3テーマカスのタマイズ
• googleアナリスティクスのトラッキングコードの配置場所
• fabicon変更方法
• バックアップ・リストア方法
• 内部リンクの方法

CakePHP

• recursiveの正しい理解CakePHP(外部リンク)

GitHub

• GitHubのファイルサイズ制限
• GitHubカンニング・ペーパー - GitやGitHubの隠された機能やよく知られていない機能の一覧(外部リンク)

composerとbower

• composerとbowerのバージョニング
• NetCommos3をcomposerでインストール

TravisCI

• travisテストを早くなる、sudo false対応
• travisテストの設定とそのShell

Vagrant

• windows-updateでvagrant-upエラー
• VagrantとVBoxの関係が切れた
• vagrant up でAuthentication failure. Retrying...
• Vagrantで作成したUbuntu環境の各種バージョン

動画

• ffmpag for Ubuntu 12.04 LTS インストール手順
• ffmpag最新版をほぼ全自動ビルドしてインストール。Ubuntu, CentOS対応(外部リンク)
• （編集長以上が使える）ダウンロードリンクを使用しないカスタマイズ

テーマ

• 修正したテーマの反映方法

用語集

• ボックス
• フレーム
• ブロック

プラグインチュートリアル（優先度低）