Drupal モジュール開発入門講座第7回プラグイン

by アクイアジャパン Acquia Japan

Slide 1

Slide 1 text

ୈ7ճ ϓϥάΠϯ Drupal Ϟδϡʔϧ ։ൃೖ໳ߨ࠲

Slide 2

Slide 2 text

Drupal Ϟδϡʔϧ։ൃೖ໳ߨ࠲γϦʔζ – DrupalͰ͸ʮϞδϡʔϧʯͱݺ͹ΕΔɺখ͞ͳιϑτ΢ΣΞΛ࣮૷͢Δ͜ͱͰػೳ֦ுΛ ߦ͍·͢ɻຊ΢ΣϏφʔγϦʔζͰ͸ɺDrupalͷϞδϡʔϧ։ൃʹؔ͢Δجૅ஌ࣝΛղઆ ͠·͢ɻ – DrupalͷόοΫΤϯυपΓʹ͍ͭͯମܥతʹֶͼ͍ͨํɺࣗ෼ͰΧελϜϞδϡʔϧΛ࡞ ΕΔΑ͏ʹͳΓ͍ͨํɺΞΫΠΞೝఆσϕϩούʔࢼݧΛ໨ࢦ͢ํʹ͓͢͢ΊͰ͢ɻ – DrupalΛҰ௨Γૢ࡞ͨ͜͠ͱ͕͋ΔํΛର৅ͱ͍ͯ͠·͢ɻ·ͩDrupalΛ৮ͬͨ͜ͱ͕ແ ͍ํ͸ɺॳ৺ऀ޲͚DrupalνϡʔτϦΞϧಈըʢ೔ຊޠʣΛઌʹݟ͓ͯ͘ͱΑΓཧղ͕ਂ ·Γ·͢ɻ

Slide 3

Slide 3 text

ΞδΣϯμ 1. ϓϥάΠϯͱ͸ 2. ϓϥάΠϯλΠϓΛར༻ͯ͠ϓϥάΠϯΛ࡞੒͢Δ 3. Drupal͕ϓϥάΠϯΛݕग़͢Δํ๏ 4. طଘͷϓϥάΠϯλΠϓΛݟ͚ͭΔ 5. ಠࣗͷϓϥάΠϯλΠϓΛ࡞੒͢Δ 6. ࿅श໰୊

Slide 4

Slide 4 text

ϓϥάΠϯͱ͸

Slide 5

Slide 5 text

ϓϥάΠϯͷ֓ཁ – DrupalͷϓϥάΠϯγεςϜͱ͸ɺಛఆͷจ຺Ͱ܁Γฦ͠ൃੜ͢Δ ࣄฑʹରԠ͢ΔͨΊͷɺ࠶ར༻Մೳͳ࢓૊ΈͰ͢ɻ – Ϟδϡʔϧ/αϒγεςϜʹΑͬͯɺػೳͷ਽ܗ͕ఆٛ͞ΕɺଞͷϞ δϡʔϧͰɺಛఆͷಈ࡞Λ࣋ͭϓϥάΠϯΛ࡞੒Ͱ͖·͢ɻ – ࣅͨΑ͏ͳػೳΛ࣋ͭϓϥάΠϯ͸ɺಉ͡ϓϥάΠϯλΠϓʹଐ͠ ·͢ɻ – DrupalͷϓϥάΠϯγεςϜ͸ɺDrupalݻ༗ͷσβΠϯύλʔϯͱݴ ͑·͢ɻ

Slide 6

Slide 6 text

– DrupalͷϒϩοΫ͸ɾɾɾ  – ϒϩοΫϨΠΞ΢τͷը໘Ͱ೚ҙͷϦʔδϣ ϯʹ഑ஔՄೳ – ϖʔδ୯Ґɺϩʔϧ୯ҐͷӾཡ੍ޚ͕Մೳ – ຋༁͕Մೳ  – ͱ͍͏ɺڞ௨ͷΠϯλʔϑΣʔεΛ͍࣋ͬͯΔ – ϓϥάΠϯγεςϜʹΑͬͯɺ֤ϒϩοΫʹڞ௨ͷ ΠϯλʔϑΣʔεΛ࣋ͨͤͭͭɺܾΊΒΕͨൣғ ͰΧελϚΠζͰ͖Δ ϓϥάΠϯͷྫɿϒϩοΫ

Slide 7

Slide 7 text

ϓϥάΠϯγεςϜʹొ৔͢Δ༻ޠ – ϓϥάΠϯɿަ׵Մೳͳখ͞ͳػೳɻΧελϜϞδϡʔϧ಺Ͱ ೚ҙͷϓϥάΠϯλΠϓͷϓϥάΠϯΛ࡞੒Ͱ͖ΔɻϓϥάΠϯ ͸ɺDrupalίʔυͷ೚ҙͷ৔ॴͰݕग़ɺΠϯελϯεԽ͞Ε Δɻ – ϓϥάΠϯλΠϓɿϓϥάΠϯΛάϧʔϐϯάͨ͠΋ͷɻϓϥά ΠϯϚωʔδϟ(ޙड़)ʹΑͬͯϓϥάΠϯλΠϓ͕ఆٛ͞ΕΔɻ

Slide 8

Slide 8 text

ϓϥάΠϯλΠϓ ϓϥάΠϯ Πϯελϯε Block  (ίΞͷBlock  αϒεεςϜͰ ఆٛ) Search form  (ίΞͷSearchϞδϡʔϧͰఆٛ) Search form (narrow) Search form (wide) Language switche r (ίΞͷLanguageϞδϡʔϧͰఆٛ) Language switcher ϓϥάΠϯλΠϓͱϓϥάΠϯ

Slide 9

Slide 9 text

ଞʹ΋৭ʑɺϓϥάΠϯλΠϓͱϓϥάΠϯ ϓϥάΠϯλΠϓ ϓϥάΠϯ FieldFormatte r (ίΞͷFieldαϒγεςϜͰఆٛ) Plain text Trimmed ImageEffec t (ίΞͷImageϞδϡʔϧͰఆٛ) Scale Crop Resize ViewsStyl e (ίΞͷViewsϞδϡʔϧͰఆٛ) Unformatted list HTML list

Slide 10

Slide 10 text

ϓϥάΠϯͱ͸ ·ͱΊ – ϓϥάΠϯγεςϜͱ͸ɺಛఆͷจ຺Ͱ܁Γฦ͠ൃੜ͢Δࣄฑʹ ରԠ͢ΔͨΊͷɺ࠶ར༻Մೳͳ࢓૊ΈͰ͢ɻ – ϓϥάΠϯͱ͸ɺަ׵Մೳͳখ͞ͳػೳͰ͢ɻ – ϓϥάΠϯλΠϓͱ͸ɺϓϥάΠϯΛάϧʔϐϯάͨ͠΋ͷͰ͢ɻ

Slide 11

Slide 11 text

ϓϥάΠϯλΠϓΛར༻ͯ͠ ϓϥάΠϯΛ࡞੒͢Δ

Slide 12

Slide 12 text

ϓϥάΠϯλΠϓΛར༻ͯ͠ϓϥάΠϯΛ࡞੒͢Δํ๏ ϓϥάΠϯλΠϓʹΑͬͯํ๏͸ଟগҟͳΓ·͕͢ɺ͜͜Ͱ͸ AnnotatedClassDiscoveryͷݕग़ํ๏(ޙड़)͕ར༻͞Ε͍ͯΔྫΛ঺հ͠· ͢ɻ  1. ద੾ͳσΟϨΫτϦʹphpϑΝΠϧΛ഑ஔͯ͠ɾɾɾ a. ඞཁͳϝιου͕ఆٛ͞ΕΔΑ͏ʹɺϓϥάΠϯΠϯλʔϑΣʔε Λ࣮૷͠·͢ɻجຊΫϥε͕ఏڙ͞Ε͍ͯΔ৔߹͸ͦΕΛextends ͠·͢ɻ b. ΫϥεϑΝΠϧʹద੾ͳΞϊςʔγϣϯΛهड़͠·͢ɻ c. ඞཁͳϝιουΛهड़͠·͢ɻ

Slide 13

Slide 13 text

ϒϩοΫϓϥάΠϯλΠϓͷϓϥάΠϯΛ࡞੒͢Δྫ $this->t('This is a Block!'),]; } } src/Plugin/Block/MaruchaBlock.php ΞϊςʔγϣϯͰ ϒϩοΫID΍ ؅ཧ༻ϥϕϧΛ ఆٛ͢Δ ࡞੒ͨ͠ϒϩοΫ͸ ؅ཧը໘ͷϒϩοΫϨΠΞ΢τ ϖʔδͰαΠτʹ഑ஔͰ͖ΔΑ ͏ʹͳΔ build() ϝιουͰ ϨϯμϦϯά഑ྻ Λฦ٫͢Δ

Slide 14

Slide 14 text

ԋश ϒϩοΫϓϥάΠϯλΠϓͷϓϥάΠϯΛ࡞੒ͯ͠ΈΑ͏ʂ  1. ϞδϡʔϧͷσΟϨΫτϦ௚Լʹ  src/Plugin/Block/MaruchaBlock.php ϑΝΠϧΛ࡞੒͢Δ 2. BlockBaseΛ֦ு͢Δ 3. ΞϊςʔγϣϯͰϒϩοΫͷϝλσʔλΛఆٛ͢Δ 4. ඞཁͳϝιουΛ࣮૷͢Δ 5. Drupal؅ཧը໘͔Β ϒϩοΫϨΠΞ΢τ ʹҠಈͯ͠ɺ  ೚ҙͷϦʔδϣϯʹ࡞੒ͨ͠ϒϩοΫϓϥάΠϯΛ഑ஔ͢Δ ίʔυ͸ͪ͜Βˠ https://github.com/hmaruyama/my-drupal9-module/compare/vol7

Slide 15

Slide 15 text

Drupal͕ϓϥάΠϯΛݕग़͢Δํ๏

Slide 16

Slide 16 text

ϓϥάΠϯσΟεΧόϦ ϓϥάΠϯσΟεΧόϦ(Plugin Discovery)ͱݺ͹ΕΔɺίʔυϕʔε্Ͱϓ ϥάΠϯΛݕग़͢Δํ๏͕4ͭଘࡏ͠·͢ɻ   ୭͕ɺ͍ͭɺϓϥάΠϯσΟεΧόϦΛؾʹ͢Δඞཁ͕͋Δ͔ʁ – ಠࣗͷϓϥάΠϯλΠϓΛ࡞੒͢Δ৔໘ɿϓϥάΠϯϚωʔδϟΫϥε ͷఆٛͷࡍʹɺ͍ͣΕ͔ͷݕग़ํ๏Λબ୒͢Δඞཁ͕͋Γ·͢ɻ – ϓϥάΠϯΛ࡞੒͢Δ৔໘ɿϓϥάΠϯλΠϓ͕ར༻͢Δݕग़ํ๏ʹ ଇ࣮ͬͯ૷͢Δඞཁ͕͋Γ·͢ɻ

Slide 17

Slide 17 text

ϓϥάΠϯσΟεΧόϦ 4ͭͷҟͳΔํ๏ – AnnotatedClassDiscoveryɿdocblockͰϝλσʔλΛಡΈࠐΉํ๏Ͱ͢ɻϓϥάΠϯΛ࡞ ੒͢Δଆ͸ɺܾΊΒΕͨσΟϨΫτϦߏ੒ͰϓϥάΠϯΫϥεΛ഑ஔͯ͠ɺΞϊςʔ γϣϯͰϝλσʔλΛఆٛ͠·͢ɻ΄ͱΜͲͷϓϥάΠϯλΠϓ͕͜ͷݕग़ํ๏Λར༻ ͍ͯ͠·͢ɻ – YamlDiscoveryɿYMLϑΝΠϧͰϝλσʔλΛಡΈࠐΉํ๏Ͱ͢ɻϓϥάΠϯΛ࡞੒͢Δ ଆ͸ɺܾΊΒΕͨϑΝΠϧ໊ͰYMLϑΝΠϧΛ഑ஔͯ͠ɺYMLܗࣜͰϝλσʔλΛఆٛ ͠·͢ɻMenuLink΍BreakpointsͳͲͷҰ෦ͷϓϥάΠϯλΠϓͰར༻͞Ε͍ͯ·͢ɻ – StaticDiscovery – HookDiscovery ΄ͱΜͲར༻͞Ε͍ͯͳ͍ʁ

Slide 18

Slide 18 text

طଘͷϓϥάΠϯλΠϓΛݟ͚ͭΔ

Slide 19

Slide 19 text

ϓϥάΠϯλΠϓ͸Ͳ͔͜Βఏڙ͞ΕΔʁ – ίΞ(αϒγεςϜ/ίΞϞδϡʔϧ ) – ίϯτϦϏϡʔτϞδϡʔϧ – ΧελϜϞδϡʔϧ

Slide 20

Slide 20 text

طଘͷϓϥάΠϯλΠϓΛݟ͚ͭΔํ๏ – ΞϊςʔγϣϯΫϥεΛ୳͢ – *.services.yml͔Β୳͢

Slide 21

Slide 21 text

ΞϊςʔγϣϯΫϥεΛ୳͢ – ݱ࣌఺Ͱ͸΄ͱΜͲͷϓϥάΠϯλΠϓ͕ʮAnnotatedClassDiscoveryʯΛ࢖༻ͯ͠ ϓϥάΠϯΛݕग़͠·͢ɻ – ͔ͭɺݱ࣌఺ͰΞϊςʔγϣϯ͸ϓϥάΠϯγεςϜͰͷΈ࢖༻͞Ε͍ͯ·͢ɻ – ͭ·ΓΞϊςʔγϣϯΫϥεΛ୳͢͜ͱͰɺ΄ͱΜͲͷϓϥάΠϯλΠϓΛݟ͚ͭΔ ͜ͱ͕Ͱ͖·͢ɻ – api.drupal.orgͰ͸ɺAnnotationsϖʔδ͔ΒDrupalίΞʹଘࡏ͢ΔΞϊςʔγϣϯΫ ϥεͷҰཡΛݟΔ͜ͱ͕Ͱ͖·͢ɻ – Drupalιʔείʔυ্͔Β΋ϑΝΠϧݕࡧͰݟ͚ͭΔ͜ͱ͕Ͱ͖·͢ɻ

Slide 22

Slide 22 text

*.services.yml͔Β୳͢ – ϓϥάΠϯλΠϓͷ֤ϓϥάΠϯ͸ɺϓϥάΠϯϚωʔδϟʢαʔϏεʣΛհ͠ ͯݺͼग़͞Ε·͢ɻ – *.services.ymlʹొ࿥͞ΕͨϓϥάΠϯϚωʔδϟͷϚγϯ໊͸ plugin.manager.* ͱ͍͏໊લʹͳ͍ͬͯΔ΋ͷ͕ଟ͍Ͱ͢ɻ※શͯͰ͸ແ͍ – ࣮֬ͳํ๏Ͱ͸ແ͍Ͱ͕͢ɺ*services.ymlϑΝΠϧ಺Λ plugin.manager. Ͱจࣈ ྻݕࡧ͢Δ͜ͱͰҰ෦ͷϓϥάΠϯλΠϓΛݟ͚ͭΔ͜ͱ͕Ͱ͖·͢ɻ

Slide 23

Slide 23 text

ࢀߟ) ViewsϞδϡʔϧͷ৔߹ – ίΞͷViewsϞδϡʔϧ͔Βɺ͍͔ͭ͘ͷ ϓϥάΠϯλΠϓ͕ఏڙ͞Ε͍ͯ·͢ɻ – Viewsͷ৔߹͸ɺDrupal؅ཧը໘ͷϨϙʔ τ > Views ϓϥάΠϯ ͷϖʔδ͔Βɺ ViewsϞδϡʔϧͰఏڙ͞Ε͍ͯΔϓϥά ΠϯλΠϓҰཡΛݟΔ͜ͱ͕Ͱ͖·͢ɻ

Slide 24

Slide 24 text

ಠࣗͷϓϥάΠϯλΠϓΛ࡞੒͢Δ

Slide 25

Slide 25 text

ΧελϜϞδϡʔϧͰಠࣗͷϓϥάΠϯλΠϓΛ ࡞੒͢Δํ๏ AnnotatedClassDiscoveryͷݕग़ํ๏Λ༻͍ͨྫΛ঺հ͠·͢ɻ 1. ϓϥάΠϯϚωʔδϟΫϥεΛ༻ҙ͠·͢ɻ a. Ϋϥε಺ͰϓϥάΠϯͷݕग़ํ๏΋ఆ͍͖ٛͯ͠·͢ɻ b. ࡞੒ͨ͠ΫϥεΛ*.services.ymlʹొ࿥͠·͢ɻ 2. ΞϊςʔγϣϯΫϥεΛ༻ҙ͠·͢ɻ a. ϓϥάΠϯͰར༻͍ͨ͠ϝλσʔλΛఆٛ͠·͢ɻ 3. ΠϯλʔϑΣʔεΛ༻ҙ͠·͢ɻ a. ϓϥάΠϯͰ࣮૷ͯ͠΄͍͠ϝιουΛఆٛ͠·͢ɻ 4. جຊΫϥεΛ༻ҙ͠·͢ɻʢΦϓγϣϯʣ a. ΠϯλʔϑΣʔεΛ࣮૷ͯ͠جຊΫϥεΛ༻ҙͯ͠ɺϝιουͷσϑΥϧτͷॲཧΛهड़ ͠·͢ɻ

Slide 26

Slide 26 text

ϓϥάΠϯϚωʔδϟͱ͸ – ϓϥάΠϯϚωʔδϟ͸ɺ࣍ͷ͜ͱΛߦ͍·͢ɻ – ৽͍͠ϓϥάΠϯλΠϓͷఆٛ – ϓϥάΠϯͷݕग़ํ๏ͷఆٛ – ϓϥάΠϯͷݕग़ͱΠϯελϯεԽ  – ϓϥάΠϯϚωʔδϟ͸αʔϏεͱͯ͠ఆٛ͞Ε·͢ɻ  αʔϏεͷϚγϯ໊ʹɺplugin.manager.* ͷ໋໊نଇ͕Α͘ར ༻͞Ε·͢ɻ

Slide 27

Slide 27 text

ϓϥάΠϯϚωʔδϟΛ࢖༻͢Δ ϓϥάΠϯϚωʔδϟαʔϏεΛݺͼग़ͯ͠ɾɾ    – ར༻ՄೳͳϓϥάΠϯͷҰཡΛऔಘ͢Δ    – ಛఆͷϓϥάΠϯΛऔಘ͢Δ    – ϓϥάΠϯͷߏ੒ࡁΈΠϯελϯεΛ࡞੒͢Δ $type = \Drupal::service('plugin.manager.tapioca'); $plugin_definitions = $type->getDefinitions(); $plugin_definition = $type->getDefinition('tapioca_milk_tea'); $plugin = $type->createInstance('tapioca_milk_tea', ['of' => 'configuration values']);

Slide 28

Slide 28 text

ԋश ಠࣗͷϓϥάΠϯλΠϓΛఆٛͯ͠ɺར༻ͯ͠ΈΑ͏ʂ 1. ϓϥάΠϯλΠϓͷఆٛ 2. ϓϥάΠϯϚωʔδϟΛ࢖༻ͯ͠ɺ࡞੒ͨ͠ϓϥάΠϯλΠϓͷϓϥά ΠϯΛݺͼग़͢ 3. ࡞੒ͨ͠ϓϥάΠϯλΠϓͰϓϥάΠϯΛ࡞੒͢Δ ίʔυ͸ͪ͜Βˠ https://github.com/hmaruyama/my-drupal9-module/compare/vol7

Slide 29

Slide 29 text

࿅श໰୊

Slide 30

Slide 30 text

࿅श໰୊1 DrupalͷʮϓϥάΠϯʯʹ͍ͭͯਖ਼͍͠هड़Λબ୒͍ͯͩ͘͠͞ɻ 1. Drupalͷಈ࡞Λมߋ͢ΔPHPؔ਺ɻ 2. ʮϞδϡʔϧʯͷผ໊ɻ 3. ϓϥάΠϯλΠϓʹάϧʔϐϯά͞ΕΔɺަ׵Մೳͳػೳɻ

Slide 31

Slide 31 text

Slide 32

Slide 32 text

࿅श໰୊2 ϓϥάΠϯσΟεΧόϦʹ͍ͭͯਖ਼͘͠ͳ͍هड़Λબ୒͍ͯͩ͘͠͞ɻ 1. DrupalίΞͰ͸AnnotatedClassDiscoveryͱݺ͹ΕΔݕग़ํ๏ͷΈ ఏڙ͞Ε͍ͯΔɻ 2. ϓϥάΠϯϚωʔδϟͰɺϓϥάΠϯλΠϓ͕࢖༻͢Δݕग़ํ๏Λ ఆٛ͢Δɻ 3. ಠࣗʹݕग़ํ๏Λఆٛ͢Δ͜ͱ͕Ͱ͖Δɻ